From 9acc0bdb2c0e85d850ffc4f3277c26ed761d3cdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Mon, 6 Nov 2017 20:05:39 -0500 Subject: [PATCH 01/10] Publish of Github pages from Gradle. --- features.html | 20 ++++++++++++++------ feed.xml | 4 ++-- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/features.html b/features.html index 70ec23d..3e1b497 100644 --- a/features.html +++ b/features.html @@ -212,14 +212,22 @@

Product Types

-
// Regular Java
-public Integer albuquerqueToLA(Map> map) {
-  Map m = map.get("Albuquerque");
-  if (m != null) return m.get("Los Angeles"); // May return null.
+
import java.util.Map;
+import static fj.P.*;
+import fj.data.Option;
+import fj.data.TreeMap;
+import fj.P2;
+
+// Regular Java
+public Integer albuquerqueToLA(Map<String, Map<String, Integer>> map) {
+  Map<String, Integer> m = map.get("Albuquerque");
+  if (m != null)
+    return m.get("Los Angeles"); // May return null.
 }
+
 // Functional Java with product and option types.
-public Option albuquerqueToLA(TreeMap, Integer>() map) {
-  return m.get(p("Albuquerque", "Los Angeles"));
+public Option<Integer> albuquerqueToLA(TreeMap<P2<String, String>, Integer> map) {
+  return map.get(p("Albuquerque", "Los Angeles"));
 }
diff --git a/feed.xml b/feed.xml index 6351103..423c30e 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - 27 mars 2017 22:13:44 - 27 mars 2017 22:13:44 + Nov 6, 2017 7:59:52 PM + Nov 6, 2017 7:59:52 PM From 96d2f4dfb5117da9072a8267aa382b80cb69060b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Fri, 20 Jul 2018 17:30:45 -0400 Subject: [PATCH 02/10] Publish of Github pages from Gradle. --- community.html | 156 ++++------ docs.html | 324 ++++++++------------ download.html | 110 +++---- examples-bgga.html | 322 ++++++++++---------- examples-java7.html | 468 ++++++++++++++--------------- examples-java8.html | 408 ++++++++++++------------- features.html | 500 +++++++++++++------------------ feed.xml | 4 +- index.html | 108 ++++--- quickstart.html | 128 ++++---- tags/.html | 184 ++++++++++++ tags/applicative.html | 184 ++++++++++++ tags/functional programming.html | 184 ++++++++++++ tags/functor.html | 184 ++++++++++++ tags/groovy.html | 184 ++++++++++++ tags/higher-order type.html | 184 ++++++++++++ tags/kind.html | 184 ++++++++++++ tags/monad.html | 184 ++++++++++++ tags/typeclass.html | 184 ++++++++++++ 19 files changed, 2780 insertions(+), 1404 deletions(-) create mode 100644 tags/.html create mode 100644 tags/applicative.html create mode 100644 tags/functional programming.html create mode 100644 tags/functor.html create mode 100644 tags/groovy.html create mode 100644 tags/higher-order type.html create mode 100644 tags/kind.html create mode 100644 tags/monad.html create mode 100644 tags/typeclass.html diff --git a/community.html b/community.html index 9e0112c..131fa0b 100644 --- a/community.html +++ b/community.html @@ -64,96 +64,70 @@

Community

-

-

Articles

-
-
-

Neal Ford features FunctionalJava in many of his posts on Functional Thinking

-
-
-
-
-

Videos

-
-
-

What Does Functional Programming Mean? by Tony Morris

-
-
-
-
-

Repositories

-
-
- -
-
-
-
-

Communication

-
-
- -
-
-
-
-

Resources

-
-
- -
-
-
-
-

Obsolete

-
-
- -
-
+

+

Articles

+
+
+

Neal Ford features FunctionalJava in many of his posts on Functional Thinking

+
+
+
+
+

Videos

+
+
+

What Does Functional Programming Mean? by Tony Morris

+
+
+
+
+

Repositories

+
+
+ +
+
+
+
+

Communication

+
+
+ +
+
+
+
+

Resources

+
+
+ +
+
+
+
+

Obsolete

+
+
+ +
+

@@ -166,7 +140,7 @@

Obsolete

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/docs.html b/docs.html index 4eb9242..ae0382e 100644 --- a/docs.html +++ b/docs.html @@ -64,200 +64,134 @@

Documentation

-

-

Learn

-
-
-
    -
  • -

    Quickstart Guide - How to include Functional Java in your project and get started

    -
    • -
  • -

    Features List - Brief overview of Functional Java features

    -
    • -
-
-
-
-
-

Examples

-
-
-

There are numerous examples of using FunctionalJava:

-
-
- -
-
-
-
-

Release Notes

-
-
-

Release notes are available from the download page. Alternately you can use the index of release notes.

-
-
-
-
-

Javadoc

-
-
-

4.7

-
- -
-
-
-

4.6

-
- -
-
-
-

4.5

-
- -
-
-
-

4.4

-
- -
-
-
-

Others

-
- -
-
-
-
-
-

Building

-
-
-

FunctionalJava uses the Retro Lambda project to backport Java 8 lambdas to Java 6 bytecode. This requires access to both JDK 6 and 8. The build system requires the environment variables JAVA6_HOME and JAVA8_HOME to refer to the appropriate directories.

-
-
-

Building is done using Gradle. In the root directory run:

-
-
-
-
./gradlew
-
-
-
-

This will download the Gradle build tool and necessary dependencies and build FunctionalJava.

-
-
-
-
-

License

-
-
-

Functional Java is licensed under the BSD 3 license, available at (3-clause license, https://en.wikipedia.org/wiki/BSD_licenses).

-
-
+

+

Learn

+
+
+
    +

  • Quickstart Guide - How to include Functional Java in your project and get started

    • +

  • Features List - Brief overview of Functional Java features

    • +
+
+
+
+
+

Examples

+
+
+

There are numerous examples of using FunctionalJava:

+
+
+ +
+
+
+
+

Release Notes

+
+
+

Release notes are available from the download page. Alternately you can use the index of release notes.

+
+
+
+
+

Javadoc

+
+
+

4.7

+
+ +
+
+
+

4.6

+
+ +
+
+
+

4.5

+
+ +
+
+
+

4.4

+
+ +
+
+
+

Others

+
+ +
+
+
+
+
+

Building

+
+
+

FunctionalJava uses the Retro Lambda project to backport Java 8 lambdas to Java 6 bytecode. This requires access to both JDK 6 and 8. The build system requires the environment variables JAVA6_HOME and JAVA8_HOME to refer to the appropriate directories.

+
+
+

Building is done using Gradle. In the root directory run:

+
+
+
+ 
./gradlew
+
+
+
+

This will download the Gradle build tool and necessary dependencies and build FunctionalJava.

+
+
+
+
+

License

+
+
+

Functional Java is licensed under the BSD 3 license, available at (3-clause license, https://en.wikipedia.org/wiki/BSD_licenses).

+
+

@@ -270,7 +204,7 @@

License

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/download.html b/download.html index f13b122..89b934a 100644 --- a/download.html +++ b/download.html @@ -64,72 +64,48 @@

Download

-

-

Github Source

-
-
-

The source can be obtained by cloning the Github project git clone https://github.com/functionaljava/functionaljava.git.

-
-
-

Github also provides zips of the source code, so you can download the zip of the master branch.

-
-
-
-
-

Build System

-
-
-

The recommended way to download the project is by including the Functional Java library from your project build tool. See the quickstart guide for how to do this.

-
-
-
-
-

Release Notes

-
-
-

The current stable release of Functional Java is 4.7. Release notes for each release are available below:

-
-
- -
-
+

+

Github Source

+
+
+

The source can be obtained by cloning the Github project git clone https://github.com/functionaljava/functionaljava.git.

+
+
+

Github also provides zips of the source code, so you can download the zip of the master branch.

+
+
+
+
+

Build System

+
+
+

The recommended way to download the project is by including the Functional Java library from your project build tool. See the quickstart guide for how to do this.

+
+
+
+
+

Release Notes

+
+
+

The current stable release of Functional Java is 4.7. Release notes for each release are available below:

+
+
+ +
+

@@ -142,7 +118,7 @@

Release Notes

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/examples-bgga.html b/examples-bgga.html index ece02f4..9d4bad9 100644 --- a/examples-bgga.html +++ b/examples-bgga.html @@ -64,59 +64,41 @@

Java BGGA Examples

-

-
-
-

These examples use the original (now obsolete) BGGA proposed syntax. Corresponding examples are also available in Java 8 and Java 7.

-
-
-

The BGGA closure prototype is required to compile these examples, which can be downloaded from http://javac.info/. Any JVM version 1.5 or higher is required to use the Functional Java library or run the compiled examples.

-
-
-

The example list is:

-
-
- -
-
-
-
-

Array Exists

-
-
-

Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.

-
-
-
-
import fj.data.Array;
+            
 
+ 
 
+  
 
+   
These examples use the original (now obsolete) BGGA proposed syntax. Corresponding examples are also available in Java 8 and Java 7.
 
+  
 
+  
 
+   
The BGGA closure prototype is required to compile these examples, which can be downloaded from http://javac.info/. Any JVM version 1.5 or higher is required to use the Functional Java library or run the compiled examples.
 
+  
 
+  
 
+   
The example list is:
 
+  
 
+  
 
+    
+  
 
+ 
 
+
 
+
 
+ 
Array Exists
 
+ 
 
+  
 
+   
Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
 import static java.lang.Character.isLowerCase;
@@ -127,20 +109,20 @@ 
Array Exists

     final boolean b = a.exists({String s => fromString(s).forall({char c => isLowerCase(c)})});
     System.out.println(b); // true ("what" provides the only example; try removing it)
   }
-}

-

-

-

-

-

-
Array Filter

-

-

-
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Filter
 
+ 
 
+  
 
+   
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.Show.arrayShow;
 import static fj.Show.intShow;
@@ -151,20 +133,20 @@ 
Array Filter

     final Array<Integer> b = a.filter({int i => i % 2 == 0});
     arrayShow(intShow).println(b); // {44,22,90,98,1078,6,64,6,42}
   }
-}

-

-

-

-

-

-
Array Fold Left

-

-

-
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Fold Left
 
+ 
 
+  
 
+   
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 
 public final class Array_foldLeft {
@@ -173,20 +155,20 @@ 
Array Fold Left

     final int b = a.<Integer>foldLeft({int i => {int j => i + j}}, 0);
     System.out.println(b); // 1774
   }
-}

-

-

-

-

-

-
Array Forall

-

-

-
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Forall
 
+ 
 
+  
 
+   
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
 import static java.lang.Character.isLowerCase;
@@ -197,20 +179,20 @@ 
Array Forall

     final boolean b = a.forall({String s => fromString(s).forall({char c => isLowerCase(c)})});
     System.out.println(b); // false ("There" is a counter-example; try removing it)
   }
-}

-

-

-

-

-

-
Array Map

-

-

-
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Map
 
+ 
 
+  
 
+   
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.Show.arrayShow;
 import static fj.Show.intShow;
@@ -221,20 +203,20 @@ 
Array Map

     final Array<Integer> b = a.map({int i => i + 42});
     arrayShow(intShow).println(b); // {43,44,45}
   }
-}

-

-

-

-

-

-
List Map

-

-

-
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.

-

-

-

-
import static fj.data.List.list;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
List Map
 
+ 
 
+  
 
+   
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.
 
+  
 
+  
 
+   
 
+    
import static fj.data.List.list;
 import fj.data.List;
 import static fj.Show.intShow;
 import static fj.Show.listShow;
@@ -245,20 +227,20 @@ 
List Map

     final List<Integer> b = a.map({int i => i + 42});
     listShow(intShow).println(b); // [43,44,45]
   }
-}

-

-

-

-

-

-
Option Bind

-

-

-
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Bind
 
+ 
 
+  
 
+   
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
 import static fj.Show.intShow;
@@ -276,20 +258,20 @@ 
Option Bind

     optionShow(intShow).println(p2); // Some(24)
     optionShow(intShow).println(p3); // None
   }
-}

-

-

-

-

-

-
Option Filter

-

-

-
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number.

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Filter
 
+ 
 
+  
 
+   
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number.
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
 import static fj.Show.intShow;
@@ -307,20 +289,20 @@ 
Option Filter

     optionShow(intShow).println(p2); // None
     optionShow(intShow).println(p3); // Some(8)
   }
-}

-

-

-

-

-

-
Option Map

-

-

-
Maps a function across the optional value type. The function adds 42 to any contained value.

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Map
 
+ 
 
+  
 
+   
Maps a function across the optional value type. The function adds 42 to any contained value.
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
 import static fj.Show.intShow;
@@ -335,10 +317,10 @@ 
Option Map

     optionShow(intShow).println(p1); // Some(49)
     optionShow(intShow).println(p2); // None
   }
-}

-

-

-

+}
+
+
+

@@ -351,7 +333,7 @@

Option Map

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/examples-java7.html b/examples-java7.html index b0f6c59..3537b79 100644 --- a/examples-java7.html +++ b/examples-java7.html @@ -64,65 +64,43 @@

Java 7 Examples

-

-
-
-

These examples use standard Java 7 syntax where an instance of the fj.F interface is passed to emulate closures.

-
-
-

The example list is:

-
-
- -
-
-
-
-

Array Exists

-
-
-

Source code

-
-
-

Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.

-
-
-
-
import fj.F;
+            
 
+ 
 
+  
 
+   
These examples use standard Java 7 syntax where an instance of the fj.F interface is passed to emulate closures.
 
+  
 
+  
 
+   
The example list is:
 
+  
 
+  
 
+    
+  
 
+ 
 
+
 
+
 
+ 
Array Exists
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
@@ -138,23 +116,23 @@ 
Array Exists

     });
     System.out.println(b); // true ("what" provides the only example; try removing it)
   }
-}

-

-

-

-

-

-
Array Filter

-

-

-
Source code

-

-

-
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Filter
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.Show.arrayShow;
 import static fj.Show.intShow;
@@ -166,23 +144,23 @@ 
Array Filter

     final Array<Integer> b = a.filter(even);
     arrayShow(intShow).println(b); // {44,22,90,98,1078,6,64,6,42}
   }
-}

-

-

-

-

-

-
Array FoldLeft

-

-

-
Source code

-

-

-
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array FoldLeft
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.function.Integers.add;
 
@@ -192,23 +170,23 @@ 
Array FoldLeft

     final int b = a.foldLeft(add, 0);
     System.out.println(b); // 1774
   }
-}

-

-

-

-

-

-
Array Forall

-

-

-
Source code

-

-

-
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Forall
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
@@ -224,20 +202,20 @@ 
Array Forall

     });
     System.out.println(b); // false ("There" is a counter-example; try removing it)
   }
-}

-

-

-

-

-

-
Array map

-

-

-
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array map
 
+ 
 
+  
 
+   
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.function.Integers.add;
 import static fj.Show.arrayShow;
@@ -249,23 +227,23 @@ 
Array map

     final Array<Integer> b = a.map(add.f(42));
     arrayShow(intShow).println(b); // {43,44,45}
   }
-}

-

-

-

-

-

-
List map

-

-

-
Source code

-

-

-
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.

-

-

-

-
import fj.data.List;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
List map
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.
 
+  
 
+  
 
+   
 
+    
import fj.data.List;
 import static fj.data.List.list;
 import static fj.function.Integers.add;
 import static fj.Show.intShow;
@@ -277,20 +255,20 @@ 
List map

     final List<Integer> b = a.map(add.f(42));
     listShow(intShow).println(b); // [43,44,45]
   }
-}

-

-

-

-

-

-
List sort

-

-

-
Source code

-

-

-

-
import fj.data.List;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
List sort
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
 
+    
import fj.data.List;
 import static fj.data.List.list;
 import static fj.Ord.intOrd;
 import static fj.Show.intShow;
@@ -302,23 +280,23 @@ 
List sort

     final List<Integer> b = a.sort(intOrd);
     listShow(intShow).println(b); // [1,3,6,6,22,42,44,64,67,77,79,90,97,98,1078]
   }
-}

-

-

-

-

-

-
Option Bind

-

-

-
[Source code]

-

-

-
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Bind
 
+ 
 
+  
 
+   
[Source code]
 
+  
 
+  
 
+   
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
@@ -349,23 +327,23 @@ 
Option Bind

     optionShow(intShow).println(p2); // Some(24)
     optionShow(intShow).println(p3); // None
   }
-}

-

-

-

-

-

-
Option Filter

-

-

-
[Source code]

-

-

-
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number.

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Filter
 
+ 
 
+  
 
+   
[Source code]
 
+  
 
+  
 
+   
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number.
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
 import static fj.function.Integers.even;
@@ -384,23 +362,23 @@ 
Option Filter

     optionShow(intShow).println(p2); // None
     optionShow(intShow).println(p3); // Some(8)
   }
-}

-

-

-

-

-

-
Option map

-

-

-
Option map

-

-

-
Maps a function across the optional value type. The function adds 42 to any contained value.

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option map
 
+ 
 
+  
 
+   
Option map
 
+  
 
+  
 
+   
Maps a function across the optional value type. The function adds 42 to any contained value.
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.data.Option.none;
 import static fj.data.Option.some;
 import static fj.function.Integers.add;
@@ -416,23 +394,23 @@ 
Option map

     optionShow(intShow).println(p1); // Some(49)
     optionShow(intShow).println(p2); // None
   }
-}

-

-

-

-

-

-
HList append

-

-

-
Source code

-

-

-
Appends two heteregeneous lists. The type signature grows proportionally to the size of the list - an unfortunate consequence without type inference.

-

-

-

-
import static fj.data.hlist.HList.HCons;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
HList append
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Appends two heteregeneous lists. The type signature grows proportionally to the size of the list - an unfortunate consequence without type inference.
 
+  
 
+  
 
+   
 
+    
import static fj.data.hlist.HList.HCons;
 import static fj.data.hlist.HList.HNil;
 import static fj.data.hlist.HList.HAppend.append;
 import static fj.data.hlist.HList.HAppend;
@@ -469,23 +447,23 @@ 
HList append

     System.out.println(x.head()); // Foo
     System.out.println(x.tail().tail().tail().tail().head()); // Bar
   }
-}

-

-

-

-

-

-
HList foldRight

-

-

-
Source code

-

-

-
Fold across a type-safe heterogeneous list.

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
HList foldRight
 
+ 
 
+  
 
+   
Source code
 
+  
 
+  
 
+   
Fold across a type-safe heterogeneous list.
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import static fj.Function.identity;
 import fj.P2;
 import fj.Unit;
@@ -524,10 +502,10 @@ 
HList foldRight

     // Unit is used because composition has only one possible implementation.
     out.println(fold2.foldRight(unit(), id, functions).f("abc")); // 7
   }
-}

-

-

-

+}
+
+
+

@@ -540,7 +518,7 @@

HList foldRight

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/examples-java8.html b/examples-java8.html index f84b9f3..5e0e726 100644 --- a/examples-java8.html +++ b/examples-java8.html @@ -64,62 +64,42 @@

Java 8 Examples

-

-
-
-

These examples use the Java 8 syntax. Corresponding examples are also available in Java 7 and the original proposed BGGA syntax.

-
-
-

The example list is:

-
-
- -
-
-
-
-

Array Exists

-
-
-

Github Source

-
-
-

Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.

-
-
-
-
import fj.data.Array;
+            
 
+ 
 
+  
 
+   
These examples use the Java 8 syntax. Corresponding examples are also available in Java 7 and the original proposed BGGA syntax.
 
+  
 
+  
 
+   
The example list is:
 
+  
 
+  
 
+    
+  
 
+ 
 
+
 
+
 
+ 
Array Exists
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Checks for the existence of a String that has all lower case characters. In this case it is true (since, the case of "what"), but without this specific case, it is false. This example uses List.forall to test the characters of the String.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
 import static fj.function.Characters.isLowerCase;
@@ -130,23 +110,23 @@ 
Array Exists

         final boolean b = a.exists(s -> fromString(s).forall(isLowerCase));
         System.out.println(b); // true ("what" is the only value that qualifies; try removing it)
     }
-}

-

-

-

-

-

-
Array Filter

-

-

-
Github Source

-

-

-
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Filter
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Removes elements from an array that do not meet a certain criteria. In this case, we are using an array of integers and the filter removes any odd numbers.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.Show.arrayShow;
 import static fj.Show.intShow;
@@ -159,23 +139,23 @@ 
Array Filter

         final Array<Integer> c = a.filter(i -> i % 2 == 0);
         arrayShow(intShow).println(b); // {44,22,90,98,1078,6,64,6,42}
     }
-}

-

-

-

-

-

-
Array Fold Left

-

-

-
Github Source

-

-

-
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Fold Left
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Reduces the list applying a function per element. In this case, the fold sums the elements with a starting value of 0. Since 0 + 97 + 44 + 67 + 3 + 22 + 90 + 1 + 77 + 98 + 1078 + 6 + 64 + 6 + 79 + 42 == 1774 the result of the fold is 1774.
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.function.Integers.add;
@@ -189,23 +169,23 @@ 
Array Fold Left

         final int c = a.foldLeft(add2, 0);
         System.out.println(b); // 1774
     }
-}

-

-

-

-

-

-
Array For All

-

-

-
Github Source

-

-

-
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array For All
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Checks that all Strings in the array have lower case characters. In this case, the check fails because of the case of "There", however, the removal of this case produces a result of true.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.data.List.fromString;
 import static fj.function.Characters.isLowerCase;
@@ -216,23 +196,23 @@ 
Array For All

         final boolean b = a.forall(s -> fromString(s).forall(isLowerCase));
         System.out.println(b); // false ("There" is a counter-example; try removing it)
     }
-}

-

-

-

-

-

-
Array Map

-

-

-
Github Source

-

-

-
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.

-

-

-

-
import fj.data.Array;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Array Map
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Maps a function across the array of integers. In this case, the function adds 42 to each element of the array to produce a new array.
 
+  
 
+  
 
+   
 
+    
import fj.data.Array;
 import static fj.data.Array.array;
 import static fj.function.Integers.add;
 import static fj.Show.arrayShow;
@@ -246,23 +226,23 @@ 
Array Map

         arrayShow(intShow).println(b); // {43,44,45}
         arrayShow(intShow).println(c); // {43,44,45}
     }
-}

-

-

-

-

-

-
List Map

-

-

-
Github Source

-

-

-
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.

-

-

-

-
import fj.data.List;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
List Map
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Maps a function across a list of integers. This is similar to the Array map. This example adds 42 to each element of the list to produce a new list.
 
+  
 
+  
 
+   
 
+    
import fj.data.List;
 import static fj.data.List.list;
 import static fj.function.Integers.add;
 import static fj.Show.intShow;
@@ -275,23 +255,23 @@ 
List Map

         final List<Integer> c = a.map(i -> i = 42);
         listShow(intShow).println(b); // [43,44,45]
     }
-}

-

-

-

-

-

-
Option Bind

-

-

-
Github Source

-

-

-
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Bind
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Binds a function across the optional value type. The function checks if the contained value is even and if it is multiples that value by 3 and returns that new value. If the contained value is odd (or if there is no value), then no value is returned (none).
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Option;
 import static fj.Show.intShow;
 import static fj.Show.optionShow;
@@ -313,23 +293,23 @@ 
Option Bind

         optionShow(intShow).println(o5); // Some(24)
         optionShow(intShow).println(o6); // None
     }
-}

-

-

-

-

-

-
Option filter

-

-

-
Github Source

-

-

-
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number

-

-

-

-
import fj.F;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option filter
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Removes the value from the optional value if it does not match a given predicate. In this case the condition for preservation is that the contained value is an even number
 
+  
 
+  
 
+   
 
+    
import fj.F;
 import fj.data.Option;
 import static fj.Show.intShow;
 import static fj.Show.optionShow;
@@ -356,23 +336,23 @@ 
Option filter

         optionShow(intShow).println(o5); // None
         optionShow(intShow).println(o6); // Some(8)
     }
-}

-

-

-

-

-

-
Option Map

-

-

-
Github Source

-

-

-
Maps a function across the optional value type. The function adds 42 to any contained value.

-

-

-

-
import fj.data.Option;
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Option Map
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Maps a function across the optional value type. The function adds 42 to any contained value.
 
+  
 
+  
 
+   
 
+    
import fj.data.Option;
 import static fj.Show.intShow;
 import static fj.Show.optionShow;
 import static fj.data.Option.none;
@@ -392,23 +372,23 @@ 
Option Map

         optionShow(intShow).println(p1); // Some(49)
         optionShow(intShow).println(p2); // None
     }
-}

-

-

-

-

-

-
IO Walkthrough

-

-

-
Github Source

-

-

-
Demonstrates how to work with the IO type.

-

-

-

-
// IO is just a container to defer a computation (lazy), with the intention
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
IO Walkthrough
 
+ 
 
+  
 
+   
Github Source
 
+  
 
+  
 
+   
Demonstrates how to work with the IO type.
 
+  
 
+  
 
+   
 
+    
// IO is just a container to defer a computation (lazy), with the intention
 // to encapsulate computations that either consume and/or produce side-effects
 // the computation is not (yet) executed on creation hence it can be treated
 // like a value
@@ -475,10 +455,10 @@ 
IO Walkthrough

         .append(stdinReadLine())
         .bind(F1W.lift((String s) -> s.toUpperCase())
         .andThen(IOFunctions::stdoutPrintln))
-        .safe().run().on((IOException e) -> { e.printStackTrace(); return Unit.unit(); });

-

-

-

+        .safe().run().on((IOException e) -> { e.printStackTrace(); return Unit.unit(); });
+
+
+

@@ -491,7 +471,7 @@

IO Walkthrough

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/features.html b/features.html index 3e1b497..eb20753 100644 --- a/features.html +++ b/features.html @@ -64,52 +64,52 @@

Features

-

-

First-Class Functions

-
-
-

Functional Java provides generic interfaces and abstract classes that serve as first-class functions or closures, entirely within Java’s type system (i.e. without reflection or byte-code manipulation). The library centers around the F interface, which models a function from type A to type B.

-
-
-

Functions are written with anonymous class syntax:

-
-
-
-
// Regular Style
+            
 
+ 
First-Class Functions
 
+ 
 
+  
 
+   
Functional Java provides generic interfaces and abstract classes that serve as first-class functions or closures, entirely within Java’s type system (i.e. without reflection or byte-code manipulation). The library centers around the F interface, which models a function from type A to type B.
 
+  
 
+  
 
+   
Functions are written with anonymous class syntax:
 
+  
 
+  
 
+   
 
+    
// Regular Style
 Integer timesTwo(Integer i) { return i * 2; }
 // Functional Style
-F timesTwo = new F() { public Integer f(Integer i) { return i * 2; } }

-

-

-

-
First-class functions can be composed and passed as arguments to higher-order functions:

-

-

-

-
// Regular Style
+F timesTwo = new F() { public Integer f(Integer i) { return i * 2; } }
 
+   
 
+  
 
+  
 
+   
First-class functions can be composed and passed as arguments to higher-order functions:
 
+  
 
+  
 
+   
 
+    
// Regular Style
 Integer timesTwoPlusOne(Integer i) { return plusOne(timesTwo(i)); }
 // Functional Style
-F timesTwoPlusOne = plusOne.o(timesTwo);

-

-

-

-
And mapped over collections:

-

-

-

-
//Regular Style
+F timesTwoPlusOne = plusOne.o(timesTwo);
 
+   
 
+  
 
+  
 
+   
And mapped over collections:
 
+  
 
+  
 
+   
 
+    
//Regular Style
 List oneUp = new ArrayList();
 for (Integer i: ints) oneUp.add(plusOne(i));
 // Functional Style
-List oneUp = ints.map(plusOne);

-

-

-

-
Functions up to arity-8 are supported, allowing elimination of nested control constructs:

-

-

-

-
// Regular Style
+List oneUp = ints.map(plusOne);
 
+   
 
+  
 
+  
 
+   
Functions up to arity-8 are supported, allowing elimination of nested control constructs:
 
+  
 
+  
 
+   
 
+    
// Regular Style
 Integer product = 1;
 for (Integer x: ints) product = x * product;
 List products1 = new ArrayList();
@@ -127,92 +127,72 @@ 
First-Class Functions

 // Functional Style
 Integer product = ints.foldLeft(1, multiply);
 List products1 = ints.tails().apply(ints.map(multiply));
-List products2 = ints.bind(ints, multiply);

-

-

-

-

-

-
Immutable Datastructures

-

-

-
Functional Java implements many immutable datastructures, such as

-

-

-
    
-
  • 
-
    Singly-linked lists (fj.data.List)
    
-
    • 
-
  • 
-
    Non-strict, potentially infinite, singly-linked list (fj.data.Stream)
    
-
    • 
-
  • 
-
    Non-strict, potentially infinite Strings (fj.data.LazyString)
    
-
    • 
-
  • 
-
    A wrapper for arrays (fj.data.Array)
    
-
    • 
-
  • 
-
    A wrapper for any Iterable type (fj.data.IterableW)
    
-
    • 
-
  • 
-
    Immutable ordered sets (fj.data.Set)
    
-
    • 
-
  • 
-
    Multi-way trees — a.k.a. rose trees, with support for infinite trees (fj.data.Tree)
    
-
    • 
-
  • 
-
    Immutable Map, with single-traversal search-and-update (fj.data.TreeMap)
    
-
    • 
-
  • 
-
    Type-safe heterogeneous lists (fj.data.hlist)
    
-
    • 
-
  • 
-
    Pointed lists and trees (fj.data.Zipper and fj.data.TreeZipper)
    
-
    • 
-

-

-

-
These datatypes come with many powerful higher-order functions, such as map (for functors), bind (monads), apply and zipWith (applicative functors), and cobind (for comonads).

-

-

-
Efficient conversions to and from the standard Java Collections classes are provided, and java.util.Iterable is implemented where possible, for use with Java’s foreach syntax.

-

-

-

-

-
Optional Values (type-safe null)

-

-

-
The library provides a datatype for variables, parameters, and return values that may have no value, while remaining type-safe.

-

-

-

-
// Using null
+List products2 = ints.bind(ints, multiply);
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Immutable Datastructures
 
+ 
 
+  
 
+   
Functional Java implements many immutable datastructures, such as
 
+  
 
+  
 
+   
     
+    
  •  
    Singly-linked lists (fj.data.List)
     
    •  
+    
  •  
    Non-strict, potentially infinite, singly-linked list (fj.data.Stream)
     
    •  
+    
  •  
    Non-strict, potentially infinite Strings (fj.data.LazyString)
     
    •  
+    
  •  
    A wrapper for arrays (fj.data.Array)
     
    •  
+    
  •  
    A wrapper for any Iterable type (fj.data.IterableW)
     
    •  
+    
  •  
    Immutable ordered sets (fj.data.Set)
     
    •  
+    
  •  
    Multi-way trees — a.k.a. rose trees, with support for infinite trees (fj.data.Tree)
     
    •  
+    
  •  
    Immutable Map, with single-traversal search-and-update (fj.data.TreeMap)
     
    •  
+    
  •  
    Type-safe heterogeneous lists (fj.data.hlist)
     
    •  
+    
  •  
    Pointed lists and trees (fj.data.Zipper and fj.data.TreeZipper)
     
    •  
+   
 
+  
 
+  
 
+   
These datatypes come with many powerful higher-order functions, such as map (for functors), bind (monads), apply and zipWith (applicative functors), and cobind (for comonads).
 
+  
 
+  
 
+   
Efficient conversions to and from the standard Java Collections classes are provided, and java.util.Iterable is implemented where possible, for use with Java’s foreach syntax.
 
+  
 
+ 
 
+
 
+
 
+ 
Optional Values (type-safe null)
 
+ 
 
+  
 
+   
The library provides a datatype for variables, parameters, and return values that may have no value, while remaining type-safe.
 
+  
 
+  
 
+   
 
+    
// Using null
 String val = map.get(key);
 if (val == null || val.equals("")) val = "Nothing";
 return val;
 // Using Option
-return fromString(map.get(key)).orSome("Nothing");

-

-

-

-
Optional values are iterable, so they play nicely with foreach syntax, and they can be composed in a variety of ways. The fj.Option class has a plethora of methods for manipulating optional values, including many higher-order functions.

-

-

-

-

-
Product Types

-

-

-
Joint union types (tuples) are products of other types. Products of arities 1-8 are provided (fj.P1 - fj.P8). These are useful for when you want to return more than one value from a function, or when you want to accept several values when implementing an interface method that accepts only one argument. They can also be used to get products over other datatypes, such as lists (zip function).

-

-

-
Example:

-

-

-

-
import java.util.Map;
+return fromString(map.get(key)).orSome("Nothing");
 
+   
 
+  
 
+  
 
+   
Optional values are iterable, so they play nicely with foreach syntax, and they can be composed in a variety of ways. The fj.Option class has a plethora of methods for manipulating optional values, including many higher-order functions.
 
+  
 
+ 
 
+
 
+
 
+ 
Product Types
 
+ 
 
+  
 
+   
Joint union types (tuples) are products of other types. Products of arities 1-8 are provided (fj.P1 - fj.P8). These are useful for when you want to return more than one value from a function, or when you want to accept several values when implementing an interface method that accepts only one argument. They can also be used to get products over other datatypes, such as lists (zip function).
 
+  
 
+  
 
+   
Example:
 
+  
 
+  
 
+   
 
+    
import java.util.Map;
 import static fj.P.*;
 import fj.data.Option;
 import fj.data.TreeMap;
@@ -228,20 +208,20 @@ 
Product Types

 // Functional Java with product and option types.
 public Option<Integer> albuquerqueToLA(TreeMap<P2<String, String>, Integer> map) {
   return map.get(p("Albuquerque", "Los Angeles"));
-}

-

-

-

-

-

-
Disjoint Union Types

-

-

-
By the same token, types can be added by disjoint union. Values of type Either<A, B> contain a value of either type A or type B. This has many uses. As an argument type, it allows a single argument to depend on the type of value that is received (effectively overloading the method even if the interface is not designed to do that). As a return type, it allows you to return a value of one of two types depending on some condition. For example, to provide error handling where you are not allowed to throw `Exception`s:

-

-

-

-
// Meanwhile, inside an iterator implementation...
+}
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Disjoint Union Types
 
+ 
 
+  
 
+   
By the same token, types can be added by disjoint union. Values of type Either<A, B> contain a value of either type A or type B. This has many uses. As an argument type, it allows a single argument to depend on the type of value that is received (effectively overloading the method even if the interface is not designed to do that). As a return type, it allows you to return a value of one of two types depending on some condition. For example, to provide error handling where you are not allowed to throw `Exception`s:
 
+  
 
+  
 
+   
 
+    
// Meanwhile, inside an iterator implementation...
 public Either next() {
   String s = moreInput();
   try {
@@ -249,166 +229,96 @@ 
Disjoint Union Types

   } catch (Exception e) {
     return Either.left(Fail.invalidInteger(s));
   }
-}

-

-

-

-
The Either class includes a lot of useful methods, including higher-order functions for mapping and binding over the left and right types, as well as Iterable implementations for both types.

-

-

-
See here for a more detailed explanation of using Either for handling errors.

-

-

-

-

-
Higher-Order Concurrency Abstractions

-

-

-
Functional Java includes Parallel Strategies (fj.control.parallel.Strategy) for effectively decoupling concurrency patterns from algorithms. Strategy provides higher-order functions for mapping and binding over collections in parallel:

-

-

-

-
Strategy s = simpleThreadStrategy();
+}
 
+   
 
+  
 
+  
 
+   
The Either class includes a lot of useful methods, including higher-order functions for mapping and binding over the left and right types, as well as Iterable implementations for both types.
 
+  
 
+  
 
+   
See here for a more detailed explanation of using Either for handling errors.
 
+  
 
+ 
 
+
 
+
 
+ 
Higher-Order Concurrency Abstractions
 
+ 
 
+  
 
+   
Functional Java includes Parallel Strategies (fj.control.parallel.Strategy) for effectively decoupling concurrency patterns from algorithms. Strategy provides higher-order functions for mapping and binding over collections in parallel:
 
+  
 
+  
 
+   
 
+    
Strategy s = simpleThreadStrategy();
 List ns = range(Integer.MIN_VALUE, Integer.MIN_VALUE + 10).map(negate).toList();
-List bs = s.parMap(ns, isPrime);

-

-

-

-
Also included is an implementation of the actor model (fj.control.parallel.Actor and QueueActor), and Promise, which is a composable and non-blocking version of java.util.concurrent.Future.

-

-

-
A series of blog posts on the concurrency features can be found here.

-

-

-

-

-
Abstractions

-

-

-
Functional Java provides abstractions for the following types:

-

-

-
    
-
  • 
-
    Basic Data Structures
    
-
    
-
      
-
    • 
-
      Functions with arity 1 to 8 (fj.F).
      
-
      • 
-
    • 
-
      Functions with arity 0 to 8 that can produce exceptions (fj.TryCatch).
      
-
      • 
-
    • 
-
      Products with arity 1 to 8 (fj.P).
      
-
      • 
-
    • 
-
      Unit type (fj.Unit).
      
-
      • 
-
    • 
-
      Optional value - type-safe null (fj.data.Option).
      
-
      • 
-
    • 
-
      Disjoint union data type - compositional exception handling (fj.data.Either).
      
-
      • 
-
    • 
-
      Validation - right biased compositional exception handling (fj.data.Validation).
      
-
      • 
-
    • 
-
      Void - a logically uninhabited data type.
      
-
      • 
-
    
-
    
-
    • 
-
  • 
-
    Immutable Collections
    
-
    
-
      
-
    • 
-
      Array wrapper (fj.data.Array).
      
-
      • 
-
    • 
-
      Immutable, in-memory singly linked list (fj.data.List).
      
-
      • 
-
    • 
-
      Immutable lazy singly linked list (fj.data.Stream).
      
-
      • 
-
    • 
-
      A package (fj.data.fingertrees) providing 2-3 finger trees for a functional representation of persistent sequences, supporting access to the ends in amortized O(1) time.
      
-
      • 
-
    • 
-
      Immutable priority queue based on finger trees (fj.data.PriorityQueue).
      
-
      • 
-
    • 
-
      Type-safe heterogeneous list (fj.data.hlist) for lists of elements of differing types without sacrificing type-safety.
      
-
      • 
-
    • 
-
      Immutable set implementation using a red/black tree (fj.data.Set).
      
-
      • 
-
    • 
-
      Immutable multi-way tree - aka rose tree (fj.data.Tree).
      
-
      • 
-
    • 
-
      Immutable tree-map using a red/black tree implementation (fj.data.TreeMap).
      
-
      • 
-
    • 
-
      Difference lists, a highly performant list.
      
-
      • 
-
    
-
    
-
    • 
-
  • 
-
    Other
    
-
    
-
      
-
    • 
-
      Monoid (fj.Monoid).
      
-
      • 
-
    • 
-
      Semigroup (fj.Semigroup).
      
-
      • 
-
    • 
-
      Natural number data type (fj.data.Natural).
      
-
      • 
-
    • 
-
      Random number generator using a linear congruential generator (fj.LcgRng).
      
-
      • 
-
    • 
-
      Reader, Writer and State monads (fj.data.Reader,fj.data.Writer, fj.data.State).
      
-
      • 
-
    • 
-
      Input/Output monad for abstracting IO (fj.IO).
      
-
      • 
-
    • 
-
      Monadic parser combinators for writing parsers by combining smaller parsers using composition.
      
-
      • 
-
    • 
-
      Conversion of data types to/from standard Java types.
      
-
      • 
-
    • 
-
      Conversion between FunctionalJava and Java 8 specific types.
      
-
      • 
-
    • 
-
      Configurable equality and hash-code for HashMap and HashSet.
      
-
      • 
-
    • 
-
      Zipper implementations for streams and trees.
      
-
      • 
-
    • 
-
      Automated specification-based testing framework (fj.test).
      
-
      • 
-
    • 
-
      Fully operational Actors for parallel computations (fj.control.parallel) and layered abstractions such as parallel-map, map-reduce, parallel-zip.
      
-
      • 
-
    • 
-
      Optics for updating immutable data including lens, prism, iso, optional, traversal, getter, fold and setter.  Inspired by the Scala Monocle library (https://github.com/julien-truffaut/Monocle) and the Haskell lens library (https://github.com/ekmett/lens).
      
-
      • 
-
    
-
    
-
    • 
-

-

-

+List bs = s.parMap(ns, isPrime);
+
+
+
+

Also included is an implementation of the actor model (fj.control.parallel.Actor and QueueActor), and Promise, which is a composable and non-blocking version of java.util.concurrent.Future.

+
+
+

A series of blog posts on the concurrency features can be found here.

+
+
+
+
+

Abstractions

+
+
+

Functional Java provides abstractions for the following types:

+
+
+
    +

  • Basic Data Structures

    +
    +
      +

    • Functions with arity 1 to 8 (fj.F).

      • +

    • Functions with arity 0 to 8 that can produce exceptions (fj.TryCatch).

      • +

    • Products with arity 1 to 8 (fj.P).

      • +

    • Unit type (fj.Unit).

      • +

    • Optional value - type-safe null (fj.data.Option).

      • +

    • Disjoint union data type - compositional exception handling (fj.data.Either).

      • +

    • Validation - right biased compositional exception handling (fj.data.Validation).

      • +

    • Void - a logically uninhabited data type.

      • +
    +
    • +

  • Immutable Collections

    +
    +
      +

    • Array wrapper (fj.data.Array).

      • +

    • Immutable, in-memory singly linked list (fj.data.List).

      • +

    • Immutable lazy singly linked list (fj.data.Stream).

      • +

    • A package (fj.data.fingertrees) providing 2-3 finger trees for a functional representation of persistent sequences, supporting access to the ends in amortized O(1) time.

      • +

    • Immutable priority queue based on finger trees (fj.data.PriorityQueue).

      • +

    • Type-safe heterogeneous list (fj.data.hlist) for lists of elements of differing types without sacrificing type-safety.

      • +

    • Immutable set implementation using a red/black tree (fj.data.Set).

      • +

    • Immutable multi-way tree - aka rose tree (fj.data.Tree).

      • +

    • Immutable tree-map using a red/black tree implementation (fj.data.TreeMap).

      • +

    • Difference lists, a highly performant list.

      • +
    +
    • +

  • Other

    +
    +
      +

    • Monoid (fj.Monoid).

      • +

    • Semigroup (fj.Semigroup).

      • +

    • Natural number data type (fj.data.Natural).

      • +

    • Random number generator using a linear congruential generator (fj.LcgRng).

      • +

    • Reader, Writer and State monads (fj.data.Reader,fj.data.Writer, fj.data.State).

      • +

    • Input/Output monad for abstracting IO (fj.IO).

      • +

    • Monadic parser combinators for writing parsers by combining smaller parsers using composition.

      • +

    • Conversion of data types to/from standard Java types.

      • +

    • Conversion between FunctionalJava and Java 8 specific types.

      • +

    • Configurable equality and hash-code for HashMap and HashSet.

      • +

    • Zipper implementations for streams and trees.

      • +

    • Automated specification-based testing framework (fj.test).

      • +

    • Fully operational Actors for parallel computations (fj.control.parallel) and layered abstractions such as parallel-map, map-reduce, parallel-zip.

      • +

    • Optics for updating immutable data including lens, prism, iso, optional, traversal, getter, fold and setter. Inspired by the Scala Monocle library (https://github.com/julien-truffaut/Monocle) and the Haskell lens library (https://github.com/ekmett/lens).

      • +
    +
    • +
+
+

@@ -421,7 +331,7 @@

Abstractions

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/feed.xml b/feed.xml index 423c30e..3077f89 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - Nov 6, 2017 7:59:52 PM - Nov 6, 2017 7:59:52 PM + Jul 20, 2018 5:30:05 PM + Jul 20, 2018 5:30:05 PM diff --git a/index.html b/index.html index 47b2701..42fe10c 100644 --- a/index.html +++ b/index.html @@ -62,66 +62,60 @@
-

-
-logo 600x144 -
-
-
-

Overview

-
-
-

Functional Java is an open source library facilitating functional programming in Java. The library implements numerous basic and advanced programming abstractions that assist composition oriented development. Functional Java also serves as a platform for learning functional programming concepts by introducing these concepts using a familiar language.

-
-
-

The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck and Functional Java’s Quickcheck module. Functional Java is compiled with Java 8 targeting Java 6 bytecode. The use of lambdas within the project are backported with the Retro Lambda library, supporting Java versions 5 to 8 and beyond.

-
-
-
-
-

Features

-
-
-

Functional Java provides abstractions for the following types:

-
-
-
    -
  • -

    Basic Data Structures - total and partial functions, products, unit, option, unbiased and right biased unions (either and validation), void.

    -
    • -
  • -

    Immutable Collections - array, list, vector, stream, set, map, finger tree, priority queue, heterogenous list, difference lists.

    -
    • -
  • -

    Other Abstractions - monoid, semigroup, natural, random number generator, reader, writer, state, input/output, parser, zipper, specification based testing, actors, concurrency, optics (lens, prism, fold, traversal and others) and type conversion.

    -
    • -
-
-
-

See the features page for a brief description of each of these types.

-
-
-
-
-

Example

-
-
-

Read the quick start guide for how to add FunctionalJava to your project and get started with a full example.

-
-
-

Functional Java includes numerous usage examples, this example maps a function over an array, adding 42 to each element (imports omitted).

-
-
-
-
final Array<Integer> a = array(1, 2, 3);
+            
 
+ 
 
+  logo 600x144 
+ 
 
+
 
+
 
+ 
Overview
 
+ 
 
+  
 
+   
Functional Java is an open source library facilitating functional programming in Java. The library implements numerous basic and advanced programming abstractions that assist composition oriented development. Functional Java also serves as a platform for learning functional programming concepts by introducing these concepts using a familiar language.
 
+  
 
+  
 
+   
The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck and Functional Java’s Quickcheck module. Functional Java is compiled with Java 8 targeting Java 6 bytecode. The use of lambdas within the project are backported with the Retro Lambda library, supporting Java versions 5 to 8 and beyond.
 
+  
 
+ 
 
+
 
+
 
+ 
Features
 
+ 
 
+  
 
+   
Functional Java provides abstractions for the following types:
 
+  
 
+  
 
+   
     
+    
  •  
    Basic Data Structures - total and partial functions, products, unit, option, unbiased and right biased unions (either and validation), void.
     
    •  
+    
  •  
    Immutable Collections - array, list, vector, stream, set, map, finger tree, priority queue, heterogenous list, difference lists.
     
    •  
+    
  •  
    Other Abstractions - monoid, semigroup, natural, random number generator, reader, writer, state, input/output, parser, zipper, specification based testing, actors, concurrency, optics (lens, prism, fold, traversal and others) and type conversion.
     
    •  
+   
 
+  
 
+  
 
+   
See the features page for a brief description of each of these types.
 
+  
 
+ 
 
+
 
+
 
+ 
Example
 
+ 
 
+  
 
+   
Read the quick start guide for how to add FunctionalJava to your project and get started with a full example.
 
+  
 
+  
 
+   
Functional Java includes numerous usage examples, this example maps a function over an array, adding 42 to each element (imports omitted).
 
+  
 
+  
 
+   
 
+    
final Array<Integer> a = array(1, 2, 3);
 final Array<Integer> b = a.map(i -> i + 42);
 arrayShow(intShow).println(b); // {43,44,45}
 
 // combine into a single step
-arrayShow(intShow).println(array(1, 2, 3).map(i -> i + 42));

-

-

-

+arrayShow(intShow).println(array(1, 2, 3).map(i -> i + 42));
+
+
+

@@ -134,7 +128,7 @@

Example

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/quickstart.html b/quickstart.html index acf7e37..1e1ea0b 100644 --- a/quickstart.html +++ b/quickstart.html @@ -64,57 +64,49 @@

Quickstart

-

-
-
-

The latest stable version as at July 2015 is 4.7. Here is how to quickly add the library to your project and get started.

-
-
-

The Functional Java artifact is published to Maven Central using the group org.functionaljava with three published artifacts:

-
-
-
    -
  • -

    the core library (functionaljava)

    -
    • -
  • -

    Java 8 specific support (functionaljava-java8)

    -
    • -
  • -

    Quickcheck property based testing module (functionaljava-quickcheck)

    -
    • -
  • -

    Java core helper, a simple functional helper for java.util standard types (functionaljava-java-core)

    -
    • -
-
-
-
-
-

Gradle

-
-
-

To add Functional Java to your Gradle project, add the following snippet to the dependencies section of your build.gradle file.

-
-
-
-
compile "org.functionaljava:functionaljava:4.7"
+            
 
+ 
 
+  
 
+   
The latest stable version as at July 2015 is 4.7. Here is how to quickly add the library to your project and get started.
 
+  
 
+  
 
+   
The Functional Java artifact is published to Maven Central using the group org.functionaljava with three published artifacts:
 
+  
 
+  
 
+   
     
+    
  •  
    the core library (functionaljava)
     
    •  
+    
  •  
    Java 8 specific support (functionaljava-java8)
     
    •  
+    
  •  
    Quickcheck property based testing module (functionaljava-quickcheck)
     
    •  
+    
  •  
    Java core helper, a simple functional helper for java.util standard types (functionaljava-java-core)
     
    •  
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Gradle
 
+ 
 
+  
 
+   
To add Functional Java to your Gradle project, add the following snippet to the dependencies section of your build.gradle file.
 
+  
 
+  
 
+   
 
+    
compile "org.functionaljava:functionaljava:4.7"
 compile "org.functionaljava:functionaljava-java8:4.7"
 compile "org.functionaljava:functionaljava-quickcheck:4.7"
-compile "org.functionaljava:functionaljava-java-core:4.7"

-

-

-

-

-

-
Maven

-

-

-
Add the following dependencies.

-

-

-

-
<dependency>
+compile "org.functionaljava:functionaljava-java-core:4.7"
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
Maven
 
+ 
 
+  
 
+   
Add the following dependencies.
 
+  
 
+  
 
+   
 
+    
<dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava</artifactId>
     <version>4.7</version>
@@ -133,20 +125,20 @@ 
Maven

     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java-core</artifactId>
     <version>4.7</version>
-</dependency>

-

-

-

-

-

-
First Code Example

-

-

-
We can easily map over a list to apply the same function to each element in the list and print the resulting list.  Note that this uses the list fj.data.List.

-

-

-

-
import static fj.data.List.list;
+</dependency>
 
+   
 
+  
 
+ 
 
+
 
+
 
+ 
First Code Example
 
+ 
 
+  
 
+   
We can easily map over a list to apply the same function to each element in the list and print the resulting list. Note that this uses the list fj.data.List.
 
+  
 
+  
 
+   
 
+    
import static fj.data.List.list;
 import fj.data.List;
 import static fj.Show.intShow;
 import static fj.Show.listShow;
@@ -159,10 +151,10 @@ 
First Code Example

         // combined into a single line
         listShow(intShow).println(list(1, 2, 3).map(i -> i + 42)); // [43,44,45]
     }
-}

-

-

-

+}
+
+
+

@@ -175,7 +167,7 @@

First Code Example

-

© 2014 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.4.0 |

+

© 2014-2018 | Mixed with Bootstrap v3.1.1 | Baked with JBake v2.6.1 |

top diff --git a/tags/.html b/tags/.html new file mode 100644 index 0000000..fee29a6 --- /dev/null +++ b/tags/.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/applicative.html b/tags/applicative.html new file mode 100644 index 0000000..c13d786 --- /dev/null +++ b/tags/applicative.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #applicative

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/functional programming.html b/tags/functional programming.html new file mode 100644 index 0000000..a22ca2c --- /dev/null +++ b/tags/functional programming.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #functional-programming

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/functor.html b/tags/functor.html new file mode 100644 index 0000000..1797b76 --- /dev/null +++ b/tags/functor.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #functor

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/groovy.html b/tags/groovy.html new file mode 100644 index 0000000..e51acb1 --- /dev/null +++ b/tags/groovy.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #groovy

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/higher-order type.html b/tags/higher-order type.html new file mode 100644 index 0000000..d1e6dd9 --- /dev/null +++ b/tags/higher-order type.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #higher-order-type

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/kind.html b/tags/kind.html new file mode 100644 index 0000000..398ebbb --- /dev/null +++ b/tags/kind.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #kind

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/monad.html b/tags/monad.html new file mode 100644 index 0000000..60ea53e --- /dev/null +++ b/tags/monad.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #monad

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + diff --git a/tags/typeclass.html b/tags/typeclass.html new file mode 100644 index 0000000..e1296ac --- /dev/null +++ b/tags/typeclass.html @@ -0,0 +1,184 @@ + + + + + Functional Java + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+

Tag #typeclass

+
+ +
+ +
+ +
+ + +
+ + + + + + + + + + + + + + + + + + + From 21fdc2ef939496ba955297c99c33a1964d980b10 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Giraudeau Date: Sat, 18 Aug 2018 23:55:14 +0200 Subject: [PATCH 03/10] Publish of Github pages from Gradle. --- docs.html | 11 +++++++++++ download.html | 4 ++-- feed.xml | 4 ++-- quickstart.html | 18 +++++++++--------- 4 files changed, 24 insertions(+), 13 deletions(-) diff --git a/docs.html b/docs.html index ae0382e..d5eba1d 100644 --- a/docs.html +++ b/docs.html @@ -101,6 +101,17 @@

Release Notes

Javadoc

+
+

4.8

+
+ +
+

4.7

diff --git a/download.html b/download.html index 89b934a..cf1239b 100644 --- a/download.html +++ b/download.html @@ -87,11 +87,11 @@

Build System

Release Notes

-

The current stable release of Functional Java is 4.7. Release notes for each release are available below:

+

The current stable release of Functional Java is 4.8. Release notes for each release are available below:

    -

  • Index of release notes

    • +

  • 4.8 and later

  • 4.7

  • 4.6

  • 4.5

    • diff --git a/feed.xml b/feed.xml index 3077f89..8872e73 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - Jul 20, 2018 5:30:05 PM - Jul 20, 2018 5:30:05 PM + Aug 18, 2018 11:51:14 PM + Aug 18, 2018 11:51:14 PM diff --git a/quickstart.html b/quickstart.html index 1e1ea0b..63a24c6 100644 --- a/quickstart.html +++ b/quickstart.html @@ -67,7 +67,7 @@

    Quickstart

    -

    The latest stable version as at July 2015 is 4.7. Here is how to quickly add the library to your project and get started.

    +

    The latest stable version as at July 2015 is 4.8. Here is how to quickly add the library to your project and get started.

    The Functional Java artifact is published to Maven Central using the group org.functionaljava with three published artifacts:

    @@ -90,10 +90,10 @@

    Gradle

    - 
    compile "org.functionaljava:functionaljava:4.7"
-compile "org.functionaljava:functionaljava-java8:4.7"
-compile "org.functionaljava:functionaljava-quickcheck:4.7"
-compile "org.functionaljava:functionaljava-java-core:4.7"
    + 
    compile "org.functionaljava:functionaljava:4.8"
+compile "org.functionaljava:functionaljava-java8:4.8"
+compile "org.functionaljava:functionaljava-quickcheck:4.8"
+compile "org.functionaljava:functionaljava-java-core:4.8"
    @@ -109,22 +109,22 @@

    Maven

    <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava</artifactId>
-    <version>4.7</version>
+    <version>4.8</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java8</artifactId>
-    <version>4.7</version>
+    <version>4.8</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-quickcheck</artifactId>
-    <version>4.7</version>
+    <version>4.8</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java-core</artifactId>
-    <version>4.7</version>
+    <version>4.8</version>
 </dependency>
From e2b97fc9034f1fe966e8456e9510d5079c90570f Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Giraudeau Date: Sun, 19 Aug 2018 00:00:13 +0200 Subject: [PATCH 04/10] 4.8 javadoc --- .../allclasses-frame.html | 19 + .../allclasses-noframe.html | 19 + .../constant-values.html | 120 + .../deprecated-list.html | 120 + .../fj/java/util/ListUtil.html | 334 + .../fj/java/util/package-frame.html | 20 + .../fj/java/util/package-summary.html | 140 + .../fj/java/util/package-tree.html | 129 + .../functionaljava-java-core/help-doc.html | 217 + .../functionaljava-java-core/index-all.html | 159 + .../4.8/functionaljava-java-core/index.html | 72 + .../overview-tree.html | 133 + .../4.8/functionaljava-java-core/package-list | 1 + .../4.8/functionaljava-java-core/script.js | 30 + .../functionaljava-java-core/stylesheet.css | 574 + .../allclasses-frame.html | 20 + .../allclasses-noframe.html | 20 + .../functionaljava-java8/constant-values.html | 120 + .../functionaljava-java8/deprecated-list.html | 120 + .../fj/data/Collectors.html | 259 + .../functionaljava-java8/fj/data/Java8.html | 640 + .../fj/data/package-frame.html | 21 + .../fj/data/package-summary.html | 144 + .../fj/data/package-tree.html | 130 + .../4.8/functionaljava-java8/help-doc.html | 217 + .../4.8/functionaljava-java8/index-all.html | 257 + javadoc/4.8/functionaljava-java8/index.html | 72 + .../functionaljava-java8/overview-tree.html | 134 + javadoc/4.8/functionaljava-java8/package-list | 1 + javadoc/4.8/functionaljava-java8/script.js | 30 + .../4.8/functionaljava-java8/stylesheet.css | 574 + .../allclasses-frame.html | 37 + .../allclasses-noframe.html | 37 + .../constant-values.html | 122 + .../deprecated-list.html | 156 + .../fj/data/test/PropertyAssert.html | 236 + .../fj/data/test/package-frame.html | 20 + .../fj/data/test/package-summary.html | 142 + .../fj/data/test/package-tree.html | 135 + .../fj/test/Arbitrary.html | 2646 +++ .../fj/test/Arg.html | 329 + .../fj/test/Bool.html | 375 + .../fj/test/CheckResult.html | 713 + .../fj/test/Cogen.html | 2006 ++ .../fj/test/Gen.html | 1497 ++ .../fj/test/Property.html | 2514 +++ .../fj/test/Rand.html | 468 + .../fj/test/Result.html | 610 + .../fj/test/Shrink.html | 1680 ++ .../fj/test/Variant.html | 270 + .../fj/test/package-frame.html | 30 + .../fj/test/package-summary.html | 225 + .../fj/test/package-tree.html | 145 + .../fj/test/reflect/Category.html | 223 + .../fj/test/reflect/Check.html | 497 + .../fj/test/reflect/CheckParams.html | 309 + .../fj/test/reflect/Main.html | 245 + .../fj/test/reflect/Name.html | 221 + .../fj/test/reflect/NoCheck.html | 166 + .../fj/test/reflect/package-frame.html | 28 + .../fj/test/reflect/package-summary.html | 227 + .../fj/test/reflect/package-tree.html | 143 + .../fj/test/runner/PropertyTestRunner.html | 329 + .../fj/test/runner/package-frame.html | 20 + .../fj/test/runner/package-summary.html | 140 + .../fj/test/runner/package-tree.html | 139 + .../functionaljava-quickcheck/help-doc.html | 223 + .../functionaljava-quickcheck/index-all.html | 2127 +++ .../4.8/functionaljava-quickcheck/index.html | 75 + .../overview-frame.html | 24 + .../overview-summary.html | 154 + .../overview-tree.html | 163 + .../functionaljava-quickcheck/package-list | 4 + .../4.8/functionaljava-quickcheck/script.js | 30 + .../functionaljava-quickcheck/stylesheet.css | 574 + .../4.8/functionaljava/allclasses-frame.html | 230 + .../functionaljava/allclasses-noframe.html | 230 + .../4.8/functionaljava/constant-values.html | 205 + .../4.8/functionaljava/deprecated-list.html | 332 + javadoc/4.8/functionaljava/fj/Bottom.html | 401 + javadoc/4.8/functionaljava/fj/Class.html | 373 + javadoc/4.8/functionaljava/fj/Digit.html | 637 + javadoc/4.8/functionaljava/fj/Effect.html | 384 + .../fj/Equal.AltDefinition.html | 263 + .../functionaljava/fj/Equal.Definition.html | 291 + javadoc/4.8/functionaljava/fj/Equal.html | 1651 ++ javadoc/4.8/functionaljava/fj/F.html | 236 + javadoc/4.8/functionaljava/fj/F0.html | 224 + .../4.8/functionaljava/fj/F1Functions.html | 1691 ++ .../4.8/functionaljava/fj/F1W.F1WFunc.html | 316 + javadoc/4.8/functionaljava/fj/F1W.html | 1710 ++ javadoc/4.8/functionaljava/fj/F2.html | 239 + .../4.8/functionaljava/fj/F2Functions.html | 742 + .../4.8/functionaljava/fj/F2W.F2WFunc.html | 319 + javadoc/4.8/functionaljava/fj/F2W.html | 813 + javadoc/4.8/functionaljava/fj/F3.html | 242 + .../4.8/functionaljava/fj/F3Functions.html | 249 + javadoc/4.8/functionaljava/fj/F3W.html | 248 + javadoc/4.8/functionaljava/fj/F4.html | 245 + .../4.8/functionaljava/fj/F4Functions.html | 249 + javadoc/4.8/functionaljava/fj/F4W.html | 248 + javadoc/4.8/functionaljava/fj/F5.html | 251 + .../4.8/functionaljava/fj/F5Functions.html | 249 + javadoc/4.8/functionaljava/fj/F5W.html | 248 + javadoc/4.8/functionaljava/fj/F6.html | 254 + .../4.8/functionaljava/fj/F6Functions.html | 249 + javadoc/4.8/functionaljava/fj/F6W.html | 248 + javadoc/4.8/functionaljava/fj/F7.html | 257 + .../4.8/functionaljava/fj/F7Functions.html | 249 + javadoc/4.8/functionaljava/fj/F7W.html | 248 + javadoc/4.8/functionaljava/fj/F8.html | 260 + .../4.8/functionaljava/fj/F8Functions.html | 247 + javadoc/4.8/functionaljava/fj/F8W.html | 248 + javadoc/4.8/functionaljava/fj/Function.html | 2162 +++ javadoc/4.8/functionaljava/fj/Hash.html | 1264 ++ javadoc/4.8/functionaljava/fj/LcgRng.html | 330 + .../fj/Monoid.AltDefinition.html | 263 + .../functionaljava/fj/Monoid.Definition.html | 329 + javadoc/4.8/functionaljava/fj/Monoid.html | 1421 ++ .../functionaljava/fj/Ord.AltDefinition.html | 298 + .../4.8/functionaljava/fj/Ord.Definition.html | 427 + javadoc/4.8/functionaljava/fj/Ord.html | 1439 ++ javadoc/4.8/functionaljava/fj/Ordering.html | 401 + javadoc/4.8/functionaljava/fj/P.html | 1057 ++ javadoc/4.8/functionaljava/fj/P1.html | 951 + javadoc/4.8/functionaljava/fj/P2.Optic.html | 291 + javadoc/4.8/functionaljava/fj/P2.html | 1079 ++ javadoc/4.8/functionaljava/fj/P3.html | 686 + javadoc/4.8/functionaljava/fj/P4.html | 746 + javadoc/4.8/functionaljava/fj/P5.html | 806 + javadoc/4.8/functionaljava/fj/P6.html | 866 + javadoc/4.8/functionaljava/fj/P7.html | 926 + javadoc/4.8/functionaljava/fj/P8.html | 984 + javadoc/4.8/functionaljava/fj/Primitive.html | 1121 ++ javadoc/4.8/functionaljava/fj/Rng.html | 315 + .../fj/Semigroup.AltDefinition.html | 263 + .../fj/Semigroup.Definition.html | 294 + javadoc/4.8/functionaljava/fj/Semigroup.html | 1355 ++ javadoc/4.8/functionaljava/fj/Show.html | 1759 ++ javadoc/4.8/functionaljava/fj/Try.html | 434 + javadoc/4.8/functionaljava/fj/TryEffect.html | 340 + javadoc/4.8/functionaljava/fj/Unit.html | 260 + javadoc/4.8/functionaljava/fj/Void.html | 239 + .../functionaljava/fj/control/Trampoline.html | 582 + .../fj/control/db/Connector.html | 275 + .../4.8/functionaljava/fj/control/db/DB.html | 459 + .../functionaljava/fj/control/db/DbState.html | 358 + .../fj/control/db/package-frame.html | 22 + .../fj/control/db/package-summary.html | 163 + .../fj/control/db/package-tree.html | 137 + .../fj/control/package-frame.html | 20 + .../fj/control/package-summary.html | 151 + .../fj/control/package-tree.html | 135 + .../fj/control/parallel/Actor.html | 371 + .../fj/control/parallel/Callables.html | 731 + .../fj/control/parallel/ParModule.html | 1412 ++ .../fj/control/parallel/Promise.html | 864 + .../fj/control/parallel/Strategy.html | 1118 ++ .../fj/control/parallel/package-frame.html | 24 + .../fj/control/parallel/package-summary.html | 175 + .../fj/control/parallel/package-tree.html | 139 + javadoc/4.8/functionaljava/fj/data/$.html | 319 + .../fj/data/Array.ImmutableProjection.html | 679 + javadoc/4.8/functionaljava/fj/data/Array.html | 1719 ++ .../functionaljava/fj/data/Conversions.html | 1607 ++ javadoc/4.8/functionaljava/fj/data/DList.html | 474 + .../fj/data/Either.LeftProjection.html | 794 + .../fj/data/Either.RightProjection.html | 761 + .../4.8/functionaljava/fj/data/Either.html | 944 + .../functionaljava/fj/data/Enumerator.html | 858 + javadoc/4.8/functionaljava/fj/data/Eval.html | 450 + .../4.8/functionaljava/fj/data/HashMap.html | 1116 ++ .../4.8/functionaljava/fj/data/HashSet.html | 805 + javadoc/4.8/functionaljava/fj/data/IO.html | 237 + .../functionaljava/fj/data/IOFunctions.html | 1011 + javadoc/4.8/functionaljava/fj/data/IOW.html | 339 + .../4.8/functionaljava/fj/data/IterableW.html | 851 + .../fj/data/Iteratee.Input.html | 294 + .../fj/data/Iteratee.IterV.html | 389 + .../4.8/functionaljava/fj/data/Iteratee.html | 222 + javadoc/4.8/functionaljava/fj/data/Java.html | 3647 ++++ .../functionaljava/fj/data/LazyString.html | 983 + .../functionaljava/fj/data/List.Buffer.html | 483 + .../functionaljava/fj/data/List.Optic.html | 323 + .../functionaljava/fj/data/List.Unsafe.html | 239 + javadoc/4.8/functionaljava/fj/data/List.html | 3771 ++++ .../4.8/functionaljava/fj/data/Natural.html | 930 + .../functionaljava/fj/data/NonEmptyList.html | 1041 + .../functionaljava/fj/data/Option.Optic.html | 274 + .../4.8/functionaljava/fj/data/Option.html | 2227 +++ .../functionaljava/fj/data/PriorityQueue.html | 646 + .../4.8/functionaljava/fj/data/Reader.html | 366 + .../4.8/functionaljava/fj/data/SafeIO.html | 229 + javadoc/4.8/functionaljava/fj/data/Seq.html | 1011 + javadoc/4.8/functionaljava/fj/data/Set.html | 1370 ++ javadoc/4.8/functionaljava/fj/data/State.html | 479 + .../4.8/functionaljava/fj/data/Stream.html | 3302 ++++ javadoc/4.8/functionaljava/fj/data/Tree.html | 907 + .../4.8/functionaljava/fj/data/TreeMap.html | 1018 + .../functionaljava/fj/data/TreeZipper.html | 1368 ++ .../fj/data/Validation.FailProjection.html | 678 + .../functionaljava/fj/data/Validation.html | 2499 +++ .../4.8/functionaljava/fj/data/Writer.html | 380 + .../4.8/functionaljava/fj/data/Zipper.html | 1286 ++ .../fj/data/fingertrees/Deep.html | 727 + .../fj/data/fingertrees/Digit.html | 480 + .../fj/data/fingertrees/Empty.html | 667 + .../fj/data/fingertrees/FingerTree.html | 870 + .../fj/data/fingertrees/Four.html | 419 + .../fj/data/fingertrees/MakeTree.html | 544 + .../fj/data/fingertrees/Measured.html | 390 + .../fj/data/fingertrees/Node.html | 399 + .../fj/data/fingertrees/Node2.html | 396 + .../fj/data/fingertrees/Node3.html | 396 + .../fj/data/fingertrees/One.html | 419 + .../fj/data/fingertrees/Single.html | 687 + .../fj/data/fingertrees/Three.html | 419 + .../fj/data/fingertrees/Two.html | 419 + .../fj/data/fingertrees/package-frame.html | 33 + .../fj/data/fingertrees/package-summary.html | 236 + .../fj/data/fingertrees/package-tree.html | 157 + .../functionaljava/fj/data/hamt/BitSet.html | 811 + .../fj/data/hamt/HashArrayMappedTrie.html | 606 + .../4.8/functionaljava/fj/data/hamt/Node.html | 358 + .../fj/data/hamt/package-frame.html | 22 + .../fj/data/hamt/package-summary.html | 157 + .../fj/data/hamt/package-tree.html | 137 + .../fj/data/hlist/HList.Apply.html | 392 + .../fj/data/hlist/HList.HAppend.html | 304 + .../fj/data/hlist/HList.HCons.html | 324 + .../fj/data/hlist/HList.HFoldr.html | 323 + .../fj/data/hlist/HList.HNil.html | 298 + .../functionaljava/fj/data/hlist/HList.html | 384 + .../fj/data/hlist/HPre.HAdd.html | 298 + .../fj/data/hlist/HPre.HAnd.html | 306 + .../fj/data/hlist/HPre.HBool.html | 204 + .../fj/data/hlist/HPre.HCond.html | 285 + .../fj/data/hlist/HPre.HEq.html | 323 + .../fj/data/hlist/HPre.HFalse.html | 205 + .../fj/data/hlist/HPre.HNat.html | 332 + .../fj/data/hlist/HPre.HOr.html | 306 + .../fj/data/hlist/HPre.HSucc.html | 277 + .../fj/data/hlist/HPre.HTrue.html | 205 + .../fj/data/hlist/HPre.HZero.html | 273 + .../functionaljava/fj/data/hlist/HPre.html | 344 + .../fj/data/hlist/package-frame.html | 37 + .../fj/data/hlist/package-summary.html | 253 + .../fj/data/hlist/package-tree.html | 161 + .../functionaljava/fj/data/optic/Fold.html | 524 + .../functionaljava/fj/data/optic/Getter.html | 457 + .../4.8/functionaljava/fj/data/optic/Iso.html | 624 + .../functionaljava/fj/data/optic/Lens.html | 770 + .../fj/data/optic/Optional.html | 817 + .../functionaljava/fj/data/optic/PIso.html | 844 + .../functionaljava/fj/data/optic/PLens.html | 728 + .../fj/data/optic/POptional.html | 788 + .../functionaljava/fj/data/optic/PPrism.html | 799 + .../functionaljava/fj/data/optic/PSetter.html | 424 + .../fj/data/optic/PTraversal.html | 908 + .../functionaljava/fj/data/optic/Prism.html | 522 + .../functionaljava/fj/data/optic/Setter.html | 419 + .../fj/data/optic/Traversal.html | 723 + .../fj/data/optic/package-frame.html | 33 + .../fj/data/optic/package-summary.html | 246 + .../fj/data/optic/package-tree.html | 166 + .../functionaljava/fj/data/package-frame.html | 65 + .../fj/data/package-summary.html | 413 + .../functionaljava/fj/data/package-tree.html | 191 + .../4.8/functionaljava/fj/data/vector/V.html | 547 + .../4.8/functionaljava/fj/data/vector/V2.html | 647 + .../4.8/functionaljava/fj/data/vector/V3.html | 732 + .../4.8/functionaljava/fj/data/vector/V4.html | 772 + .../4.8/functionaljava/fj/data/vector/V5.html | 812 + .../4.8/functionaljava/fj/data/vector/V6.html | 852 + .../4.8/functionaljava/fj/data/vector/V7.html | 892 + .../4.8/functionaljava/fj/data/vector/V8.html | 932 + .../fj/data/vector/package-frame.html | 27 + .../fj/data/vector/package-summary.html | 193 + .../fj/data/vector/package-tree.html | 142 + .../fj/function/BigIntegers.html | 402 + .../functionaljava/fj/function/Booleans.html | 775 + .../fj/function/Characters.html | 563 + .../functionaljava/fj/function/Doubles.html | 502 + .../functionaljava/fj/function/Effect0.html | 220 + .../functionaljava/fj/function/Effect1.html | 222 + .../functionaljava/fj/function/Effect2.html | 224 + .../functionaljava/fj/function/Effect3.html | 226 + .../functionaljava/fj/function/Effect4.html | 228 + .../functionaljava/fj/function/Effect5.html | 230 + .../functionaljava/fj/function/Effect6.html | 232 + .../functionaljava/fj/function/Effect7.html | 234 + .../functionaljava/fj/function/Effect8.html | 236 + .../functionaljava/fj/function/Integers.html | 502 + .../4.8/functionaljava/fj/function/Longs.html | 321 + .../functionaljava/fj/function/Strings.html | 467 + .../4.8/functionaljava/fj/function/Try0.html | 231 + .../4.8/functionaljava/fj/function/Try1.html | 233 + .../4.8/functionaljava/fj/function/Try2.html | 235 + .../4.8/functionaljava/fj/function/Try3.html | 237 + .../4.8/functionaljava/fj/function/Try4.html | 239 + .../4.8/functionaljava/fj/function/Try5.html | 241 + .../4.8/functionaljava/fj/function/Try6.html | 243 + .../4.8/functionaljava/fj/function/Try7.html | 245 + .../4.8/functionaljava/fj/function/Try8.html | 247 + .../fj/function/TryEffect0.html | 225 + .../fj/function/TryEffect1.html | 227 + .../fj/function/TryEffect2.html | 229 + .../fj/function/TryEffect3.html | 231 + .../fj/function/TryEffect4.html | 233 + .../fj/function/TryEffect5.html | 235 + .../fj/function/TryEffect6.html | 237 + .../fj/function/TryEffect7.html | 239 + .../fj/function/TryEffect8.html | 241 + .../functionaljava/fj/function/Visitor.html | 393 + .../fj/function/package-frame.html | 57 + .../fj/function/package-summary.html | 366 + .../fj/function/package-tree.html | 172 + .../4.8/functionaljava/fj/package-frame.html | 89 + .../functionaljava/fj/package-summary.html | 555 + .../4.8/functionaljava/fj/package-tree.html | 238 + .../fj/parser/Parser.CharsParser.html | 1503 ++ .../fj/parser/Parser.StreamParser.html | 331 + .../4.8/functionaljava/fj/parser/Parser.html | 949 + .../4.8/functionaljava/fj/parser/Result.html | 524 + .../fj/parser/package-frame.html | 23 + .../fj/parser/package-summary.html | 170 + .../fj/parser/package-tree.html | 138 + javadoc/4.8/functionaljava/help-doc.html | 223 + javadoc/4.8/functionaljava/index-all.html | 15671 ++++++++++++++++ javadoc/4.8/functionaljava/index.html | 75 + .../4.8/functionaljava/overview-frame.html | 32 + .../4.8/functionaljava/overview-summary.html | 205 + javadoc/4.8/functionaljava/overview-tree.html | 446 + javadoc/4.8/functionaljava/package-list | 12 + javadoc/4.8/functionaljava/script.js | 30 + .../4.8/functionaljava/serialized-form.html | 150 + javadoc/4.8/functionaljava/stylesheet.css | 574 + 337 files changed, 179994 insertions(+) create mode 100644 javadoc/4.8/functionaljava-java-core/allclasses-frame.html create mode 100644 javadoc/4.8/functionaljava-java-core/allclasses-noframe.html create mode 100644 javadoc/4.8/functionaljava-java-core/constant-values.html create mode 100644 javadoc/4.8/functionaljava-java-core/deprecated-list.html create mode 100644 javadoc/4.8/functionaljava-java-core/fj/java/util/ListUtil.html create mode 100644 javadoc/4.8/functionaljava-java-core/fj/java/util/package-frame.html create mode 100644 javadoc/4.8/functionaljava-java-core/fj/java/util/package-summary.html create mode 100644 javadoc/4.8/functionaljava-java-core/fj/java/util/package-tree.html create mode 100644 javadoc/4.8/functionaljava-java-core/help-doc.html create mode 100644 javadoc/4.8/functionaljava-java-core/index-all.html create mode 100644 javadoc/4.8/functionaljava-java-core/index.html create mode 100644 javadoc/4.8/functionaljava-java-core/overview-tree.html create mode 100644 javadoc/4.8/functionaljava-java-core/package-list create mode 100644 javadoc/4.8/functionaljava-java-core/script.js create mode 100644 javadoc/4.8/functionaljava-java-core/stylesheet.css create mode 100644 javadoc/4.8/functionaljava-java8/allclasses-frame.html create mode 100644 javadoc/4.8/functionaljava-java8/allclasses-noframe.html create mode 100644 javadoc/4.8/functionaljava-java8/constant-values.html create mode 100644 javadoc/4.8/functionaljava-java8/deprecated-list.html create mode 100644 javadoc/4.8/functionaljava-java8/fj/data/Collectors.html create mode 100644 javadoc/4.8/functionaljava-java8/fj/data/Java8.html create mode 100644 javadoc/4.8/functionaljava-java8/fj/data/package-frame.html create mode 100644 javadoc/4.8/functionaljava-java8/fj/data/package-summary.html create mode 100644 javadoc/4.8/functionaljava-java8/fj/data/package-tree.html create mode 100644 javadoc/4.8/functionaljava-java8/help-doc.html create mode 100644 javadoc/4.8/functionaljava-java8/index-all.html create mode 100644 javadoc/4.8/functionaljava-java8/index.html create mode 100644 javadoc/4.8/functionaljava-java8/overview-tree.html create mode 100644 javadoc/4.8/functionaljava-java8/package-list create mode 100644 javadoc/4.8/functionaljava-java8/script.js create mode 100644 javadoc/4.8/functionaljava-java8/stylesheet.css create mode 100644 javadoc/4.8/functionaljava-quickcheck/allclasses-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/allclasses-noframe.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/constant-values.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/deprecated-list.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/data/test/PropertyAssert.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-summary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-tree.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Arbitrary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Arg.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Bool.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/CheckResult.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Cogen.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Gen.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Property.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Rand.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Result.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Shrink.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/Variant.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/package-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/package-summary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/package-tree.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Category.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Check.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/CheckParams.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Main.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Name.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/NoCheck.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-summary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-tree.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-summary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-tree.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/help-doc.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/index-all.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/index.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/overview-frame.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/overview-summary.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/overview-tree.html create mode 100644 javadoc/4.8/functionaljava-quickcheck/package-list create mode 100644 javadoc/4.8/functionaljava-quickcheck/script.js create mode 100644 javadoc/4.8/functionaljava-quickcheck/stylesheet.css create mode 100644 javadoc/4.8/functionaljava/allclasses-frame.html create mode 100644 javadoc/4.8/functionaljava/allclasses-noframe.html create mode 100644 javadoc/4.8/functionaljava/constant-values.html create mode 100644 javadoc/4.8/functionaljava/deprecated-list.html create mode 100644 javadoc/4.8/functionaljava/fj/Bottom.html create mode 100644 javadoc/4.8/functionaljava/fj/Class.html create mode 100644 javadoc/4.8/functionaljava/fj/Digit.html create mode 100644 javadoc/4.8/functionaljava/fj/Effect.html create mode 100644 javadoc/4.8/functionaljava/fj/Equal.AltDefinition.html create mode 100644 javadoc/4.8/functionaljava/fj/Equal.Definition.html create mode 100644 javadoc/4.8/functionaljava/fj/Equal.html create mode 100644 javadoc/4.8/functionaljava/fj/F.html create mode 100644 javadoc/4.8/functionaljava/fj/F0.html create mode 100644 javadoc/4.8/functionaljava/fj/F1Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F1W.F1WFunc.html create mode 100644 javadoc/4.8/functionaljava/fj/F1W.html create mode 100644 javadoc/4.8/functionaljava/fj/F2.html create mode 100644 javadoc/4.8/functionaljava/fj/F2Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F2W.F2WFunc.html create mode 100644 javadoc/4.8/functionaljava/fj/F2W.html create mode 100644 javadoc/4.8/functionaljava/fj/F3.html create mode 100644 javadoc/4.8/functionaljava/fj/F3Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F3W.html create mode 100644 javadoc/4.8/functionaljava/fj/F4.html create mode 100644 javadoc/4.8/functionaljava/fj/F4Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F4W.html create mode 100644 javadoc/4.8/functionaljava/fj/F5.html create mode 100644 javadoc/4.8/functionaljava/fj/F5Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F5W.html create mode 100644 javadoc/4.8/functionaljava/fj/F6.html create mode 100644 javadoc/4.8/functionaljava/fj/F6Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F6W.html create mode 100644 javadoc/4.8/functionaljava/fj/F7.html create mode 100644 javadoc/4.8/functionaljava/fj/F7Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F7W.html create mode 100644 javadoc/4.8/functionaljava/fj/F8.html create mode 100644 javadoc/4.8/functionaljava/fj/F8Functions.html create mode 100644 javadoc/4.8/functionaljava/fj/F8W.html create mode 100644 javadoc/4.8/functionaljava/fj/Function.html create mode 100644 javadoc/4.8/functionaljava/fj/Hash.html create mode 100644 javadoc/4.8/functionaljava/fj/LcgRng.html create mode 100644 javadoc/4.8/functionaljava/fj/Monoid.AltDefinition.html create mode 100644 javadoc/4.8/functionaljava/fj/Monoid.Definition.html create mode 100644 javadoc/4.8/functionaljava/fj/Monoid.html create mode 100644 javadoc/4.8/functionaljava/fj/Ord.AltDefinition.html create mode 100644 javadoc/4.8/functionaljava/fj/Ord.Definition.html create mode 100644 javadoc/4.8/functionaljava/fj/Ord.html create mode 100644 javadoc/4.8/functionaljava/fj/Ordering.html create mode 100644 javadoc/4.8/functionaljava/fj/P.html create mode 100644 javadoc/4.8/functionaljava/fj/P1.html create mode 100644 javadoc/4.8/functionaljava/fj/P2.Optic.html create mode 100644 javadoc/4.8/functionaljava/fj/P2.html create mode 100644 javadoc/4.8/functionaljava/fj/P3.html create mode 100644 javadoc/4.8/functionaljava/fj/P4.html create mode 100644 javadoc/4.8/functionaljava/fj/P5.html create mode 100644 javadoc/4.8/functionaljava/fj/P6.html create mode 100644 javadoc/4.8/functionaljava/fj/P7.html create mode 100644 javadoc/4.8/functionaljava/fj/P8.html create mode 100644 javadoc/4.8/functionaljava/fj/Primitive.html create mode 100644 javadoc/4.8/functionaljava/fj/Rng.html create mode 100644 javadoc/4.8/functionaljava/fj/Semigroup.AltDefinition.html create mode 100644 javadoc/4.8/functionaljava/fj/Semigroup.Definition.html create mode 100644 javadoc/4.8/functionaljava/fj/Semigroup.html create mode 100644 javadoc/4.8/functionaljava/fj/Show.html create mode 100644 javadoc/4.8/functionaljava/fj/Try.html create mode 100644 javadoc/4.8/functionaljava/fj/TryEffect.html create mode 100644 javadoc/4.8/functionaljava/fj/Unit.html create mode 100644 javadoc/4.8/functionaljava/fj/Void.html create mode 100644 javadoc/4.8/functionaljava/fj/control/Trampoline.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/Connector.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/DB.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/DbState.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/control/db/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/control/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/control/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/control/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/Actor.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/Callables.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/ParModule.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/Promise.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/Strategy.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/control/parallel/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/$.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Array.ImmutableProjection.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Array.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Conversions.html create mode 100644 javadoc/4.8/functionaljava/fj/data/DList.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Either.LeftProjection.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Either.RightProjection.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Either.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Enumerator.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Eval.html create mode 100644 javadoc/4.8/functionaljava/fj/data/HashMap.html create mode 100644 javadoc/4.8/functionaljava/fj/data/HashSet.html create mode 100644 javadoc/4.8/functionaljava/fj/data/IO.html create mode 100644 javadoc/4.8/functionaljava/fj/data/IOFunctions.html create mode 100644 javadoc/4.8/functionaljava/fj/data/IOW.html create mode 100644 javadoc/4.8/functionaljava/fj/data/IterableW.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Iteratee.Input.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Iteratee.IterV.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Iteratee.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Java.html create mode 100644 javadoc/4.8/functionaljava/fj/data/LazyString.html create mode 100644 javadoc/4.8/functionaljava/fj/data/List.Buffer.html create mode 100644 javadoc/4.8/functionaljava/fj/data/List.Optic.html create mode 100644 javadoc/4.8/functionaljava/fj/data/List.Unsafe.html create mode 100644 javadoc/4.8/functionaljava/fj/data/List.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Natural.html create mode 100644 javadoc/4.8/functionaljava/fj/data/NonEmptyList.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Option.Optic.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Option.html create mode 100644 javadoc/4.8/functionaljava/fj/data/PriorityQueue.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Reader.html create mode 100644 javadoc/4.8/functionaljava/fj/data/SafeIO.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Seq.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Set.html create mode 100644 javadoc/4.8/functionaljava/fj/data/State.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Stream.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/TreeMap.html create mode 100644 javadoc/4.8/functionaljava/fj/data/TreeZipper.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Validation.FailProjection.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Validation.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Writer.html create mode 100644 javadoc/4.8/functionaljava/fj/data/Zipper.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Deep.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Digit.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Empty.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/FingerTree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Four.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/MakeTree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Measured.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Node.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Node2.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Node3.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/One.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Single.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Three.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/Two.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/fingertrees/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/BitSet.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/HashArrayMappedTrie.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/Node.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hamt/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.Apply.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.HAppend.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.HCons.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.HFoldr.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.HNil.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HList.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAdd.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAnd.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HBool.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HCond.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HEq.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HFalse.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HNat.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HOr.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HSucc.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HTrue.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.HZero.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/HPre.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/hlist/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Fold.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Getter.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Iso.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Lens.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Optional.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/PIso.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/PLens.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/POptional.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/PPrism.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/PSetter.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/PTraversal.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Prism.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Setter.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/Traversal.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/optic/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V2.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V3.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V4.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V5.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V6.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V7.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/V8.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/data/vector/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/function/BigIntegers.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Booleans.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Characters.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Doubles.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect0.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect1.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect2.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect3.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect4.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect5.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect6.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect7.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Effect8.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Integers.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Longs.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Strings.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try0.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try1.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try2.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try3.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try4.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try5.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try6.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try7.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Try8.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect0.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect1.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect2.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect3.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect4.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect5.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect6.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect7.html create mode 100644 javadoc/4.8/functionaljava/fj/function/TryEffect8.html create mode 100644 javadoc/4.8/functionaljava/fj/function/Visitor.html create mode 100644 javadoc/4.8/functionaljava/fj/function/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/function/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/function/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/package-tree.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/Parser.CharsParser.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/Parser.StreamParser.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/Parser.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/Result.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/package-frame.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/package-summary.html create mode 100644 javadoc/4.8/functionaljava/fj/parser/package-tree.html create mode 100644 javadoc/4.8/functionaljava/help-doc.html create mode 100644 javadoc/4.8/functionaljava/index-all.html create mode 100644 javadoc/4.8/functionaljava/index.html create mode 100644 javadoc/4.8/functionaljava/overview-frame.html create mode 100644 javadoc/4.8/functionaljava/overview-summary.html create mode 100644 javadoc/4.8/functionaljava/overview-tree.html create mode 100644 javadoc/4.8/functionaljava/package-list create mode 100644 javadoc/4.8/functionaljava/script.js create mode 100644 javadoc/4.8/functionaljava/serialized-form.html create mode 100644 javadoc/4.8/functionaljava/stylesheet.css diff --git a/javadoc/4.8/functionaljava-java-core/allclasses-frame.html b/javadoc/4.8/functionaljava-java-core/allclasses-frame.html new file mode 100644 index 0000000..7b7a0b3 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/allclasses-frame.html @@ -0,0 +1,19 @@ + + + + + +All Classes (java-core 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-java-core/allclasses-noframe.html b/javadoc/4.8/functionaljava-java-core/allclasses-noframe.html new file mode 100644 index 0000000..e57e1d3 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/allclasses-noframe.html @@ -0,0 +1,19 @@ + + + + + +All Classes (java-core 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-java-core/constant-values.html b/javadoc/4.8/functionaljava-java-core/constant-values.html new file mode 100644 index 0000000..f893416 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/deprecated-list.html b/javadoc/4.8/functionaljava-java-core/deprecated-list.html new file mode 100644 index 0000000..cd4cfdf --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/fj/java/util/ListUtil.html b/javadoc/4.8/functionaljava-java-core/fj/java/util/ListUtil.html new file mode 100644 index 0000000..906d7f1 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/fj/java/util/ListUtil.html @@ -0,0 +1,334 @@ + + + + + +ListUtil (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.java.util
+

Class ListUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.java.util.ListUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ListUtil
+extends java.lang.Object
    +
    Created by MarkPerry on 28/08/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ListUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.List<B>bind(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A> java.util.List<A>filter(java.util.List<A> list, + fj.F<A,java.lang.Boolean> f) 
      static <A,B> java.util.List<B>flatMap(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A,B> Bfold(java.util.List<A> list, + fj.F2<B,A,B> f, + B b) 
      static <A,B> java.util.List<B>map(java.util.List<A> list, + fj.F<A,B> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ListUtil

        +
        public ListUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        map

        +
        public static <A,B> java.util.List<B> map(java.util.List<A> list,
+                                          fj.F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> java.util.List<A> filter(java.util.List<A> list,
+                                           fj.F<A,java.lang.Boolean> f)
        +
        • +
      + + + + + +
        +
      • +

        fold

        +
        public static <A,B> B fold(java.util.List<A> list,
+                           fj.F2<B,A,B> f,
+                           B b)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> java.util.List<B> flatMap(java.util.List<A> list,
+                                              fj.F<A,java.util.List<B>> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.List<B> bind(java.util.List<A> list,
+                                           fj.F<A,java.util.List<B>> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/fj/java/util/package-frame.html b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-frame.html new file mode 100644 index 0000000..0f3d910 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.java.util (java-core 4.8 API) + + + + + +

fj.java.util

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava-java-core/fj/java/util/package-summary.html b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-summary.html new file mode 100644 index 0000000..4248f84 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-summary.html @@ -0,0 +1,140 @@ + + + + + +fj.java.util (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package fj.java.util

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ListUtil +
    Created by MarkPerry on 28/08/2015.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/fj/java/util/package-tree.html b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-tree.html new file mode 100644 index 0000000..b8e3b46 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/fj/java/util/package-tree.html @@ -0,0 +1,129 @@ + + + + + +fj.java.util Class Hierarchy (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.java.util

+
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/help-doc.html b/javadoc/4.8/functionaljava-java-core/help-doc.html new file mode 100644 index 0000000..dba71fd --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/index-all.html b/javadoc/4.8/functionaljava-java-core/index-all.html new file mode 100644 index 0000000..ddc4c65 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/index-all.html @@ -0,0 +1,159 @@ + + + + + +Index (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
B F L M  + + +

B

+
+
bind(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

F

+
+
filter(List<A>, F<A, Boolean>) - Static method in class fj.java.util.ListUtil
+
 
+
fj.java.util - package fj.java.util
+
 
+
flatMap(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
fold(List<A>, F2<B, A, B>, B) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

L

+
+
ListUtil - Class in fj.java.util
+
+
Created by MarkPerry on 28/08/2015.
+
+
ListUtil() - Constructor for class fj.java.util.ListUtil
+
 
+
+ + + +

M

+
+
map(List<A>, F<A, B>) - Static method in class fj.java.util.ListUtil
+
 
+
+B F L M 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/index.html b/javadoc/4.8/functionaljava-java-core/index.html new file mode 100644 index 0000000..23a0973 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/index.html @@ -0,0 +1,72 @@ + + + + + +java-core 4.8 API + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="fj/java/util/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8/functionaljava-java-core/overview-tree.html b/javadoc/4.8/functionaljava-java-core/overview-tree.html new file mode 100644 index 0000000..b2834bb --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/overview-tree.html @@ -0,0 +1,133 @@ + + + + + +Class Hierarchy (java-core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java-core/package-list b/javadoc/4.8/functionaljava-java-core/package-list new file mode 100644 index 0000000..01c82ea --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/package-list @@ -0,0 +1 @@ +fj.java.util diff --git a/javadoc/4.8/functionaljava-java-core/script.js b/javadoc/4.8/functionaljava-java-core/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8/functionaljava-java-core/stylesheet.css b/javadoc/4.8/functionaljava-java-core/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8/functionaljava-java-core/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8/functionaljava-java8/allclasses-frame.html b/javadoc/4.8/functionaljava-java8/allclasses-frame.html new file mode 100644 index 0000000..fba254c --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/allclasses-frame.html @@ -0,0 +1,20 @@ + + + + + +All Classes (java8 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-java8/allclasses-noframe.html b/javadoc/4.8/functionaljava-java8/allclasses-noframe.html new file mode 100644 index 0000000..ad4c9f6 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/allclasses-noframe.html @@ -0,0 +1,20 @@ + + + + + +All Classes (java8 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-java8/constant-values.html b/javadoc/4.8/functionaljava-java8/constant-values.html new file mode 100644 index 0000000..9d1b2d8 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/deprecated-list.html b/javadoc/4.8/functionaljava-java8/deprecated-list.html new file mode 100644 index 0000000..ca07a61 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/fj/data/Collectors.html b/javadoc/4.8/functionaljava-java8/fj/data/Collectors.html new file mode 100644 index 0000000..a011c64 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/fj/data/Collectors.html @@ -0,0 +1,259 @@ + + + + + +Collectors (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Collectors

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Collectors
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Collectors
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Array<A>>toArray() 
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.List<A>>toList() 
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Stream<A>>toStream() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        toList

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.List<A>> toList()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Array<A>> toArray()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Stream<A>> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/fj/data/Java8.html b/javadoc/4.8/functionaljava-java8/fj/data/Java8.html new file mode 100644 index 0000000..0ab4bf5 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/fj/data/Java8.html @@ -0,0 +1,640 @@ + + + + + +Java8 (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Java8

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java8
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java8
+extends java.lang.Object
    +
    Created by mperry on 3/06/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> fj.F<java.util.function.BiFunction<A,B,C>,fj.F2<A,B,C>>BiFunction_F2() 
      static <A,B,C> fj.F2<A,B,C>BiFunction_F2(java.util.function.BiFunction<A,B,C> f) 
      static <A> fj.F<java.util.function.Consumer<A>,fj.F<A,fj.Unit>>Consumer_F() 
      static <A> fj.F<A,fj.Unit>Consumer_F(java.util.function.Consumer<A> c) 
      static <A,B> fj.F<fj.F<A,B>,java.util.function.Function<A,B>>F_Function() 
      static <A,B> java.util.function.Function<A,B>F_Function(fj.F<A,B> f) 
      static <A,B,C> fj.F<fj.F2<A,B,C>,java.util.function.BiFunction<A,B,C>>F2_BiFunction() 
      static <A,B,C> java.util.function.BiFunction<A,B,C>F2_BiFunction(fj.F2<A,B,C> f) 
      static <A,B> fj.F<java.util.function.Function<A,B>,fj.F<A,B>>Function_F() 
      static <A,B> fj.F<A,B>Function_F(java.util.function.Function<A,B> f) 
      static <A> java.util.stream.Stream<A>Iterable_JavaStream(java.lang.Iterable<A> it) 
      static <A> java.util.stream.Stream<A>Iterator_JavaStream(java.util.Iterator<A> it) 
      static <A> fj.data.Array<A>JavaStream_Array(java.util.stream.Stream<A> s) 
      static <A> fj.data.List<A>JavaStream_List(java.util.stream.Stream<A> s) 
      static <A> fj.data.Stream<A>JavaStream_Stream(java.util.stream.Stream<A> s) 
      static <A> java.util.stream.Stream<A>List_JavaStream(fj.data.List<A> list) 
      static <A> fj.F<fj.data.Option<A>,java.util.Optional<A>>Option_Optional() 
      static <A> java.util.Optional<A>Option_Optional(fj.data.Option<A> o) +
      Convert an Option to Optional.
      +
      static <A> fj.F<java.util.Optional<A>,fj.data.Option<A>>Optional_Option() 
      static <A> fj.data.Option<A>Optional_Option(java.util.Optional<A> o) 
      static <A> fj.F<fj.P1<A>,java.util.function.Supplier<A>>P1_Supplier() 
      static <A> java.util.function.Supplier<A>P1_Supplier(fj.P1<A> p) 
      static <A> fj.F<fj.data.Stream<A>,java.util.stream.Stream<A>>Stream_JavaStream() 
      static <A> java.util.stream.Stream<A>Stream_JavaStream(fj.data.Stream<A> s) 
      static <A> fj.F<java.util.function.Supplier<A>,fj.P1<A>>Supplier_P1() 
      static <A> fj.P1<A>Supplier_P1(java.util.function.Supplier<A> s) 
      static <A,E extends java.lang.Exception>
      fj.F<fj.function.Try0<A,E>,java.util.function.Supplier<fj.data.Validation<E,A>>>      		TryCatch0_Supplier() 
      static <A,E extends java.lang.Exception>
      java.util.function.Supplier<fj.data.Validation<E,A>>      		TryCatch0_Supplier(fj.function.Try0<A,E> t) 
      static <A,B,E extends java.lang.Exception>
      fj.F<fj.function.Try1<A,B,E>,java.util.function.Function<A,fj.data.Validation<E,B>>>      		TryCatch1_Function() 
      static <A,B,E extends java.lang.Exception>
      java.util.function.Function<A,fj.data.Validation<E,B>>      		TryCatch1_Function(fj.function.Try1<A,B,E> t) 
      static <A,B,C,E extends java.lang.Exception>
      fj.F<fj.function.Try2<A,B,C,E>,java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>>      		TryCatch2_BiFunction() 
      static <A,B,C,E extends java.lang.Exception>
      java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>      		TryCatch2_BiFunction(fj.function.Try2<A,B,C,E> t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> fj.P1<A> Supplier_P1(java.util.function.Supplier<A> s)
        +
        • +
      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> fj.F<java.util.function.Supplier<A>,fj.P1<A>> Supplier_P1()
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> java.util.function.Supplier<A> P1_Supplier(fj.P1<A> p)
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> fj.F<fj.P1<A>,java.util.function.Supplier<A>> P1_Supplier()
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> fj.F<A,B> Function_F(java.util.function.Function<A,B> f)
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> fj.F<java.util.function.Function<A,B>,fj.F<A,B>> Function_F()
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> java.util.function.Function<A,B> F_Function(fj.F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> fj.F<fj.F<A,B>,java.util.function.Function<A,B>> F_Function()
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> fj.F2<A,B,C> BiFunction_F2(java.util.function.BiFunction<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> fj.F<java.util.function.BiFunction<A,B,C>,fj.F2<A,B,C>> BiFunction_F2()
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> java.util.function.BiFunction<A,B,C> F2_BiFunction(fj.F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> fj.F<fj.F2<A,B,C>,java.util.function.BiFunction<A,B,C>> F2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> java.util.function.Supplier<fj.data.Validation<E,A>> TryCatch0_Supplier(fj.function.Try0<A,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> fj.F<fj.function.Try0<A,E>,java.util.function.Supplier<fj.data.Validation<E,A>>> TryCatch0_Supplier()
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> java.util.function.Function<A,fj.data.Validation<E,B>> TryCatch1_Function(fj.function.Try1<A,B,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> fj.F<fj.function.Try1<A,B,E>,java.util.function.Function<A,fj.data.Validation<E,B>>> TryCatch1_Function()
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> java.util.function.BiFunction<A,B,fj.data.Validation<E,C>> TryCatch2_BiFunction(fj.function.Try2<A,B,C,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> fj.F<fj.function.Try2<A,B,C,E>,java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>> TryCatch2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        List_JavaStream

        +
        public static <A> java.util.stream.Stream<A> List_JavaStream(fj.data.List<A> list)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> fj.data.Option<A> Optional_Option(java.util.Optional<A> o)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> fj.F<java.util.Optional<A>,fj.data.Option<A>> Optional_Option()
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> java.util.Optional<A> Option_Optional(fj.data.Option<A> o)
        +
        Convert an Option to Optional. Will throw a NullPointerException if the Option is some(null).
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> fj.F<fj.data.Option<A>,java.util.Optional<A>> Option_Optional()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> fj.F<java.util.function.Consumer<A>,fj.F<A,fj.Unit>> Consumer_F()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> fj.F<A,fj.Unit> Consumer_F(java.util.function.Consumer<A> c)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Stream_JavaStream(fj.data.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        Iterable_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterable_JavaStream(java.lang.Iterable<A> it)
        +
        • +
      + + + +
        +
      • +

        Iterator_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterator_JavaStream(java.util.Iterator<A> it)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> fj.F<fj.data.Stream<A>,java.util.stream.Stream<A>> Stream_JavaStream()
        +
        • +
      + + + +
        +
      • +

        JavaStream_Stream

        +
        public static <A> fj.data.Stream<A> JavaStream_Stream(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_List

        +
        public static <A> fj.data.List<A> JavaStream_List(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_Array

        +
        public static <A> fj.data.Array<A> JavaStream_Array(java.util.stream.Stream<A> s)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/fj/data/package-frame.html b/javadoc/4.8/functionaljava-java8/fj/data/package-frame.html new file mode 100644 index 0000000..072992e --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/fj/data/package-frame.html @@ -0,0 +1,21 @@ + + + + + +fj.data (java8 4.8 API) + + + + + +

fj.data

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava-java8/fj/data/package-summary.html b/javadoc/4.8/functionaljava-java8/fj/data/package-summary.html new file mode 100644 index 0000000..ca5bcbb --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/fj/data/package-summary.html @@ -0,0 +1,144 @@ + + + + + +fj.data (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package fj.data

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Collectors 
    Java8 +
    Created by mperry on 3/06/2014.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/fj/data/package-tree.html b/javadoc/4.8/functionaljava-java8/fj/data/package-tree.html new file mode 100644 index 0000000..f50d829 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/fj/data/package-tree.html @@ -0,0 +1,130 @@ + + + + + +fj.data Class Hierarchy (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data

+
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/help-doc.html b/javadoc/4.8/functionaljava-java8/help-doc.html new file mode 100644 index 0000000..405a601 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/index-all.html b/javadoc/4.8/functionaljava-java8/index-all.html new file mode 100644 index 0000000..b486276 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/index-all.html @@ -0,0 +1,257 @@ + + + + + +Index (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
B C F I J L O P S T  + + +

B

+
+
BiFunction_F2(BiFunction<A, B, C>) - Static method in class fj.data.Java8
+
 
+
BiFunction_F2() - Static method in class fj.data.Java8
+
 
+
+ + + +

C

+
+
Collectors - Class in fj.data
+
 
+
Consumer_F() - Static method in class fj.data.Java8
+
 
+
Consumer_F(Consumer<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

F

+
+
F2_BiFunction(F2<A, B, C>) - Static method in class fj.data.Java8
+
 
+
F2_BiFunction() - Static method in class fj.data.Java8
+
 
+
F_Function(F<A, B>) - Static method in class fj.data.Java8
+
 
+
F_Function() - Static method in class fj.data.Java8
+
 
+
fj.data - package fj.data
+
 
+
Function_F(Function<A, B>) - Static method in class fj.data.Java8
+
 
+
Function_F() - Static method in class fj.data.Java8
+
 
+
+ + + +

I

+
+
Iterable_JavaStream(Iterable<A>) - Static method in class fj.data.Java8
+
 
+
Iterator_JavaStream(Iterator<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

J

+
+
Java8 - Class in fj.data
+
+
Created by mperry on 3/06/2014.
+
+
JavaStream_Array(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_List(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_Stream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

L

+
+
List_JavaStream(List<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

O

+
+
Option_Optional(Option<A>) - Static method in class fj.data.Java8
+
+
Convert an Option to Optional.
+
+
Option_Optional() - Static method in class fj.data.Java8
+
 
+
Optional_Option(Optional<A>) - Static method in class fj.data.Java8
+
 
+
Optional_Option() - Static method in class fj.data.Java8
+
 
+
+ + + +

P

+
+
P1_Supplier(P1<A>) - Static method in class fj.data.Java8
+
 
+
P1_Supplier() - Static method in class fj.data.Java8
+
 
+
+ + + +

S

+
+
Stream_JavaStream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
Stream_JavaStream() - Static method in class fj.data.Java8
+
 
+
Supplier_P1(Supplier<A>) - Static method in class fj.data.Java8
+
 
+
Supplier_P1() - Static method in class fj.data.Java8
+
 
+
+ + + +

T

+
+
toArray() - Static method in class fj.data.Collectors
+
 
+
toList() - Static method in class fj.data.Collectors
+
 
+
toStream() - Static method in class fj.data.Collectors
+
 
+
TryCatch0_Supplier(Try0<A, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch0_Supplier() - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function(Try1<A, B, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function() - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction(Try2<A, B, C, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction() - Static method in class fj.data.Java8
+
 
+
+B C F I J L O P S T 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/index.html b/javadoc/4.8/functionaljava-java8/index.html new file mode 100644 index 0000000..58a6b0d --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/index.html @@ -0,0 +1,72 @@ + + + + + +java8 4.8 API + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="fj/data/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8/functionaljava-java8/overview-tree.html b/javadoc/4.8/functionaljava-java8/overview-tree.html new file mode 100644 index 0000000..dbe3187 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/overview-tree.html @@ -0,0 +1,134 @@ + + + + + +Class Hierarchy (java8 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-java8/package-list b/javadoc/4.8/functionaljava-java8/package-list new file mode 100644 index 0000000..bf3020d --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/package-list @@ -0,0 +1 @@ +fj.data diff --git a/javadoc/4.8/functionaljava-java8/script.js b/javadoc/4.8/functionaljava-java8/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8/functionaljava-java8/stylesheet.css b/javadoc/4.8/functionaljava-java8/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8/functionaljava-java8/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8/functionaljava-quickcheck/allclasses-frame.html b/javadoc/4.8/functionaljava-quickcheck/allclasses-frame.html new file mode 100644 index 0000000..ab94b4d --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/allclasses-frame.html @@ -0,0 +1,37 @@ + + + + + +All Classes (quickcheck 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/allclasses-noframe.html b/javadoc/4.8/functionaljava-quickcheck/allclasses-noframe.html new file mode 100644 index 0000000..f67d0db --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/allclasses-noframe.html @@ -0,0 +1,37 @@ + + + + + +All Classes (quickcheck 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/constant-values.html b/javadoc/4.8/functionaljava-quickcheck/constant-values.html new file mode 100644 index 0000000..29de43c --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/constant-values.html @@ -0,0 +1,122 @@ + + + + + +Constant Field Values (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/deprecated-list.html b/javadoc/4.8/functionaljava-quickcheck/deprecated-list.html new file mode 100644 index 0000000..77a07f8 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/deprecated-list.html @@ -0,0 +1,156 @@ + + + + + +Deprecated List (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/data/test/PropertyAssert.html b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/PropertyAssert.html new file mode 100644 index 0000000..b6450e1 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/PropertyAssert.html @@ -0,0 +1,236 @@ + + + + + +PropertyAssert (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.test
+

Class PropertyAssert

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.test.PropertyAssert
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PropertyAssert
+extends java.lang.Object
    +
    Created by MarkPerry on 18/12/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static fj.UnitassertResult(Property p) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        assertResult

        +
        public static fj.Unit assertResult(Property p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-frame.html b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-frame.html new file mode 100644 index 0000000..88e59cb --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.data.test (quickcheck 4.8 API) + + + + + +

fj.data.test

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-summary.html b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-summary.html new file mode 100644 index 0000000..8eb3e22 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-summary.html @@ -0,0 +1,142 @@ + + + + + +fj.data.test (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.test

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    PropertyAssert +
    Created by MarkPerry on 18/12/2014.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-tree.html b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-tree.html new file mode 100644 index 0000000..7fa30f5 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/data/test/package-tree.html @@ -0,0 +1,135 @@ + + + + + +fj.data.test Class Hierarchy (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Arbitrary.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Arbitrary.html new file mode 100644 index 0000000..40bf795 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Arbitrary.html @@ -0,0 +1,2646 @@ + + + + + +Arbitrary (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Arbitrary

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arbitrary
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arbitrary
+extends java.lang.Object
    +
    Common Gen helper functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Gen<java.lang.String>arbAlphaNumString +
      An arbitrary implementation for string values with alpha-numeric characters.
      +
      static Gen<java.math.BigDecimal>arbBigDecimal +
      An arbitrary implementation for big decimals.
      +
      static Gen<java.math.BigInteger>arbBigInteger +
      An arbitrary implementation for big integers.
      +
      static Gen<java.util.BitSet>arbBitSet +
      An arbitrary implementation for bit sets.
      +
      static Gen<java.lang.Boolean>arbBoolean +
      An arbitrary implementation for boolean values.
      +
      static Gen<java.lang.Byte>arbByte +
      An arbitrary implementation for byte values.
      +
      static Gen<java.lang.Byte>arbByteBoundaries +
      An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
      +
      static Gen<java.util.Calendar>arbCalendar +
      An arbitrary implementation for calendars.
      +
      static Gen<java.lang.Character>arbCharacter +
      An arbitrary implementation for character values.
      +
      static Gen<java.lang.Character>arbCharacterBoundaries +
      An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
      +
      static Gen<java.util.Date>arbDate +
      An arbitrary implementation for dates.
      +
      static Gen<java.lang.Double>arbDouble +
      An arbitrary implementation for double values.
      +
      static Gen<java.lang.Double>arbDoubleBoundaries +
      An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
      +
      static Gen<java.lang.Float>arbFloat +
      An arbitrary implementation for float values.
      +
      static Gen<java.lang.Float>arbFloatBoundaries +
      An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
      +
      static Gen<java.util.GregorianCalendar>arbGregorianCalendar +
      An arbitrary implementation for gregorian calendars.
      +
      static Gen<java.lang.Integer>arbInteger +
      An arbitrary implementation for integer values.
      +
      static Gen<java.lang.Integer>arbIntegerBoundaries +
      An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
      +
      static Gen<java.util.Locale>arbLocale +
      An arbitrary implementation for locales.
      +
      static Gen<java.lang.Long>arbLong +
      An arbitrary implementation for long values.
      +
      static Gen<java.lang.Long>arbLongBoundaries +
      An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
      +
      static Gen<fj.data.Natural>arbNatural +
      An arbitrary implementation for naturals.
      +
      static Gen<java.util.Properties>arbProperties +
      An arbitrary implementation for properties.
      +
      static Gen<java.lang.Short>arbShort +
      An arbitrary implementation for short values.
      +
      static Gen<java.lang.Short>arbShortBoundaries +
      An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
      +
      static Gen<java.sql.Date>arbSQLDate +
      An arbitrary implementation for SQL dates.
      +
      static Gen<java.lang.String>arbString +
      An arbitrary implementation for string values.
      +
      static Gen<java.lang.StringBuffer>arbStringBuffer +
      An arbitrary implementation for string buffer values.
      +
      static Gen<java.lang.StringBuilder>arbStringBuilder +
      An arbitrary implementation for string builder values.
      +
      static Gen<java.lang.Throwable>arbThrowable +
      An arbitrary implementation for throwables.
      +
      static Gen<java.sql.Time>arbTime +
      An arbitrary implementation for SQL times.
      +
      static Gen<java.sql.Timestamp>arbTimestamp +
      An arbitrary implementation for SQL time stamps.
      +
      static Gen<java.lang.String>arbUSASCIIString +
      An arbitrary implementation for string values with characters in the US-ASCII range.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Arbitrary() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Gen<fj.data.Array<A>>arbArray(Gen<A> aa) +
      Returns an arbitrary implementation for arrays.
      +
      static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>>arbArrayBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for array blocking queues.
      +
      static <A> Gen<java.util.ArrayList<A>>arbArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for array lists.
      +
      static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>>arbConcurrentHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for concurrent hash maps.
      +
      static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>>arbConcurrentLinkedQueue(Gen<A> aa) +
      Returns an arbitrary implementation for concurrent linked queues.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>>arbCopyOnWriteArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array lists.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>>arbCopyOnWriteArraySet(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      Gen<java.util.concurrent.DelayQueue<A>>      		arbDelayQueue(Gen<A> aa) +
      Returns an arbitrary implementation for delay queues.
      +
      static <A,B> Gen<fj.data.Either<A,B>>arbEither(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for the disjoint union.
      +
      static <K extends java.lang.Enum<K>,V>
      Gen<java.util.EnumMap<K,V>>      		arbEnumMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for enum maps.
      +
      static <A extends java.lang.Enum<A>>
      Gen<java.util.EnumSet<A>>      		arbEnumSet(Gen<A> aa) +
      Returns an arbitrary implementation for enum sets.
      +
      static <A extends java.lang.Enum<A>>
      Gen<A>      		arbEnumValue(java.lang.Class<A> clazz) +
      Returns an arbitrary implementation for a Java enumeration.
      +
      static <A,B> Gen<fj.F<A,B>>arbF(Cogen<A> c, + Gen<B> a) +
      An arbitrary for functions.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2(Cogen<A> ca, + Cogen<B> cb, + Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2Invariant(Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3Invariant(Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4Invariant(Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5Invariant(Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6Invariant(Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7Invariant(Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Cogen<H> ch, + Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8Invariant(Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B> Gen<fj.F<A,B>>arbFInvariant(Gen<B> a) +
      An arbitrary for functions.
      +
      static <A> Gen<Gen<A>>arbGen(Gen<A> aa) +
      Returns an arbitrary implementation for generators.
      +
      static <K,V> Gen<java.util.HashMap<K,V>>arbHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash maps.
      +
      static <A> Gen<java.util.HashSet<A>>arbHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <K,V> Gen<java.util.Hashtable<K,V>>arbHashtable(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash tables.
      +
      static <K,V> Gen<java.util.IdentityHashMap<K,V>>arbIdentityHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for identity hash maps.
      +
      static <K,V> Gen<java.util.TreeMap<K,V>>arbJavaTreeMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for java.util tree maps.
      +
      static <A> Gen<fj.LcgRng>arbLcgRng() +
      An arbitrary for the LcgRng.
      +
      static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>>arbLinkedBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for linked blocking queues.
      +
      static <K,V> Gen<java.util.LinkedHashMap<K,V>>arbLinkedHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for linked hash maps.
      +
      static <A> Gen<java.util.LinkedHashSet<A>>arbLinkedHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <A> Gen<java.util.LinkedList<A>>arbLinkedList(Gen<A> aa) +
      Returns an arbitrary implementation for linked lists.
      +
      static <A> Gen<fj.data.List<A>>arbList(Gen<A> aa) +
      Returns an arbitrary implementation for lists.
      +
      static <A> Gen<fj.data.List<java.lang.Boolean>>arbListBoolean() +
      Returns an arbitrary list of booleans.
      +
      static <A> Gen<fj.data.List<java.lang.Double>>arbListDouble() +
      Returns an arbitrary list of doubles.
      +
      static <A> Gen<fj.data.List<java.lang.Integer>>arbListInteger() +
      Returns an arbitrary list of integers.
      +
      static <A> Gen<fj.data.List<java.lang.String>>arbListString() +
      Returns an arbitrary list of strings.
      +
      static <A> Gen<fj.data.NonEmptyList<A>>arbNonEmptyList(Gen<A> aa) 
      static <A> Gen<fj.data.Option<A>>arbOption(Gen<A> aa) +
      Returns an arbitrary implementation for optional values.
      +
      static <A> Gen<fj.P1<A>>arbP1(Gen<A> aa) +
      Returns an arbitrary implementation for product-1 values.
      +
      static <A,B> Gen<fj.P2<A,B>>arbP2(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for product-2 values.
      +
      static <A,B,C> Gen<fj.P3<A,B,C>>arbP3(Gen<A> aa, + Gen<B> ab, + Gen<C> ac) +
      Returns an arbitrary implementation for product-3 values.
      +
      static <A,B,C,D> Gen<fj.P4<A,B,C,D>>arbP4(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad) +
      Returns an arbitrary implementation for product-4 values.
      +
      static <A,B,C,D,E>
      Gen<fj.P5<A,B,C,D,E>>      		arbP5(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae) +
      Returns an arbitrary implementation for product-5 values.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.P6<A,B,C,D,E,F$>>      		arbP6(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af) +
      Returns an arbitrary implementation for product-6 values.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.P7<A,B,C,D,E,F$,G>>      		arbP7(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag) +
      Returns an arbitrary implementation for product-7 values.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.P8<A,B,C,D,E,F$,G,H>>      		arbP8(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah) +
      Returns an arbitrary implementation for product-8 values.
      +
      static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>>arbPriorityBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static <A> Gen<java.util.PriorityQueue<A>>arbPriorityQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority queues.
      +
      static <A,B> Gen<fj.data.Reader<A,B>>arbReader(Cogen<A> aa, + Gen<B> ab) 
      static <A> Gen<fj.data.Seq<A>>arbSeq(Gen<A> aa) +
      Returns an arbitrary implementation for sequences.
      +
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa) 
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa, + int max) 
      static <A> Gen<java.util.Stack<A>>arbStack(Gen<A> aa) +
      Returns an arbitrary implementation for stacks.
      +
      static <S,A> Gen<fj.data.State<S,A>>arbState(Gen<S> as, + Cogen<S> cs, + Gen<A> aa) +
      An arbitrary for state.
      +
      static <A> Gen<fj.data.Stream<A>>arbStream(Gen<A> aa) +
      Returns an arbitrary implementation for streams.
      +
      static <A> Gen<java.util.concurrent.SynchronousQueue<A>>arbSynchronousQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static Gen<java.lang.Throwable>arbThrowable(Gen<java.lang.String> as) +
      Returns an arbitrary implementation for throwables.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for tree maps.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + Gen<java.lang.Integer> ai) +
      Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + int maxSize) +
      Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<fj.data.List<fj.P2<K,V>>> al) +
      Returns an arbitrary implementation for tree maps.
      +
      static <A> Gen<java.util.TreeSet<A>>arbTreeSet(Gen<A> aa) +
      Returns an arbitrary implementation for tree sets.
      +
      static <A,B> Gen<fj.data.Validation<A,B>>arbValidation(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary Validation for the given arbitrary parameters.
      +
      static <A> Gen<java.util.Vector<A>>arbVector(Gen<A> aa) +
      Returns an arbitrary implementation for vectors.
      +
      static <K,V> Gen<java.util.WeakHashMap<K,V>>arbWeakHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for weak hash maps.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        arbBoolean

        +
        public static final Gen<java.lang.Boolean> arbBoolean
        +
        An arbitrary implementation for boolean values.
        +
        • +
      + + + +
        +
      • +

        arbInteger

        +
        public static final Gen<java.lang.Integer> arbInteger
        +
        An arbitrary implementation for integer values.
        +
        • +
      + + + +
        +
      • +

        arbIntegerBoundaries

        +
        public static final Gen<java.lang.Integer> arbIntegerBoundaries
        +
        An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbLong

        +
        public static final Gen<java.lang.Long> arbLong
        +
        An arbitrary implementation for long values.
        +
        • +
      + + + +
        +
      • +

        arbLongBoundaries

        +
        public static final Gen<java.lang.Long> arbLongBoundaries
        +
        An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbByte

        +
        public static final Gen<java.lang.Byte> arbByte
        +
        An arbitrary implementation for byte values.
        +
        • +
      + + + +
        +
      • +

        arbByteBoundaries

        +
        public static final Gen<java.lang.Byte> arbByteBoundaries
        +
        An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbShort

        +
        public static final Gen<java.lang.Short> arbShort
        +
        An arbitrary implementation for short values.
        +
        • +
      + + + +
        +
      • +

        arbShortBoundaries

        +
        public static final Gen<java.lang.Short> arbShortBoundaries
        +
        An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbCharacter

        +
        public static final Gen<java.lang.Character> arbCharacter
        +
        An arbitrary implementation for character values.
        +
        • +
      + + + +
        +
      • +

        arbCharacterBoundaries

        +
        public static final Gen<java.lang.Character> arbCharacterBoundaries
        +
        An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
        +
        • +
      + + + +
        +
      • +

        arbDouble

        +
        public static final Gen<java.lang.Double> arbDouble
        +
        An arbitrary implementation for double values.
        +
        • +
      + + + +
        +
      • +

        arbDoubleBoundaries

        +
        public static final Gen<java.lang.Double> arbDoubleBoundaries
        +
        An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbFloat

        +
        public static final Gen<java.lang.Float> arbFloat
        +
        An arbitrary implementation for float values.
        +
        • +
      + + + +
        +
      • +

        arbFloatBoundaries

        +
        public static final Gen<java.lang.Float> arbFloatBoundaries
        +
        An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbString

        +
        public static final Gen<java.lang.String> arbString
        +
        An arbitrary implementation for string values.
        +
        • +
      + + + +
        +
      • +

        arbUSASCIIString

        +
        public static final Gen<java.lang.String> arbUSASCIIString
        +
        An arbitrary implementation for string values with characters in the US-ASCII range.
        +
        • +
      + + + +
        +
      • +

        arbAlphaNumString

        +
        public static final Gen<java.lang.String> arbAlphaNumString
        +
        An arbitrary implementation for string values with alpha-numeric characters.
        +
        • +
      + + + +
        +
      • +

        arbStringBuffer

        +
        public static final Gen<java.lang.StringBuffer> arbStringBuffer
        +
        An arbitrary implementation for string buffer values.
        +
        • +
      + + + +
        +
      • +

        arbStringBuilder

        +
        public static final Gen<java.lang.StringBuilder> arbStringBuilder
        +
        An arbitrary implementation for string builder values.
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static final Gen<java.lang.Throwable> arbThrowable
        +
        An arbitrary implementation for throwables.
        +
        • +
      + + + +
        +
      • +

        arbBitSet

        +
        public static final Gen<java.util.BitSet> arbBitSet
        +
        An arbitrary implementation for bit sets.
        +
        • +
      + + + +
        +
      • +

        arbCalendar

        +
        public static final Gen<java.util.Calendar> arbCalendar
        +
        An arbitrary implementation for calendars.
        +
        • +
      + + + +
        +
      • +

        arbDate

        +
        public static final Gen<java.util.Date> arbDate
        +
        An arbitrary implementation for dates.
        +
        • +
      + + + +
        +
      • +

        arbGregorianCalendar

        +
        public static final Gen<java.util.GregorianCalendar> arbGregorianCalendar
        +
        An arbitrary implementation for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        arbProperties

        +
        public static final Gen<java.util.Properties> arbProperties
        +
        An arbitrary implementation for properties.
        +
        • +
      + + + +
        +
      • +

        arbSQLDate

        +
        public static final Gen<java.sql.Date> arbSQLDate
        +
        An arbitrary implementation for SQL dates.
        +
        • +
      + + + +
        +
      • +

        arbTime

        +
        public static final Gen<java.sql.Time> arbTime
        +
        An arbitrary implementation for SQL times.
        +
        • +
      + + + +
        +
      • +

        arbTimestamp

        +
        public static final Gen<java.sql.Timestamp> arbTimestamp
        +
        An arbitrary implementation for SQL time stamps.
        +
        • +
      + + + +
        +
      • +

        arbBigInteger

        +
        public static final Gen<java.math.BigInteger> arbBigInteger
        +
        An arbitrary implementation for big integers.
        +
        • +
      + + + +
        +
      • +

        arbBigDecimal

        +
        public static final Gen<java.math.BigDecimal> arbBigDecimal
        +
        An arbitrary implementation for big decimals.
        +
        • +
      + + + +
        +
      • +

        arbNatural

        +
        public static final Gen<fj.data.Natural> arbNatural
        +
        An arbitrary implementation for naturals.
        +
        • +
      + + + +
        +
      • +

        arbLocale

        +
        public static final Gen<java.util.Locale> arbLocale
        +
        An arbitrary implementation for locales.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Arbitrary

        +
        public Arbitrary()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        arbF

        +
        public static <A,B> Gen<fj.F<A,B>> arbF(Cogen<A> c,
+                                        Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        c - The cogen for the function domain.
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbReader

        +
        public static <A,B> Gen<fj.data.Reader<A,B>> arbReader(Cogen<A> aa,
+                                                       Gen<B> ab)
        +
        • +
      + + + +
        +
      • +

        arbState

        +
        public static <S,A> Gen<fj.data.State<S,A>> arbState(Gen<S> as,
+                                                     Cogen<S> cs,
+                                                     Gen<A> aa)
        +
        An arbitrary for state.
        +
        • +
      + + + +
        +
      • +

        arbLcgRng

        +
        public static <A> Gen<fj.LcgRng> arbLcgRng()
        +
        An arbitrary for the LcgRng.
        +
        • +
      + + + +
        +
      • +

        arbFInvariant

        +
        public static <A,B> Gen<fj.F<A,B>> arbFInvariant(Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2(Cogen<A> ca,
+                                              Cogen<B> cb,
+                                              Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2Invariant

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2Invariant(Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc,
+                                                  Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3Invariant

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3Invariant(Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd,
+                                                      Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4Invariant

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4Invariant(Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5(Cogen<A> ca,
+                                                            Cogen<B> cb,
+                                                            Cogen<C> cc,
+                                                            Cogen<D> cd,
+                                                            Cogen<E> ce,
+                                                            Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5Invariant

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5Invariant(Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf,
+                                                                Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6Invariant

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6Invariant(Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg,
+                                                                    Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7Invariant

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7Invariant(Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch,
+                                                                        Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        ch - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8Invariant

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8Invariant(Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbGen

        +
        public static <A> Gen<Gen<A>> arbGen(Gen<A> aa)
        +
        Returns an arbitrary implementation for generators.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the generator is defined.
        +
        Returns:
        +
        An arbitrary implementation for generators.
        +
        +
        • +
      + + + +
        +
      • +

        arbOption

        +
        public static <A> Gen<fj.data.Option<A>> arbOption(Gen<A> aa)
        +
        Returns an arbitrary implementation for optional values.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the optional value is defined.
        +
        Returns:
        +
        An arbitrary implementation for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        arbEither

        +
        public static <A,B> Gen<fj.data.Either<A,B>> arbEither(Gen<A> aa,
+                                                       Gen<B> ab)
        +
        Returns an arbitrary implementation for the disjoint union.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        ab - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        Returns:
        +
        An arbitrary implementation for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        arbList

        +
        public static <A> Gen<fj.data.List<A>> arbList(Gen<A> aa)
        +
        Returns an arbitrary implementation for lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the list is defined.
        +
        Returns:
        +
        An arbitrary implementation for lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbListInteger

        +
        public static <A> Gen<fj.data.List<java.lang.Integer>> arbListInteger()
        +
        Returns an arbitrary list of integers.
        +
        • +
      + + + +
        +
      • +

        arbListString

        +
        public static <A> Gen<fj.data.List<java.lang.String>> arbListString()
        +
        Returns an arbitrary list of strings.
        +
        • +
      + + + +
        +
      • +

        arbListBoolean

        +
        public static <A> Gen<fj.data.List<java.lang.Boolean>> arbListBoolean()
        +
        Returns an arbitrary list of booleans.
        +
        • +
      + + + +
        +
      • +

        arbListDouble

        +
        public static <A> Gen<fj.data.List<java.lang.Double>> arbListDouble()
        +
        Returns an arbitrary list of doubles.
        +
        • +
      + + + +
        +
      • +

        arbNonEmptyList

        +
        public static <A> Gen<fj.data.NonEmptyList<A>> arbNonEmptyList(Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbValidation

        +
        public static <A,B> Gen<fj.data.Validation<A,B>> arbValidation(Gen<A> aa,
+                                                               Gen<B> ab)
        +
        Returns an arbitrary Validation for the given arbitrary parameters.
        +
        • +
      + + + +
        +
      • +

        arbStream

        +
        public static <A> Gen<fj.data.Stream<A>> arbStream(Gen<A> aa)
        +
        Returns an arbitrary implementation for streams.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stream is defined.
        +
        Returns:
        +
        An arbitrary implementation for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arbArray

        +
        public static <A> Gen<fj.data.Array<A>> arbArray(Gen<A> aa)
        +
        Returns an arbitrary implementation for arrays.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array is defined.
        +
        Returns:
        +
        An arbitrary implementation for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        arbSeq

        +
        public static <A> Gen<fj.data.Seq<A>> arbSeq(Gen<A> aa)
        +
        Returns an arbitrary implementation for sequences.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the sequence is defined.
        +
        Returns:
        +
        An arbitrary implementation for sequences.
        +
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa,
+                                             int max)
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static Gen<java.lang.Throwable> arbThrowable(Gen<java.lang.String> as)
        +
        Returns an arbitrary implementation for throwables.
        +
        +
        Parameters:
        +
        as - An arbitrary used for the throwable message.
        +
        Returns:
        +
        An arbitrary implementation for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayList

        +
        public static <A> Gen<java.util.ArrayList<A>> arbArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array list is defined.
        +
        Returns:
        +
        An arbitrary implementation for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumValue

        +
        public static <A extends java.lang.Enum<A>> Gen<A> arbEnumValue(java.lang.Class<A> clazz)
        +
        Returns an arbitrary implementation for a Java enumeration.
        +
        +
        Parameters:
        +
        clazz - The type of enum to return an arbitrary of.
        +
        Returns:
        +
        An arbitrary for instances of the supplied enum type.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Gen<java.util.EnumMap<K,V>> arbEnumMap(Gen<K> ak,
+                                                                                     Gen<V> av)
        +
        Returns an arbitrary implementation for enum maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the enum map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the enum map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumSet

        +
        public static <A extends java.lang.Enum<A>> Gen<java.util.EnumSet<A>> arbEnumSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for enum sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the enum set is defined.
        +
        Returns:
        +
        An arbitrary implementation for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashMap

        +
        public static <K,V> Gen<java.util.HashMap<K,V>> arbHashMap(Gen<K> ak,
+                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashSet

        +
        public static <A> Gen<java.util.HashSet<A>> arbHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashtable

        +
        public static <K,V> Gen<java.util.Hashtable<K,V>> arbHashtable(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for hash tables.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash table's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the hash table's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        arbIdentityHashMap

        +
        public static <K,V> Gen<java.util.IdentityHashMap<K,V>> arbIdentityHashMap(Gen<K> ak,
+                                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for identity hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the identity hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the identity hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashMap

        +
        public static <K,V> Gen<java.util.LinkedHashMap<K,V>> arbLinkedHashMap(Gen<K> ak,
+                                                                       Gen<V> av)
        +
        Returns an arbitrary implementation for linked hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the linked hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the linked hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashSet

        +
        public static <A> Gen<java.util.LinkedHashSet<A>> arbLinkedHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedList

        +
        public static <A> Gen<java.util.LinkedList<A>> arbLinkedList(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked list is defined.
        +
        Returns:
        +
        An arbitrary implementation for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityQueue

        +
        public static <A> Gen<java.util.PriorityQueue<A>> arbPriorityQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbStack

        +
        public static <A> Gen<java.util.Stack<A>> arbStack(Gen<A> aa)
        +
        Returns an arbitrary implementation for stacks.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stack is defined.
        +
        Returns:
        +
        An arbitrary implementation for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        arbJavaTreeMap

        +
        public static <K,V> Gen<java.util.TreeMap<K,V>> arbJavaTreeMap(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for java.util tree maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the tree map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the tree map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<fj.data.List<fj.P2<K,V>>> al)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         Gen<java.lang.Integer> ai)
        +
        Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         int maxSize)
        +
        Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
        +
        • +
      + + + +
        +
      • +

        arbTreeSet

        +
        public static <A> Gen<java.util.TreeSet<A>> arbTreeSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for tree sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the tree set is defined.
        +
        Returns:
        +
        An arbitrary implementation for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbVector

        +
        public static <A> Gen<java.util.Vector<A>> arbVector(Gen<A> aa)
        +
        Returns an arbitrary implementation for vectors.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the vector is defined.
        +
        Returns:
        +
        An arbitrary implementation for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        arbWeakHashMap

        +
        public static <K,V> Gen<java.util.WeakHashMap<K,V>> arbWeakHashMap(Gen<K> ak,
+                                                                   Gen<V> av)
        +
        Returns an arbitrary implementation for weak hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the weak hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the weak hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>> arbArrayBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for array blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentHashMap

        +
        public static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>> arbConcurrentHashMap(Gen<K> ak,
+                                                                                          Gen<V> av)
        +
        Returns an arbitrary implementation for concurrent hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the concurrent hash map's keys + are defined.
        +
        av - An arbitrary implementation for the type over which the concurrent hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentLinkedQueue

        +
        public static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>> arbConcurrentLinkedQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for concurrent linked queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the concurrent linked queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArrayList

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>> arbCopyOnWriteArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array list is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArraySet

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>> arbCopyOnWriteArraySet(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array set is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Gen<java.util.concurrent.DelayQueue<A>> arbDelayQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for delay queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the delay queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>> arbLinkedBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>> arbPriorityBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbSynchronousQueue

        +
        public static <A> Gen<java.util.concurrent.SynchronousQueue<A>> arbSynchronousQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbP1

        +
        public static <A> Gen<fj.P1<A>> arbP1(Gen<A> aa)
        +
        Returns an arbitrary implementation for product-1 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the product-1 is defined.
        +
        Returns:
        +
        An arbitrary implementation for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP2

        +
        public static <A,B> Gen<fj.P2<A,B>> arbP2(Gen<A> aa,
+                                          Gen<B> ab)
        +
        Returns an arbitrary implementation for product-2 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP3

        +
        public static <A,B,C> Gen<fj.P3<A,B,C>> arbP3(Gen<A> aa,
+                                              Gen<B> ab,
+                                              Gen<C> ac)
        +
        Returns an arbitrary implementation for product-3 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP4

        +
        public static <A,B,C,D> Gen<fj.P4<A,B,C,D>> arbP4(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Gen<C> ac,
+                                                  Gen<D> ad)
        +
        Returns an arbitrary implementation for product-4 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP5

        +
        public static <A,B,C,D,E> Gen<fj.P5<A,B,C,D,E>> arbP5(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Gen<D> ad,
+                                                      Gen<E> ae)
        +
        Returns an arbitrary implementation for product-5 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP6

        +
        public static <A,B,C,D,E,F$> Gen<fj.P6<A,B,C,D,E,F$>> arbP6(Gen<A> aa,
+                                                            Gen<B> ab,
+                                                            Gen<C> ac,
+                                                            Gen<D> ad,
+                                                            Gen<E> ae,
+                                                            Gen<F$> af)
        +
        Returns an arbitrary implementation for product-6 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP7

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.P7<A,B,C,D,E,F$,G>> arbP7(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Gen<F$> af,
+                                                                Gen<G> ag)
        +
        Returns an arbitrary implementation for product-7 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP8

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.P8<A,B,C,D,E,F$,G,H>> arbP8(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Gen<G> ag,
+                                                                    Gen<H> ah)
        +
        Returns an arbitrary implementation for product-8 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ah - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Arg.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Arg.html new file mode 100644 index 0000000..dff0f22 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Arg.html @@ -0,0 +1,329 @@ + + + + + +Arg (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Arg<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arg<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arg<T>
+extends java.lang.Object
    +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<Arg<?>>argShow +
      The rendering of an argument (uses Object.toString() for the argument value).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> Arg<T>arg(T value, + int shrinks) +
      Construct a property argument with the given value and number of shrinks.
      +
      intshrinks() +
      Returns the argument's number of shrinks following falsification.
      +
      java.lang.Objectvalue() +
      Returns the argument's value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        argShow

        +
        public static final fj.Show<Arg<?>> argShow
        +
        The rendering of an argument (uses Object.toString() for the argument value).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        arg

        +
        public static <T> Arg<T> arg(T value,
+                             int shrinks)
        +
        Construct a property argument with the given value and number of shrinks.
        +
        +
        Parameters:
        +
        value - The value to construct an argument with.
        +
        shrinks - The number of shrinks to construct an argument with.
        +
        Returns:
        +
        A new argument.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public java.lang.Object value()
        +
        Returns the argument's value.
        +
        +
        Returns:
        +
        The argument's value.
        +
        +
        • +
      + + + +
        +
      • +

        shrinks

        +
        public int shrinks()
        +
        Returns the argument's number of shrinks following falsification.
        +
        +
        Returns:
        +
        The argument's number of shrinks following falsification.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Bool.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Bool.html new file mode 100644 index 0000000..41adc17 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Bool.html @@ -0,0 +1,375 @@ + + + + + +Bool (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Bool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Bool
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bool
+extends java.lang.Object
    +
    A boolean wrapper that works well with properties.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Boolbool(boolean b) +
      Construct a Bool from the given value.
      +
      Propertyimplies(Bool c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(boolean c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(fj.F0<Property> p) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(Property p) +
      Returns a property that produces a result only if this value is true.
      +
      booleanis() +
      Returns true if this value is true, false otherwise.
      +
      booleanisNot() +
      Returns false if this value is true, true otherwise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        is

        +
        public boolean is()
        +
        Returns true if this value is true, false otherwise.
        +
        +
        Returns:
        +
        true if this value is true, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNot

        +
        public boolean isNot()
        +
        Returns false if this value is true, true otherwise.
        +
        +
        Returns:
        +
        false if this value is true, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(fj.F0<Property> p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Property p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Bool c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(boolean c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        bool

        +
        public static Bool bool(boolean b)
        +
        Construct a Bool from the given value.
        +
        +
        Parameters:
        +
        b - The value to construct a Bool with.
        +
        Returns:
        +
        A Bool from the given value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/CheckResult.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/CheckResult.html new file mode 100644 index 0000000..e714f20 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/CheckResult.html @@ -0,0 +1,713 @@ + + + + + +CheckResult (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class CheckResult

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.CheckResult
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class CheckResult
+extends java.lang.Object
    +
    An enumeration of the possible results after checking a property. A CheckResult may + be in one of six states: +
      +
    1. Passed
      2. +
    2. Proven
      3. +
    3. Falsified
      4. +
    4. Exhausted
      5. +
    5. Exception executing the property
      6. +
    6. Exception generating values to check the property
      7. +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<CheckResult>summary +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
      +
      intdiscarded() +
      Returns the number of discarded checks of the property in this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
      +
      static CheckResultexhausted(int succeeded, + int discarded) +
      Returns a result that the property been exhausted in checking.
      +
      static CheckResultfalsified(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been falsified.
      +
      static CheckResultgenException(java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that generating values to check the property threw an exception.
      +
      booleanisExhausted() +
      Returns true if this result is exhausted, false otherwise.
      +
      booleanisFalsified() +
      Returns true if this result is falsified, false otherwise.
      +
      booleanisGenException() +
      Returns true if this result is an exception during generating of values for + property checking, false otherwise.
      +
      booleanisPassed() +
      Returns true if this result is passed, false otherwise.
      +
      booleanisPropException() +
      Returns true if this result is an exception during property execution, + false otherwise.
      +
      booleanisProven() +
      Returns true if this result is proven, false otherwise.
      +
      static CheckResultpassed(int succeeded, + int discarded) +
      Returns a result that the property has passed.
      +
      static CheckResultpropException(fj.data.List<Arg<?>> args, + java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that checking the property threw an exception.
      +
      static CheckResultproven(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been proven.
      +
      intsucceeded() +
      Returns the number of succeeded checks of the property in this result.
      +
      static fj.Show<CheckResult>summary(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        summary

        +
        public static final fj.Show<CheckResult> summary
        +
        A rendering of a check result that summarises in one line.
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static final fj.Show<CheckResult> summaryEx
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        passed

        +
        public static CheckResult passed(int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has passed.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has passed.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static CheckResult proven(fj.data.List<Arg<?>> args,
+                                 int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has been proven.
        +
        +
        Parameters:
        +
        args - The arguments used to prove the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been proven.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static CheckResult falsified(fj.data.List<Arg<?>> args,
+                                    int succeeded,
+                                    int discarded)
        +
        Returns a result that the property has been falsified.
        +
        +
        Parameters:
        +
        args - The arguments used to falsify the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been falsified.
        +
        +
        • +
      + + + +
        +
      • +

        exhausted

        +
        public static CheckResult exhausted(int succeeded,
+                                    int discarded)
        +
        Returns a result that the property been exhausted in checking.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been exhausted in checking.
        +
        +
        • +
      + + + +
        +
      • +

        propException

        +
        public static CheckResult propException(fj.data.List<Arg<?>> args,
+                                        java.lang.Throwable ex,
+                                        int succeeded,
+                                        int discarded)
        +
        Returns a result that checking the property threw an exception.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception was thrown.
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that checking the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        genException

        +
        public static CheckResult genException(java.lang.Throwable ex,
+                                       int succeeded,
+                                       int discarded)
        +
        Returns a result that generating values to check the property threw an exception.
        +
        +
        Parameters:
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that generating values to check the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        isPassed

        +
        public boolean isPassed()
        +
        Returns true if this result is passed, false otherwise.
        +
        +
        Returns:
        +
        true if this result is passed, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven, false otherwise.
        +
        +
        Returns:
        +
        true if this result is proven, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified, false otherwise.
        +
        +
        Returns:
        +
        true if this result is falsified, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isExhausted

        +
        public boolean isExhausted()
        +
        Returns true if this result is exhausted, false otherwise.
        +
        +
        Returns:
        +
        true if this result is exhausted, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isPropException

        +
        public boolean isPropException()
        +
        Returns true if this result is an exception during property execution, + false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during property execution, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isGenException

        +
        public boolean isGenException()
        +
        Returns true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        Returns:
        +
        The arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        Returns:
        +
        The execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        • +
      + + + +
        +
      • +

        succeeded

        +
        public int succeeded()
        +
        Returns the number of succeeded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of succeeded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        discarded

        +
        public int discarded()
        +
        Returns the number of discarded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of discarded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        summary

        +
        public static fj.Show<CheckResult> summary(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line.
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line.
        +
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static fj.Show<CheckResult> summaryEx(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line but throws an exception in + the result is a failure (falsified, property exception or generator exception).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Cogen.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Cogen.html new file mode 100644 index 0000000..429661d --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Cogen.html @@ -0,0 +1,2006 @@ + + + + + +Cogen (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Cogen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Cogen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Cogen<A>
+extends java.lang.Object
    +
    Transforms a type and a generator to produce a new generator. This function is used to generate + gen functions.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        cogenBoolean

        +
        public static final Cogen<java.lang.Boolean> cogenBoolean
        +
        A cogen for booleans.
        +
        • +
      + + + +
        +
      • +

        cogenInteger

        +
        public static final Cogen<java.lang.Integer> cogenInteger
        +
        A cogen for integers.
        +
        • +
      + + + +
        +
      • +

        cogenByte

        +
        public static final Cogen<java.lang.Byte> cogenByte
        +
        A cogen for bytes.
        +
        • +
      + + + +
        +
      • +

        cogenShort

        +
        public static final Cogen<java.lang.Short> cogenShort
        +
        A cogen for shorts.
        +
        • +
      + + + +
        +
      • +

        cogenLong

        +
        public static final Cogen<java.lang.Long> cogenLong
        +
        A cogen for longs.
        +
        • +
      + + + +
        +
      • +

        cogenCharacter

        +
        public static final Cogen<java.lang.Character> cogenCharacter
        +
        A cogen for characters.
        +
        • +
      + + + +
        +
      • +

        cogenFloat

        +
        public static final Cogen<java.lang.Float> cogenFloat
        +
        A cogen for floats.
        +
        • +
      + + + +
        +
      • +

        cogenDouble

        +
        public static final Cogen<java.lang.Double> cogenDouble
        +
        A cogen for doubles.
        +
        • +
      + + + +
        +
      • +

        cogenString

        +
        public static final Cogen<java.lang.String> cogenString
        +
        A cogen for strings.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuffer

        +
        public static final Cogen<java.lang.StringBuffer> cogenStringBuffer
        +
        A cogen for string buffers.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuilder

        +
        public static final Cogen<java.lang.StringBuilder> cogenStringBuilder
        +
        A cogen for string builders.
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static final Cogen<java.lang.Throwable> cogenThrowable
        +
        A cogen for throwables.
        +
        • +
      + + + +
        +
      • +

        cogenBitSet

        +
        public static final Cogen<java.util.BitSet> cogenBitSet
        +
        A cogen for bit sets.
        +
        • +
      + + + +
        +
      • +

        cogenCalendar

        +
        public static final Cogen<java.util.Calendar> cogenCalendar
        +
        A cogen for calendars.
        +
        • +
      + + + +
        +
      • +

        cogenDate

        +
        public static final Cogen<java.util.Date> cogenDate
        +
        A cogen for dates.
        +
        • +
      + + + +
        +
      • +

        cogenGregorianCalendar

        +
        public static final Cogen<java.util.GregorianCalendar> cogenGregorianCalendar
        +
        A cogen for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        cogenProperties

        +
        public static final Cogen<java.util.Properties> cogenProperties
        +
        A cogen for properties.
        +
        • +
      + + + +
        +
      • +

        cogenSQLDate

        +
        public static final Cogen<java.sql.Date> cogenSQLDate
        +
        • +
      + + + +
        +
      • +

        cogenTimestamp

        +
        public static final Cogen<java.sql.Timestamp> cogenTimestamp
        +
        • +
      + + + +
        +
      • +

        cogenTime

        +
        public static final Cogen<java.sql.Time> cogenTime
        +
        • +
      + + + +
        +
      • +

        cogenBigInteger

        +
        public static final Cogen<java.math.BigInteger> cogenBigInteger
        +
        • +
      + + + +
        +
      • +

        cogenBigDecimal

        +
        public static final Cogen<java.math.BigDecimal> cogenBigDecimal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Cogen

        +
        public Cogen()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cogen

        +
        public abstract <B> Gen<B> cogen(A a,
+                                 Gen<B> g)
        +
        Transforms the given value and generator to a new generator with a high probability of being + independent.
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A new generator with a high probability of being independent.
        +
        +
        • +
      + + + + + +
        +
      • +

        cogen

        +
        public final <B> fj.F<Gen<B>,Gen<B>> cogen(A a)
        +
        A curried version of cogen(Object, Gen).
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        Returns:
        +
        A curried version of cogen(Object, Gen).
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public final <B> Cogen<B> compose(fj.F<B,A> f)
        +
        Composes the given function with this cogen to produce a new cogen.
        +
        +
        Parameters:
        +
        f - The function to compose.
        +
        Returns:
        +
        A new cogen composed with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <B> Cogen<B> contramap(fj.F<B,A> f)
        +
        Contra-maps this cogen using the given function.
        +
        +
        Parameters:
        +
        f - The function to co-map with.
        +
        Returns:
        +
        A contra-mapped cogen.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF

        +
        public static <A,B> Cogen<fj.F<A,B>> cogenF(Gen<A> a,
+                                            Cogen<B> c)
        +
        A cogen for a function.
        +
        +
        Parameters:
        +
        a - A gen for the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF2

        +
        public static <A,B,C> Cogen<fj.F2<A,B,C>> cogenF2(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Cogen<C> c)
        +
        A cogen for a function-2.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-2.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF3

        +
        public static <A,B,C,D> Cogen<fj.F3<A,B,C,D>> cogenF3(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Cogen<D> c)
        +
        A cogen for a function-3.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-3.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF4

        +
        public static <A,B,C,D,E> Cogen<fj.F4<A,B,C,D,E>> cogenF4(Gen<A> aa,
+                                                          Gen<B> ab,
+                                                          Gen<C> ac,
+                                                          Gen<D> ad,
+                                                          Cogen<E> c)
        +
        A cogen for a function-4.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-4.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF5

        +
        public static <A,B,C,D,E,F$> Cogen<fj.F5<A,B,C,D,E,F$>> cogenF5(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Cogen<F$> c)
        +
        A cogen for a function-5.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-5.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF6

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.F6<A,B,C,D,E,F$,G>> cogenF6(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Cogen<G> c)
        +
        A cogen for a function-6.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-6.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF7

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.F7<A,B,C,D,E,F$,G,H>> cogenF7(Gen<A> aa,
+                                                                        Gen<B> ab,
+                                                                        Gen<C> ac,
+                                                                        Gen<D> ad,
+                                                                        Gen<E> ae,
+                                                                        Gen<F$> af,
+                                                                        Gen<G> ag,
+                                                                        Cogen<H> c)
        +
        A cogen for a function-7.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-7.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Cogen<fj.F8<A,B,C,D,E,F$,G,H,I>> cogenF8(Gen<A> aa,
+                                                                            Gen<B> ab,
+                                                                            Gen<C> ac,
+                                                                            Gen<D> ad,
+                                                                            Gen<E> ae,
+                                                                            Gen<F$> af,
+                                                                            Gen<G> ag,
+                                                                            Gen<H> ah,
+                                                                            Cogen<I> c)
        +
        A cogen for a function-8.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        ah - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-8.
        +
        +
        • +
      + + + +
        +
      • +

        cogenOption

        +
        public static <A> Cogen<fj.data.Option<A>> cogenOption(Cogen<A> ca)
        +
        A cogen for the optional value.
        +
        +
        Parameters:
        +
        ca - A cogen for the type of the optional value.
        +
        Returns:
        +
        A cogen for the optional value.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEither

        +
        public static <A,B> Cogen<fj.data.Either<A,B>> cogenEither(Cogen<A> ca,
+                                                           Cogen<B> cb)
        +
        A cogen for the disjoint union.
        +
        +
        Parameters:
        +
        ca - A cogen for one side of the disjoint union.
        +
        cb - A cogen for one side of the disjoint union.
        +
        Returns:
        +
        A cogen for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        cogenList

        +
        public static <A> Cogen<fj.data.List<A>> cogenList(Cogen<A> ca)
        +
        A cogen for lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the list.
        +
        Returns:
        +
        A cogen for lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStream

        +
        public static <A> Cogen<fj.data.Stream<A>> cogenStream(Cogen<A> ca)
        +
        A cogen for streams.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the stream.
        +
        Returns:
        +
        A cogen for streams.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLcgRng

        +
        public static Cogen<fj.LcgRng> cogenLcgRng()
        +
        A cogen for the provided LcgRng
        +
        +
        Returns:
        +
        A cogen for the provided LcgRng.
        +
        +
        • +
      + + + +
        +
      • +

        cogenState

        +
        public static <S,A> Cogen<fj.data.State<S,A>> cogenState(Gen<S> as,
+                                                         fj.F2<S,A,java.lang.Long> f)
        +
        A cogen for state.
        +
        • +
      + + + +
        +
      • +

        cogenArray

        +
        public static <A> Cogen<fj.data.Array<A>> cogenArray(Cogen<A> ca)
        +
        A cogen for arrays.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array.
        +
        Returns:
        +
        A cogen for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static Cogen<java.lang.Throwable> cogenThrowable(Cogen<java.lang.String> cs)
        +
        A cogen for throwables.
        +
        +
        Parameters:
        +
        cs - A cogen for the throwable message.
        +
        Returns:
        +
        A cogen for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayList

        +
        public static <A> Cogen<java.util.ArrayList<A>> cogenArrayList(Cogen<A> ca)
        +
        A cogen for array lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array list.
        +
        Returns:
        +
        A cogen for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Cogen<java.util.EnumMap<K,V>> cogenEnumMap(Cogen<K> ck,
+                                                                                         Cogen<V> cv)
        +
        A cogen for enum maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumSet

        +
        public static <A extends java.lang.Enum<A>> Cogen<java.util.EnumSet<A>> cogenEnumSet(Cogen<A> c)
        +
        A cogen for enum sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the enum set.
        +
        Returns:
        +
        A cogen for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashMap

        +
        public static <K,V> Cogen<java.util.HashMap<K,V>> cogenHashMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashSet

        +
        public static <A> Cogen<java.util.HashSet<A>> cogenHashSet(Cogen<A> c)
        +
        A cogen for hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the hash set.
        +
        Returns:
        +
        A cogen for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashtable

        +
        public static <K,V> Cogen<java.util.Hashtable<K,V>> cogenHashtable(Cogen<K> ck,
+                                                                   Cogen<V> cv)
        +
        A cogen for hash tables.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenIdentityHashMap

        +
        public static <K,V> Cogen<java.util.IdentityHashMap<K,V>> cogenIdentityHashMap(Cogen<K> ck,
+                                                                               Cogen<V> cv)
        +
        A cogen for identity hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashMap

        +
        public static <K,V> Cogen<java.util.LinkedHashMap<K,V>> cogenLinkedHashMap(Cogen<K> ck,
+                                                                           Cogen<V> cv)
        +
        A cogen for linked hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashSet

        +
        public static <A> Cogen<java.util.LinkedHashSet<A>> cogenLinkedHashSet(Cogen<A> c)
        +
        A cogen for linked hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked hash set.
        +
        Returns:
        +
        A cogen for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedList

        +
        public static <A> Cogen<java.util.LinkedList<A>> cogenLinkedList(Cogen<A> c)
        +
        A cogen for linked lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked list.
        +
        Returns:
        +
        A cogen for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityQueue

        +
        public static <A> Cogen<java.util.PriorityQueue<A>> cogenPriorityQueue(Cogen<A> c)
        +
        A cogen for priority queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority queue.
        +
        Returns:
        +
        A cogen for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStack

        +
        public static <A> Cogen<java.util.Stack<A>> cogenStack(Cogen<A> c)
        +
        A cogen for stacks.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the stack.
        +
        Returns:
        +
        A cogen for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeMap

        +
        public static <K,V> Cogen<java.util.TreeMap<K,V>> cogenTreeMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for tree maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeSet

        +
        public static <A> Cogen<java.util.TreeSet<A>> cogenTreeSet(Cogen<A> c)
        +
        A cogen for tree sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the tree set.
        +
        Returns:
        +
        A cogen for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenVector

        +
        public static <A> Cogen<java.util.Vector<A>> cogenVector(Cogen<A> c)
        +
        A cogen for vectors.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the vector.
        +
        Returns:
        +
        A cogen for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        cogenWeakHashMap

        +
        public static <K,V> Cogen<java.util.WeakHashMap<K,V>> cogenWeakHashMap(Cogen<K> ck,
+                                                                       Cogen<V> cv)
        +
        A cogen for weak hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.ArrayBlockingQueue<A>> cogenArrayBlockingQueue(Cogen<A> c)
        +
        A cogen for array blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the array blocking queue.
        +
        Returns:
        +
        A cogen for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentHashMap

        +
        public static <K,V> Cogen<java.util.concurrent.ConcurrentHashMap<K,V>> cogenConcurrentHashMap(Cogen<K> ck,
+                                                                                              Cogen<V> cv)
        +
        A cogen for concurrent hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentLinkedQueue

        +
        public static <A> Cogen<java.util.concurrent.ConcurrentLinkedQueue<A>> cogenConcurrentLinkedQueue(Cogen<A> c)
        +
        A cogen for concurrent linked queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the concurrent linked queue.
        +
        Returns:
        +
        A cogen for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArrayList

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArrayList<A>> cogenCopyOnWriteArrayList(Cogen<A> c)
        +
        A cogen for copy-on-write array lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array list.
        +
        Returns:
        +
        A cogen for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArraySet

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArraySet<A>> cogenCopyOnWriteArraySet(Cogen<A> c)
        +
        A cogen for copy-on-write array sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array set.
        +
        Returns:
        +
        A cogen for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Cogen<java.util.concurrent.DelayQueue<A>> cogenDelayQueue(Cogen<A> c)
        +
        A cogen for delay queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the delay queue.
        +
        Returns:
        +
        A cogen for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.LinkedBlockingQueue<A>> cogenLinkedBlockingQueue(Cogen<A> c)
        +
        A cogen for linked blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked blocking queue.
        +
        Returns:
        +
        A cogen for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.PriorityBlockingQueue<A>> cogenPriorityBlockingQueue(Cogen<A> c)
        +
        A cogen for priority blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority blocking queue.
        +
        Returns:
        +
        A cogen for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenSynchronousQueue

        +
        public static <A> Cogen<java.util.concurrent.SynchronousQueue<A>> cogenSynchronousQueue(Cogen<A> c)
        +
        A cogen for synchronous queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the synchronous queue.
        +
        Returns:
        +
        A cogen for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP1

        +
        public static <A> Cogen<fj.P1<A>> cogenP1(Cogen<A> ca)
        +
        A cogen for product-1 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-1 is defined.
        +
        Returns:
        +
        A cogen for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP2

        +
        public static <A,B> Cogen<fj.P2<A,B>> cogenP2(Cogen<A> ca,
+                                              Cogen<B> cb)
        +
        A cogen for product-2 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-2 is defined.
        +
        cb - A cogen for one of the types over which the product-2 is defined.
        +
        Returns:
        +
        A cogen for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP3

        +
        public static <A,B,C> Cogen<fj.P3<A,B,C>> cogenP3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc)
        +
        A cogen for product-3 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-3 is defined.
        +
        cb - A cogen for one of the types over which the product-3 is defined.
        +
        cc - A cogen for one of the types over which the product-3 is defined.
        +
        Returns:
        +
        A cogen for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP4

        +
        public static <A,B,C,D> Cogen<fj.P4<A,B,C,D>> cogenP4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd)
        +
        A cogen for product-4 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-4 is defined.
        +
        cb - A cogen for one of the types over which the product-4 is defined.
        +
        cc - A cogen for one of the types over which the product-4 is defined.
        +
        cd - A cogen for one of the types over which the product-4 is defined.
        +
        Returns:
        +
        A cogen for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP5

        +
        public static <A,B,C,D,E> Cogen<fj.P5<A,B,C,D,E>> cogenP5(Cogen<A> ca,
+                                                          Cogen<B> cb,
+                                                          Cogen<C> cc,
+                                                          Cogen<D> cd,
+                                                          Cogen<E> ce)
        +
        A cogen for product-5 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-5 is defined.
        +
        cb - A cogen for one of the types over which the product-5 is defined.
        +
        cc - A cogen for one of the types over which the product-5 is defined.
        +
        cd - A cogen for one of the types over which the product-5 is defined.
        +
        ce - A cogen for one of the types over which the product-5 is defined.
        +
        Returns:
        +
        A cogen for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP6

        +
        public static <A,B,C,D,E,F$> Cogen<fj.P6<A,B,C,D,E,F$>> cogenP6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf)
        +
        A cogen for product-6 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-6 is defined.
        +
        cb - A cogen for one of the types over which the product-6 is defined.
        +
        cc - A cogen for one of the types over which the product-6 is defined.
        +
        cd - A cogen for one of the types over which the product-6 is defined.
        +
        ce - A cogen for one of the types over which the product-6 is defined.
        +
        cf - A cogen for one of the types over which the product-6 is defined.
        +
        Returns:
        +
        A cogen for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP7

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.P7<A,B,C,D,E,F$,G>> cogenP7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg)
        +
        A cogen for product-7 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-7 is defined.
        +
        cb - A cogen for one of the types over which the product-7 is defined.
        +
        cc - A cogen for one of the types over which the product-7 is defined.
        +
        cd - A cogen for one of the types over which the product-7 is defined.
        +
        ce - A cogen for one of the types over which the product-7 is defined.
        +
        cf - A cogen for one of the types over which the product-7 is defined.
        +
        cg - A cogen for one of the types over which the product-7 is defined.
        +
        Returns:
        +
        A cogen for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP8

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.P8<A,B,C,D,E,F$,G,H>> cogenP8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch)
        +
        A cogen for product-8 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-8 is defined.
        +
        cb - A cogen for one of the types over which the product-8 is defined.
        +
        cc - A cogen for one of the types over which the product-8 is defined.
        +
        cd - A cogen for one of the types over which the product-8 is defined.
        +
        ce - A cogen for one of the types over which the product-8 is defined.
        +
        cf - A cogen for one of the types over which the product-8 is defined.
        +
        cg - A cogen for one of the types over which the product-8 is defined.
        +
        ch - A cogen for one of the types over which the product-8 is defined.
        +
        Returns:
        +
        A cogen for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Gen.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Gen.html new file mode 100644 index 0000000..bb82baf --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Gen.html @@ -0,0 +1,1497 @@ + + + + + +Gen (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Gen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Gen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Gen<A>
+extends java.lang.Object
    +

    A generator for values of the type of the given type parameter (A). Generation + of a value accepts a general 'size' argument (integer), a random generator and + returns an optional value of the type parameter. Several generators are provided, + allowing various forms of composition of generators.

    A user typically creates an arbitrary to return a generator using the 'combinator methods' below. For example, + suppose a class Person: +

    +class Person {
+  final int age;
+  final String name;
+  final boolean male;
+
+  Person(final int age, final String name, final boolean male) {
+    this.age = age;
+    this.name = name;
+    this.male = male;
+  }
+}
+
    +

    In a case like this one, a user may create a generator over Person by + invoking the bind(F) methods — in this case, bind(Gen , Gen , F) the one + that takes two generator arguments}, since the class has one more than two fields (the bind + method is invoked on a generator adding the extra one to the count as they are composed). The + class fields are of types for which there exist generators (on Gen so those can be + used to compose a generator for Person:

    +
    +static Gen<Person> personArbitrary() {
+  return arbInteger.bind(arbString(), arbBoolean(),
+      // compose the generators
+      {int age => {String name => {boolean male => new Person(age, name, male)}}};
+}
+
    +

    + The example above uses Java 7 closure syntax. Here is the same example using objects instead: +

    +static Gen<Person> personArbitrary() {
+  return arbInteger.bind(arbString, arbBoolean,
+      // compose the generators
+      new F<Integer, F<String, F<Boolean, Person>>>() {
+        public F<String, F<Boolean, Person>> f(final Integer age) {
+          return new F<String, F<Boolean, Person>>() {
+            public F<Boolean, Person> f(final String name) {
+              return new F<Boolean, Person>() {
+                public Person f(final Boolean male) {
+                  return new Person(age, name, male);
+                }
+              };
+            }
+          };
+        }
+      });
+}
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      <B> Gen<B>apply(Gen<fj.F<A,B>> gf) +
      Function application within this generator to produce a new generator.
      +
      <B> Gen<B>bind(fj.F<A,Gen<B>> f) +
      Binds the given function across this generator to produce a new generator.
      +
      <B,C> Gen<C>bind(Gen<B> gb, + fj.F<A,fj.F<B,C>> f) +
      Binds the given function across this generator and the given generator to produce a new + generator.
      +
      <B,C,D> Gen<D>bind(Gen<B> gb, + Gen<C> gc, + fj.F<A,fj.F<B,fj.F<C,D>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E> Gen<E>bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$>
      Gen<F$>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G>
      Gen<G>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H>
      Gen<H>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H,I>
      Gen<I>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + Gen<H> gh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      static Gen<java.lang.Double>choose(double from, + double to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Integer>choose(int from, + int to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Long>choose(long from, + long to) 
      static <A> Gen<fj.data.List<A>>combinationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<A>elements(A... as) +
      Returns a generator that produces values from the given arguments.
      +
      static <A> Gen<A>elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as) +
      Returns a generator that produces values from the given frequency and value pairs.
      +
      static <A> Gen<A>fail() +
      Returns a generator that never returns a value.
      +
      Gen<A>filter(fj.F<A,java.lang.Boolean> f) +
      Returns a generator that produces values that meet the given predicate.
      +
      fj.Unitforeach(java.lang.Integer i, + Rand r, + fj.F<A,fj.Unit> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      voidforeachDoEffect(java.lang.Integer i, + Rand r, + fj.function.Effect1<A> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      static <A> Gen<A>frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs) +
      Returns a generator that uses values from the given frequency and generator pairs.
      +
      static <A> Gen<A>gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f) +
      Returns a generator that uses the given function.
      +
      Agen(int i, + Rand r) +
      Applies the given size and random generator to produce a value.
      +
      static <A> Gen<A>join(Gen<Gen<A>> g) +
      Joins the generator of generators through a bind(F) operation.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g, + int x) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf1(Gen<A> g) +
      Returns a generator of non empty lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOfSorted(Gen<A> g, + int x, + fj.Ord<A> ord) 
      <B> Gen<B>map(fj.F<A,B> f) +
      Maps the given function across this generator.
      +
      static <A> Gen<A>oneOf(fj.data.List<Gen<A>> gs) +
      Returns a generator that produces values from one of the given generators on subsequent + requests.
      +
      static <A> Gen<A>parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f) +
      Constructs a generator that can access its construction arguments — size and random + generator.
      +
      static <A> Gen<fj.data.List<A>>permutationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<fj.data.List<A>>pick(int n, + fj.data.List<A> as) +
      Deprecated.  +
      As of release 4.6, use combinationOf(int, fj.data.List<A>)
      +
      +
      static <A> Gen<A>pickOne(fj.data.List<A> as) +
      Returns a generator that picks one element from the given list.
      +
      static <A,B> Gen<fj.F<A,B>>promote(fj.F<A,Gen<B>> f) +
      Promotes the given function to a generator for functions.
      +
      Gen<A>resize(int s) +
      Resizes this generator with the given size.
      +
      static <A> Gen<fj.data.List<A>>selectionOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<fj.data.List<A>>sequence(fj.data.List<Gen<A>> gs) +
      Sequence the given generators through a bind(F) operation.
      +
      static <A> Gen<fj.data.List<A>>sequenceN(int n, + Gen<A> g) +
      Sequences the given generator the given number of times through a bind(F) operation.
      +
      static <A> Gen<A>sized(fj.F<java.lang.Integer,Gen<A>> f) +
      Constructs a generator that can access its size construction arguments.
      +
      static <A> Gen<fj.data.List<A>>someCombinationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someOf(fj.data.List<A> as) +
      Deprecated.  +
      As of release 4.6, use someCombinationOf(fj.data.List<A>)
      +
      +
      static <A> Gen<fj.data.List<A>>somePermutationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someSelectionOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someWordOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<A>value(A a) +
      Returns a generator that always produces the given value.
      +
      static <A> Gen<fj.data.List<A>>wordOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        gen

        +
        public A gen(int i,
+             Rand r)
        +
        Applies the given size and random generator to produce a value.
        +
        +
        Parameters:
        +
        i - The size to use to produce the value.
        +
        r - The random generator to use to produce the value..
        +
        Returns:
        +
        A generated value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Gen<B> map(fj.F<A,B> f)
        +
        Maps the given function across this generator.
        +
        +
        Parameters:
        +
        f - The function to map across this generator.
        +
        Returns:
        +
        A new generator after applying the mapping function.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Gen<A> filter(fj.F<A,java.lang.Boolean> f)
        +
        Returns a generator that produces values that meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to meet for the values produced by the generator.
        +
        Returns:
        +
        A generator that produces values that meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public fj.Unit foreach(java.lang.Integer i,
+                       Rand r,
+                       fj.F<A,fj.Unit> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(java.lang.Integer i,
+                            Rand r,
+                            fj.function.Effect1<A> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Gen<B> bind(fj.F<A,Gen<B>> f)
        +
        Binds the given function across this generator to produce a new generator.
        +
        +
        Parameters:
        +
        f - The function to bind across this generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Gen<C> bind(Gen<B> gb,
+                         fj.F<A,fj.F<B,C>> f)
        +
        Binds the given function across this generator and the given generator to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Gen<D> bind(Gen<B> gb,
+                           Gen<C> gc,
+                           fj.F<A,fj.F<B,fj.F<C,D>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E> Gen<E> bind(Gen<B> gb,
+                             Gen<C> gc,
+                             Gen<D> gd,
+                             fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$> Gen<F$> bind(Gen<B> gb,
+                                 Gen<C> gc,
+                                 Gen<D> gd,
+                                 Gen<E> ge,
+                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G> Gen<G> bind(Gen<B> gb,
+                                  Gen<C> gc,
+                                  Gen<D> gd,
+                                  Gen<E> ge,
+                                  Gen<F$> gf,
+                                  fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H> Gen<H> bind(Gen<B> gb,
+                                    Gen<C> gc,
+                                    Gen<D> gd,
+                                    Gen<E> ge,
+                                    Gen<F$> gf,
+                                    Gen<G> gg,
+                                    fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H,I> Gen<I> bind(Gen<B> gb,
+                                      Gen<C> gc,
+                                      Gen<D> gd,
+                                      Gen<E> ge,
+                                      Gen<F$> gf,
+                                      Gen<G> gg,
+                                      Gen<H> gh,
+                                      fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        gh - The eighth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Gen<B> apply(Gen<fj.F<A,B>> gf)
        +
        Function application within this generator to produce a new generator.
        +
        +
        Parameters:
        +
        gf - The generator over the function to apply to this generator.
        +
        Returns:
        +
        A new generator after function application.
        +
        +
        • +
      + + + +
        +
      • +

        resize

        +
        public Gen<A> resize(int s)
        +
        Resizes this generator with the given size.
        +
        +
        Parameters:
        +
        s - The new size of the generator.
        +
        Returns:
        +
        A new generator that uses the given size.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public static <A> Gen<A> gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f)
        +
        Returns a generator that uses the given function.
        +
        +
        Parameters:
        +
        f - The function to use for this generator.
        +
        Returns:
        +
        A new generator that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Gen<fj.data.List<A>> sequence(fj.data.List<Gen<A>> gs)
        +
        Sequence the given generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        gs - The generators to sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generators.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceN

        +
        public static <A> Gen<fj.data.List<A>> sequenceN(int n,
+                                                 Gen<A> g)
        +
        Sequences the given generator the given number of times through a bind(F) operation.
        +
        +
        Parameters:
        +
        n - The number of times to sequence the given generator.
        +
        g - The generator sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        parameterised

        +
        public static <A> Gen<A> parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f)
        +
        Constructs a generator that can access its construction arguments — size and random + generator.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its arguments.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + +
        +
      • +

        sized

        +
        public static <A> Gen<A> sized(fj.F<java.lang.Integer,Gen<A>> f)
        +
        Constructs a generator that can access its size construction arguments.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its size argument.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <A> Gen<A> value(A a)
        +
        Returns a generator that always produces the given value.
        +
        +
        Parameters:
        +
        a - The value to always produce.
        +
        Returns:
        +
        A generator that always produces the given value.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Integer> choose(int from,
+                                            int to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces values between the given range (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Long> choose(long from,
+                                         long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Double> choose(double from,
+                                           double to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces v
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public static <A> Gen<A> fail()
        +
        Returns a generator that never returns a value.
        +
        +
        Returns:
        +
        A generator that never returns a value.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Gen<A> join(Gen<Gen<A>> g)
        +
        Joins the generator of generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        g - The generator of generators to join.
        +
        Returns:
        +
        A new generator after joining the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        frequency

        +
        public static <A> Gen<A> frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs)
        +
        Returns a generator that uses values from the given frequency and generator pairs. The returned + generator will produce values from the generator in a pair with a higher frequency than a lower + frequency generator.
        +
        +
        Parameters:
        +
        gs - The pairs of frequency and generator from which to return values in the returned + generator.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and generator.
        +
        +
        • +
      + + + +
        +
      • +

        elemFrequency

        +
        public static <A> Gen<A> elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as)
        +
        Returns a generator that produces values from the given frequency and value pairs. The returned + generator will produce the value with a higher frequency than a lower one.
        +
        +
        Parameters:
        +
        as - The pairs of frequency and value from which to produce values.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and value.
        +
        +
        • +
      + + + + + +
        +
      • +

        elements

        +
        @SafeVarargs
+public static <A> Gen<A> elements(A... as)
        +
        Returns a generator that produces values from the given arguments.
        +
        +
        Parameters:
        +
        as - The values that the returned generator may produce.
        +
        Returns:
        +
        A generator that produces values from the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        oneOf

        +
        public static <A> Gen<A> oneOf(fj.data.List<Gen<A>> gs)
        +
        Returns a generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        Parameters:
        +
        gs - The list of generators to produce a value from.
        +
        Returns:
        +
        A generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g,
+                                              int x)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        x - An adjuster of size to apply to the given generator when producing values.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOfSorted

        +
        public static <A> Gen<fj.data.List<A>> listOfSorted(Gen<A> g,
+                                                    int x,
+                                                    fj.Ord<A> ord)
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOf1

        +
        public static <A> Gen<fj.data.List<A>> listOf1(Gen<A> g)
        +
        Returns a generator of non empty lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        pickOne

        +
        public static <A> Gen<A> pickOne(fj.data.List<A> as)
        +
        Returns a generator that picks one element from the given list. If the given list is empty, then the + returned generator will never produce a value.
        +
        +
        Parameters:
        +
        as - The list from which to pick an element.
        +
        Returns:
        +
        A generator that picks an element from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        pick

        +
        @Deprecated
+public static <A> Gen<fj.data.List<A>> pick(int n,
+                                                        fj.data.List<A> as)
        +
        Deprecated. As of release 4.6, use combinationOf(int, fj.data.List<A>)
        +
        Returns a generator of lists that picks the given number of elements from the given list. If + the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value. +

        + Note: pick is synonymous with combinationOf

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        combinationOf

        +
        public static <A> Gen<fj.data.List<A>> combinationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        selectionOf

        +
        public static <A> Gen<fj.data.List<A>> selectionOf(int n,
+                                                   fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        permutationOf

        +
        public static <A> Gen<fj.data.List<A>> permutationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        wordOf

        +
        public static <A> Gen<fj.data.List<A>> wordOf(int n,
+                                              fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someOf

        +
        @Deprecated
+public static <A> Gen<fj.data.List<A>> someOf(fj.data.List<A> as)
        +
        Deprecated. As of release 4.6, use someCombinationOf(fj.data.List<A>)
        +
        Returns a generator of lists that produces some of the values of the given list. +

        + Note: someOf is synonymous with someCombinationOf

        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someCombinationOf

        +
        public static <A> Gen<fj.data.List<A>> someCombinationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someSelectionOf

        +
        public static <A> Gen<fj.data.List<A>> someSelectionOf(int maxLength,
+                                                       fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somePermutationOf

        +
        public static <A> Gen<fj.data.List<A>> somePermutationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someWordOf

        +
        public static <A> Gen<fj.data.List<A>> someWordOf(int maxLength,
+                                                  fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        promote

        +
        public static <A,B> Gen<fj.F<A,B>> promote(fj.F<A,Gen<B>> f)
        +
        Promotes the given function to a generator for functions.
        +
        +
        Parameters:
        +
        f - The function to promote to a generator of functions.
        +
        Returns:
        +
        A generator for functions.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Property.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Property.html new file mode 100644 index 0000000..fe15a8d --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Property.html @@ -0,0 +1,2514 @@ + + + + + +Property (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Property

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Property
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Property
+extends java.lang.Object
    +
    Represents an algebraic property about a program that may be checked for its truth value. For example, it is true that "for all integers (call it x) and + for all integers (call it y), then x + y is equivalent to y + x". This statement is a (algebraic) + property, proposition or theorem that, when checked, will at least (depending on arguments) fail + to be falsified — since there does not exist a counter-example to this statement.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Propertyand(Property p) +
      Performs a conjunction of this property with the given property.
      +
      CheckResultcheck() +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(int minSize, + int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
      +
      CheckResultcheck(int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using a standard random generator and the given + arguments to produce a result.
      +
      CheckResultcheck(Rand r) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(Rand r, + int minSize, + int maxSize) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
      +
      CheckResultcheck(Rand r, + int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using the given arguments and produces a result.
      +
      static Propertyexception(fj.F0<Property> p) +
      Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
      +
      static <A> Propertyforall(Gen<A> g, + Shrink<A> shrink, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static PropertyfromGen(Gen<Result> g) +
      Constructs a property from a generator of results.
      +
      Gen<Result>gen() +
      Returns a generator of results from this property.
      +
      static Propertyimplies(boolean b, + fj.F0<Property> p) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + boolean b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + fj.F0<java.lang.Boolean> b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      CheckResultmaxDiscarded(int maxDiscarded) +
      Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxDiscarded(Rand r, + int maxDiscarded) +
      Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxSize(int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultmaxSize(Rand r, + int maxSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultminSize(int minSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSize(Rand r, + int minSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSuccessful(int minSuccessful) +
      Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultminSuccessful(Rand r, + int minSuccessful) +
      Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      Propertyor(Property p) +
      Performs a disjunction of this property with the given property.
      +
      static Propertyprop(boolean b) +
      Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
      +
      static Propertyprop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f) +
      Returns a property from the given function.
      +
      Resultprop(int i, + Rand r) +
      Returns the result of applying the given size and random generator.
      +
      static Propertyprop(Result r) +
      Returns a property that always has the given result.
      +
      static <A> Propertyproperty(Gen<A> aa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> Propertyproperty(Gen<A> aa, + Shrink<A> sa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + Shrink<A> sa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      Propertysequence(Property p) +
      Performs a sequence of this property with the given property.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        prop

        +
        public Result prop(int i,
+                   Rand r)
        +
        Returns the result of applying the given size and random generator.
        +
        +
        Parameters:
        +
        i - The size to use to obtain a result.
        +
        r - The random generator to use to obtain a result.
        +
        Returns:
        +
        The result of applying the given size and random generator.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public Gen<Result> gen()
        +
        Returns a generator of results from this property.
        +
        +
        Returns:
        +
        A generator of results from this property.
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Property and(Property p)
        +
        Performs a conjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the conjunction with.
        +
        Returns:
        +
        A conjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Property or(Property p)
        +
        Performs a disjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the disjunction with.
        +
        Returns:
        +
        A disjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public Property sequence(Property p)
        +
        Performs a sequence of this property with the given property. The returned property holds if + and only if this property and the given property also hold. If one property does not hold, but + the other does, then the returned property will produce the same result and the property that + holds.
        +
        +
        Parameters:
        +
        p - The property to sequence this property with.
        +
        Returns:
        +
        A sequence of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given arguments and produces a result.
        +
        +
        Parameters:
        +
        r - The random generator to use for checking.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator and the given + arguments to produce a result.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check()
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(int minSuccessful)
        +
        Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(Rand r,
+                                 int minSuccessful)
        +
        Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(int maxDiscarded)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(Rand r,
+                                int maxDiscarded)
        +
        Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(int minSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(Rand r,
+                           int minSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(Rand r,
+                           int maxSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static Property implies(boolean b,
+                               fj.F0<Property> p)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given property.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, produces the given property.
        +
        p - The property to return if the condition satisfies.
        +
        Returns:
        +
        A property that produces a result only if the given condition satisfies.
        +
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      boolean b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given boolean b.
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      fj.F0<java.lang.Boolean> b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given lazy boolean b.
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f)
        +
        Returns a property from the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the returned property with.
        +
        Returns:
        +
        A property from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(Result r)
        +
        Returns a property that always has the given result.
        +
        +
        Parameters:
        +
        r - The result of the returned property.
        +
        Returns:
        +
        A property that always has the given result.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(boolean b)
        +
        Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, returns a property that is proven; otherwise, the + property is falsified.
        +
        Returns:
        +
        A property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fromGen

        +
        public static Property fromGen(Gen<Result> g)
        +
        Constructs a property from a generator of results.
        +
        +
        Parameters:
        +
        g - The generator of results to constructor a property with.
        +
        Returns:
        +
        A property from a generator of results.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public static <A> Property forall(Gen<A> g,
+                                  Shrink<A> shrink,
+                                  fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        g - The generator to produces values from to produce the property with.
        +
        shrink - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     Shrink<A> sa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    Shrink<A> sa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Property exception(fj.F0<Property> p)
        +
        Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        Parameters:
        +
        p - A property to evaluate to check for an exception.
        +
        Returns:
        +
        A property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Rand.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Rand.html new file mode 100644 index 0000000..528a4ba --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Rand.html @@ -0,0 +1,468 @@ + + + + + +Rand (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Rand

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Rand
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Rand
+extends java.lang.Object
    +
    A random number generator.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Randstandard +
      A standard random generator that uses Random.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      doublechoose(double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      doublechoose(long seed, + double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(long seed, + int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      longchoose(long from, + long to) 
      static Randrand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f, + fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g) +
      Deprecated.  +
      As of release 4.6, use rand(F, F, F).
      +
      +
      static Randrand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f, + fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g, + fj.F<java.lang.Long,Rand> onReseed) +
      Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
      +
      Randreseed(long seed) +
      Gives this random generator a new seed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        standard

        +
        public static final Rand standard
        +
        A standard random generator that uses Random.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        choose

        +
        public int choose(long seed,
+                  int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public int choose(int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public long choose(long from,
+                   long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(long seed,
+                     double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        reseed

        +
        public Rand reseed(long seed)
        +
        Gives this random generator a new seed.
        +
        +
        Parameters:
        +
        seed - The seed of the new random generator.
        +
        Returns:
        +
        A random generator with the given seed.
        +
        +
        • +
      + + + +
        +
      • +

        rand

        +
        @Deprecated
+public static Rand rand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f,
+                                    fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g)
        +
        Deprecated. As of release 4.6, use rand(F, F, F).
        +
        Constructs a random generator from the given functions that supply a range to produce a + result. +

        + Calling reseed(long) on an instance returned from this method will + result in an exception being thrown.

        +
        +
        Parameters:
        +
        f - The integer random generator.
        +
        g - The floating-point random generator.
        +
        Returns:
        +
        A random generator from the given functions that supply a range to produce a result.
        +
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public static Rand rand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f,
+                        fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g,
+                        fj.F<java.lang.Long,Rand> onReseed)
        +
        Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
        +
        +
        Parameters:
        +
        f - The integer random generator.
        +
        g - The floating-point random generator.
        +
        onReseed - Function to create a reseeded Rand.
        +
        Returns:
        +
        A random generator from the given functions that supply a range to produce a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Result.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Result.html new file mode 100644 index 0000000..54b4949 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Result.html @@ -0,0 +1,610 @@ + + + + + +Result (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Result

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Result
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Result
+extends java.lang.Object
    +
    The result of evaluating a property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      ResultaddArg(Arg<?> a) +
      Adds an argument to this result.
      +
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the potential arguments associated with this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the potential exception associated with this result.
      +
      static Resultexception(fj.data.List<Arg<?>> args, + java.lang.Throwable t) +
      Returns an exception result.
      +
      booleanfailed() +
      Returns true if this result is falsified or an exception; otherwise, + false.
      +
      static Resultfalsified(fj.data.List<Arg<?>> args) +
      Returns a falsified result.
      +
      booleanisException() +
      Returns true if this result is an exception; otherwise, false.
      +
      booleanisFalsified() +
      Returns true if this result is falsified; otherwise, false.
      +
      booleanisNoResult() +
      Returns true if this result is no result; otherwise, false.
      +
      booleanisProven() +
      Returns true if this result is proven; otherwise, false.
      +
      booleanisUnfalsified() +
      Returns true if this result is unfalsified; otherwise, false.
      +
      static ResultnoResult() +
      Returns a result representing no result.
      +
      static ResultnoResult(fj.data.Option<Result> r) +
      Returns a result from the given potential result.
      +
      booleanpassed() +
      Returns true if this result is unfalsified or proven; otherwise, + false.
      +
      static Resultproven(fj.data.List<Arg<?>> args) +
      Returns a proven result.
      +
      ResultprovenAsUnfalsified() +
      If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
      +
      fj.data.Option<Result>toOption() +
      Returns a potential result for this result.
      +
      static Resultunfalsified(fj.data.List<Arg<?>> args) +
      Returns an unfalsified result.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the potential arguments associated with this result. This will only have a value, if + and only if !noResult() holds.
        +
        +
        Returns:
        +
        The potential arguments associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the potential exception associated with this result. This will only have a value if and + only if this result is an exception result.
        +
        +
        Returns:
        +
        The potential exception associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        isUnfalsified

        +
        public boolean isUnfalsified()
        +
        Returns true if this result is unfalsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is unfalsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is falsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is proven; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isException

        +
        public boolean isException()
        +
        Returns true if this result is an exception; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is an exception; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isNoResult

        +
        public boolean isNoResult()
        +
        Returns true if this result is no result; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is no result; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        failed

        +
        public boolean failed()
        +
        Returns true if this result is falsified or an exception; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is falsified or an exception; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        passed

        +
        public boolean passed()
        +
        Returns true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        provenAsUnfalsified

        +
        public Result provenAsUnfalsified()
        +
        If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
        +
        +
        Returns:
        +
        If this result is proven, alter it to be unfalsified with the same arguments; + otherwise, return this.
        +
        +
        • +
      + + + +
        +
      • +

        addArg

        +
        public Result addArg(Arg<?> a)
        +
        Adds an argument to this result.
        +
        +
        Parameters:
        +
        a - The argument to add.
        +
        Returns:
        +
        A result with the new argument.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public fj.data.Option<Result> toOption()
        +
        Returns a potential result for this result. This will have a value if this result is + !noResult().
        +
        +
        Returns:
        +
        A potential result for this result.
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult(fj.data.Option<Result> r)
        +
        Returns a result from the given potential result.
        +
        +
        Parameters:
        +
        r - The potential result.
        +
        Returns:
        +
        The result that may be noResult().
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult()
        +
        Returns a result representing no result.
        +
        +
        Returns:
        +
        A result representing no result.
        +
        +
        • +
      + + + +
        +
      • +

        unfalsified

        +
        public static Result unfalsified(fj.data.List<Arg<?>> args)
        +
        Returns an unfalsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during the failure of falsification.
        +
        Returns:
        +
        An unfalsified result.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static Result falsified(fj.data.List<Arg<?>> args)
        +
        Returns a falsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during falsification.
        +
        Returns:
        +
        A falsified result.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static Result proven(fj.data.List<Arg<?>> args)
        +
        Returns a proven result.
        +
        +
        Parameters:
        +
        args - The arguments used during proof.
        +
        Returns:
        +
        A proven result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Result exception(fj.data.List<Arg<?>> args,
+                               java.lang.Throwable t)
        +
        Returns an exception result.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception occurred.
        +
        t - The exception that occurred.
        +
        Returns:
        +
        A exception result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Shrink.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Shrink.html new file mode 100644 index 0000000..26c9688 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Shrink.html @@ -0,0 +1,1680 @@ + + + + + +Shrink (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Shrink<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Shrink<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Shrink<A>
+extends java.lang.Object
    +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure. This is used in falsification to produce the smallest counter-example, rather + than the first counter-example.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        shrinkLong

        +
        public static final Shrink<java.lang.Long> shrinkLong
        +
        A shrink strategy for longs using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkBoolean

        +
        public static final Shrink<java.lang.Boolean> shrinkBoolean
        +
        A shrink strategy for booleans using false as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkInteger

        +
        public static final Shrink<java.lang.Integer> shrinkInteger
        +
        A shrink strategy for integers using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkByte

        +
        public static final Shrink<java.lang.Byte> shrinkByte
        +
        A shrink strategy for bytes using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkCharacter

        +
        public static final Shrink<java.lang.Character> shrinkCharacter
        +
        A shrink strategy for characters using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkShort

        +
        public static final Shrink<java.lang.Short> shrinkShort
        +
        A shrink strategy for shorts using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkFloat

        +
        public static final Shrink<java.lang.Float> shrinkFloat
        +
        A shrink strategy for floats using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkDouble

        +
        public static final Shrink<java.lang.Double> shrinkDouble
        +
        A shrink strategy for doubles using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkString

        +
        public static final Shrink<java.lang.String> shrinkString
        +
        A shrink strategy for strings using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuffer

        +
        public static final Shrink<java.lang.StringBuffer> shrinkStringBuffer
        +
        A shrink strategy for string buffers using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuilder

        +
        public static final Shrink<java.lang.StringBuilder> shrinkStringBuilder
        +
        A shrink strategy for string builders using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static final Shrink<java.lang.Throwable> shrinkThrowable
        +
        A shrink strategy for throwables.
        +
        • +
      + + + +
        +
      • +

        shrinkBitSet

        +
        public static final Shrink<java.util.BitSet> shrinkBitSet
        +
        A shrink strategy for bit sets.
        +
        • +
      + + + +
        +
      • +

        shrinkCalendar

        +
        public static final Shrink<java.util.Calendar> shrinkCalendar
        +
        A shrink strategy for calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkDate

        +
        public static final Shrink<java.util.Date> shrinkDate
        +
        A shrink strategy for dates.
        +
        • +
      + + + +
        +
      • +

        shrinkGregorianCalendar

        +
        public static final Shrink<java.util.GregorianCalendar> shrinkGregorianCalendar
        +
        A shrink strategy for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkProperties

        +
        public static final Shrink<java.util.Properties> shrinkProperties
        +
        A shrink strategy for properties.
        +
        • +
      + + + +
        +
      • +

        shrinkSQLDate

        +
        public static final Shrink<java.sql.Date> shrinkSQLDate
        +
        A shrink strategy for SQL dates.
        +
        • +
      + + + +
        +
      • +

        shrinkTime

        +
        public static final Shrink<java.sql.Time> shrinkTime
        +
        A shrink strategy for SQL times.
        +
        • +
      + + + +
        +
      • +

        shrinkTimestamp

        +
        public static final Shrink<java.sql.Timestamp> shrinkTimestamp
        +
        A shrink strategy for SQL timestamps.
        +
        • +
      + + + +
        +
      • +

        shrinkBigInteger

        +
        public static final Shrink<java.math.BigInteger> shrinkBigInteger
        +
        A shrink strategy for big integers.
        +
        • +
      + + + +
        +
      • +

        shrinkBigDecimal

        +
        public static final Shrink<java.math.BigDecimal> shrinkBigDecimal
        +
        A shrink strategy for big decimals.
        +
        • +
      + + + +
        +
      • +

        shrinkNatural

        +
        public static final Shrink<fj.data.Natural> shrinkNatural
        +
        A shrink strategy for naturals.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        shrink

        +
        public fj.data.Stream<A> shrink(A a)
        +
        Returns a shrink of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to shrink.
        +
        Returns:
        +
        A shrink of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Shrink<B> map(fj.F<A,B> f,
+                         fj.F<B,A> g)
        +
        Creates a shrink from this shrink and the given symmetric transformations.
        +
        +
        Parameters:
        +
        f - A transformation from this shrink type to the new shrink type.
        +
        g - A transformation from the new shrink type to this shrink type.
        +
        Returns:
        +
        A shrink from this shrink and the given symmetric transformations.
        +
        +
        • +
      + + + +
        +
      • +

        shrink

        +
        public static <A> Shrink<A> shrink(fj.F<A,fj.data.Stream<A>> f)
        +
        Constructs a shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        Parameters:
        +
        f - A function that produces a tree of values given a value.
        +
        Returns:
        +
        A shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Shrink<A> empty()
        +
        Returns a shrink strategy that cannot be reduced further.
        +
        +
        Returns:
        +
        A shrink strategy that cannot be reduced further.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkOption

        +
        public static <A> Shrink<fj.data.Option<A>> shrinkOption(Shrink<A> sa)
        +
        Returns a shrink strategy for optional values. A 'no value' is already fully + shrunk, otherwise, the shrinking occurs on the value with the given shrink strategy.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the potential value.
        +
        Returns:
        +
        A shrink strategy for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEither

        +
        public static <A,B> Shrink<fj.data.Either<A,B>> shrinkEither(Shrink<A> sa,
+                                                             Shrink<B> sb)
        +
        Returns a shrink strategy for either values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for left values.
        +
        sb - The shrinking strategy for right values.
        +
        Returns:
        +
        A shrink strategy for either values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkList

        +
        public static <A> Shrink<fj.data.List<A>> shrinkList(Shrink<A> sa)
        +
        Returns a shrink strategy for lists. An empty list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the list.
        +
        Returns:
        +
        A shrink strategy for lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArray

        +
        public static <A> Shrink<fj.data.Array<A>> shrinkArray(Shrink<A> sa)
        +
        Returns a shrink strategy for arrays. An empty array is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array.
        +
        Returns:
        +
        A shrink strategy for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStream

        +
        public static <A> Shrink<fj.data.Stream<A>> shrinkStream(Shrink<A> sa)
        +
        Returns a shrink strategy for streams. An empty stream is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the stream.
        +
        Returns:
        +
        A shrink strategy for streams.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static Shrink<java.lang.Throwable> shrinkThrowable(Shrink<java.lang.String> ss)
        +
        A shrink strategy for throwables.
        +
        +
        Parameters:
        +
        ss - A shrink strategy for throwable messages.
        +
        Returns:
        +
        A shrink strategy for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayList

        +
        public static <A> Shrink<java.util.ArrayList<A>> shrinkArrayList(Shrink<A> sa)
        +
        Returns a shrink strategy for array lists. An empty array list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array list.
        +
        Returns:
        +
        A shrink strategy for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Shrink<java.util.EnumMap<K,V>> shrinkEnumMap(Shrink<K> sk,
+                                                                                           Shrink<V> sv)
        +
        A shrink strategy for enum maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumSet

        +
        public static <A extends java.lang.Enum<A>> Shrink<java.util.EnumSet<A>> shrinkEnumSet(Shrink<A> sa)
        +
        A shrink strategy for enum sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashMap

        +
        public static <K,V> Shrink<java.util.HashMap<K,V>> shrinkHashMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashSet

        +
        public static <A> Shrink<java.util.HashSet<A>> shrinkHashSet(Shrink<A> sa)
        +
        A shrink strategy for hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashtable

        +
        public static <K,V> Shrink<java.util.Hashtable<K,V>> shrinkHashtable(Shrink<K> sk,
+                                                                     Shrink<V> sv)
        +
        A shrink strategy for hash tables.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkIdentityHashMap

        +
        public static <K,V> Shrink<java.util.IdentityHashMap<K,V>> shrinkIdentityHashMap(Shrink<K> sk,
+                                                                                 Shrink<V> sv)
        +
        A shrink strategy for identity hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashMap

        +
        public static <K,V> Shrink<java.util.LinkedHashMap<K,V>> shrinkLinkedHashMap(Shrink<K> sk,
+                                                                             Shrink<V> sv)
        +
        A shrink strategy for linked hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashSet

        +
        public static <A> Shrink<java.util.LinkedHashSet<A>> shrinkLinkedHashSet(Shrink<A> sa)
        +
        A shrink strategy for linked hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedList

        +
        public static <A> Shrink<java.util.LinkedList<A>> shrinkLinkedList(Shrink<A> sa)
        +
        A shrink strategy for linked lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityQueue

        +
        public static <A> Shrink<java.util.PriorityQueue<A>> shrinkPriorityQueue(Shrink<A> sa)
        +
        A shrink strategy for priority queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStack

        +
        public static <A> Shrink<java.util.Stack<A>> shrinkStack(Shrink<A> sa)
        +
        A shrink strategy for stacks.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeMap

        +
        public static <K,V> Shrink<java.util.TreeMap<K,V>> shrinkTreeMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for tree maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeSet

        +
        public static <A> Shrink<java.util.TreeSet<A>> shrinkTreeSet(Shrink<A> sa)
        +
        A shrink strategy for tree sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkVector

        +
        public static <A> Shrink<java.util.Vector<A>> shrinkVector(Shrink<A> sa)
        +
        A shrink strategy for vectors.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkWeakHashMap

        +
        public static <K,V> Shrink<java.util.WeakHashMap<K,V>> shrinkWeakHashMap(Shrink<K> sk,
+                                                                         Shrink<V> sv)
        +
        A shrink strategy for weak hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.ArrayBlockingQueue<A>> shrinkArrayBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for array blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentHashMap

        +
        public static <K,V> Shrink<java.util.concurrent.ConcurrentHashMap<K,V>> shrinkConcurrentHashMap(Shrink<K> sk,
+                                                                                                Shrink<V> sv)
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentLinkedQueue

        +
        public static <A> Shrink<java.util.concurrent.ConcurrentLinkedQueue<A>> shrinkConcurrentLinkedQueue(Shrink<A> sa)
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArrayList

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArrayList<A>> shrinkCopyOnWriteArrayList(Shrink<A> sa)
        +
        A shrink strategy for copy on write array lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArraySet

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArraySet<A>> shrinkCopyOnWriteArraySet(Shrink<A> sa)
        +
        A shrink strategy for copy on write array sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Shrink<java.util.concurrent.DelayQueue<A>> shrinkDelayQueue(Shrink<A> sa)
        +
        A shrink strategy for delay queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.LinkedBlockingQueue<A>> shrinkLinkedBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for linked blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.PriorityBlockingQueue<A>> shrinkPriorityBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for priority blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkSynchronousQueue

        +
        public static <A> Shrink<java.util.concurrent.SynchronousQueue<A>> shrinkSynchronousQueue(Shrink<A> sa)
        +
        A shrink strategy for synchronous queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP1

        +
        public static <A> Shrink<fj.P1<A>> shrinkP1(Shrink<A> sa)
        +
        Returns a shrinking strategy for product-1 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP2

        +
        public static <A,B> Shrink<fj.P2<A,B>> shrinkP2(Shrink<A> sa,
+                                                Shrink<B> sb)
        +
        Returns a shrinking strategy for product-2 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP3

        +
        public static <A,B,C> Shrink<fj.P3<A,B,C>> shrinkP3(Shrink<A> sa,
+                                                    Shrink<B> sb,
+                                                    Shrink<C> sc)
        +
        Returns a shrinking strategy for product-3 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP4

        +
        public static <A,B,C,D> Shrink<fj.P4<A,B,C,D>> shrinkP4(Shrink<A> sa,
+                                                        Shrink<B> sb,
+                                                        Shrink<C> sc,
+                                                        Shrink<D> sd)
        +
        Returns a shrinking strategy for product-4 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP5

        +
        public static <A,B,C,D,E> Shrink<fj.P5<A,B,C,D,E>> shrinkP5(Shrink<A> sa,
+                                                            Shrink<B> sb,
+                                                            Shrink<C> sc,
+                                                            Shrink<D> sd,
+                                                            Shrink<E> se)
        +
        Returns a shrinking strategy for product-5 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP6

        +
        public static <A,B,C,D,E,F$> Shrink<fj.P6<A,B,C,D,E,F$>> shrinkP6(Shrink<A> sa,
+                                                                  Shrink<B> sb,
+                                                                  Shrink<C> sc,
+                                                                  Shrink<D> sd,
+                                                                  Shrink<E> se,
+                                                                  Shrink<F$> sf)
        +
        Returns a shrinking strategy for product-6 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP7

        +
        public static <A,B,C,D,E,F$,G> Shrink<fj.P7<A,B,C,D,E,F$,G>> shrinkP7(Shrink<A> sa,
+                                                                      Shrink<B> sb,
+                                                                      Shrink<C> sc,
+                                                                      Shrink<D> sd,
+                                                                      Shrink<E> se,
+                                                                      Shrink<F$> sf,
+                                                                      Shrink<G> sg)
        +
        Returns a shrinking strategy for product-7 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP8

        +
        public static <A,B,C,D,E,F$,G,H> Shrink<fj.P8<A,B,C,D,E,F$,G,H>> shrinkP8(Shrink<A> sa,
+                                                                          Shrink<B> sb,
+                                                                          Shrink<C> sc,
+                                                                          Shrink<D> sd,
+                                                                          Shrink<E> se,
+                                                                          Shrink<F$> sf,
+                                                                          Shrink<G> sg,
+                                                                          Shrink<H> sh)
        +
        Returns a shrinking strategy for product-8 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        sh - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/Variant.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/Variant.html new file mode 100644 index 0000000..207db6e --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/Variant.html @@ -0,0 +1,270 @@ + + + + + +Variant (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Variant

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Variant
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Variant
+extends java.lang.Object
    +
    A memoised generator variant. Stores generators that have already been computed for the given arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> fj.F<Gen<A>,Gen<A>>variant(long n) +
      A curried version of variant(long, Gen).
      +
      static <A> Gen<A>variant(long n, + Gen<A> g) +
      Produces a generator that is independent of the given generator using the given value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        variant

        +
        public static <A> Gen<A> variant(long n,
+                                 Gen<A> g)
        +
        Produces a generator that is independent of the given generator using the given value.
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A generator that is independent of the given generator using the given value.
        +
        +
        • +
      + + + +
        +
      • +

        variant

        +
        public static <A> fj.F<Gen<A>,Gen<A>> variant(long n)
        +
        A curried version of variant(long, Gen).
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        Returns:
        +
        A curried version of variant(long, Gen).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/package-frame.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-frame.html new file mode 100644 index 0000000..9127dfd --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-frame.html @@ -0,0 +1,30 @@ + + + + + +fj.test (quickcheck 4.8 API) + + + + + +

fj.test

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/package-summary.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-summary.html new file mode 100644 index 0000000..0726ce0 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-summary.html @@ -0,0 +1,225 @@ + + + + + +fj.test (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test

+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Arbitrary +
    Common Gen helper functions.
    +
    Arg<T> +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    Bool +
    A boolean wrapper that works well with properties.
    +
    CheckResult +
    An enumeration of the possible results after checking a property.
    +
    Cogen<A> +
    Transforms a type and a generator to produce a new generator.
    +
    Gen<A> +
    A generator for values of the type of the given type parameter (A).
    +
    Property +
    Represents an algebraic property about a program that may be checked for its truth value.
    +
    Rand +
    A random number generator.
    +
    Result +
    The result of evaluating a property.
    +
    Shrink<A> +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
    +
    Variant +
    A memoised generator variant.
    +
    +
    • +
+ + + +

Package fj.test Description

+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation. Reductio + encourages users to express properties or theorems about their software, and + the testing and reporting of the status of those properties occurs by automating various aspects. + For example, if a property is found to be false (i.e. a test fails), then the counter-example may + be reduced while still falsifying the property so that the reported counter-example is the + simplest found (this is called Shrink). The expression of the property also + serves as very rigorous documentation for the code under test; far surpassing that provided by + traditional testing techniques. + + Many of the concepts of Reductio originated with a paper called QuickCheck: A Lightweight Tool + for Random Testing of Haskell Programs by Koen Claassen and John Hughes from Chalmers University + of Technology. Reductio also borrows ideas from ScalaCheck by Rickard Nilsson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/package-tree.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-tree.html new file mode 100644 index 0000000..735fe78 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/package-tree.html @@ -0,0 +1,145 @@ + + + + + +fj.test Class Hierarchy (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Category.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Category.html new file mode 100644 index 0000000..bf7787f --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Category.html @@ -0,0 +1,223 @@ + + + + + +Category (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Category

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Category
    +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      The categories of the property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        The categories of the property.
        +
        +
        Returns:
        +
        The categories of the property.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Check.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Check.html new file mode 100644 index 0000000..f4db27e --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Check.html @@ -0,0 +1,497 @@ + + + + + +Check (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Check

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Check
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Check
+extends java.lang.Object
    +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <U,T extends U>
      fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>>      		properties(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        properties

        +
        public static <U,T extends U> fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>> properties(java.lang.Class<T> c,
+                                                                                                                    java.lang.String... categories)
        +
        Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations. For example, properties or their + enclosing class that are annotated with NoCheck are not considered. The name of a + property is specified by the annotation or if this annotation is not present, the + name of the method or field that represents the property.
        +
        +
        Parameters:
        +
        c - The class to look for properties on.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        All properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/CheckParams.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/CheckParams.html new file mode 100644 index 0000000..73ce1d0 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/CheckParams.html @@ -0,0 +1,309 @@ + + + + + +CheckParams (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type CheckParams

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={TYPE,FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface CheckParams
    +
    Specifies the check parameters on a Property property with typical defaults.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmaxDiscarded +
      The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e.
      +
      intmaxSize +
      The maximum size to use for checking.
      +
      intminSize +
      The minimum size to use for checking.
      +
      intminSuccessful +
      The minimum number of successful tests before a result is reached.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        minSuccessful

        +
        public abstract int minSuccessful
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        Returns:
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxDiscarded

        +
        public abstract int maxDiscarded
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        Returns:
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        +
        Default:
        +
        500
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        minSize

        +
        public abstract int minSize
        +
        The minimum size to use for checking.
        +
        +
        Returns:
        +
        The minimum size to use for checking.
        +
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxSize

        +
        public abstract int maxSize
        +
        The maximum size to use for checking.
        +
        +
        Returns:
        +
        The maximum size to use for checking.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Main.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Main.html new file mode 100644 index 0000000..e42afce --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Main.html @@ -0,0 +1,245 @@ + + + + + +Main (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Main

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Main
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Main
+extends java.lang.Object
    +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories. The class name and categories are passed as command line arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String... args) +
      Check the given class and categories.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String... args)
        +
        Check the given class and categories. At least one command line argument (the class name) must be + passed or an error message results.
        +
        +
        Parameters:
        +
        args - The class name as the first argument, then zero or more categories.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Name.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Name.html new file mode 100644 index 0000000..1eaa70b --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/Name.html @@ -0,0 +1,221 @@ + + + + + +Name (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Name

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Name
    +
    The name of a property to be used in reporting.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      The name of a property to be used in reporting.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The name of a property to be used in reporting.
        +
        +
        Returns:
        +
        The name of a property to be used in reporting.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/NoCheck.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/NoCheck.html new file mode 100644 index 0000000..5e5b39e --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/NoCheck.html @@ -0,0 +1,166 @@ + + + + + +NoCheck (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type NoCheck

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface NoCheck
    +
    Denotes that a property should be excluded from any checking.
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-frame.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-frame.html new file mode 100644 index 0000000..824fa22 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-frame.html @@ -0,0 +1,28 @@ + + + + + +fj.test.reflect (quickcheck 4.8 API) + + + + + +

fj.test.reflect

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-summary.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-summary.html new file mode 100644 index 0000000..443965c --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-summary.html @@ -0,0 +1,227 @@ + + + + + +fj.test.reflect (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.reflect

+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Check +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    Main +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Annotation Types Summary 
    Annotation TypeDescription
    Category +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    CheckParams +
    Specifies the check parameters on a Property property with typical defaults.
    +
    Name +
    The name of a property to be used in reporting.
    +
    NoCheck +
    Denotes that a property should be excluded from any checking.
    +
    +
    • +
+ + + +

Package fj.test.reflect Description

+
A wrapper around the fj.test package that uses annotations for configuring properties to + check. The properties are found using reflection. All annotations + are optional and a property is eligible for checking by default. A property is any of the + following member descriptions, unless the member or enclosing class is annotated with + NoCheck. + +
    +
  • a static field of type Property.
    • +
  • a static zero argument method that returns Property.
    • +
  • a non-static field of type Property in a class with a zero-argument constructor.
    • +
  • a non-static no-argument method that returns Property in a class with a no-argument + constructor.
    • +
+ +

+ A property may be in zero or more categories by annotating the member or enclosing class with + Category. The property is in the set of categories that make up the + union of its member and enclosing class category annotation. +

+

+ When a property is checked, it uses default configuration values, which may be overridden by + annotating the member or the enclosing class with the CheckParams + annotation. The values used are first those specified on the member; or if the annotation does + not exist, then the enclosing class (default values otherwise). +

+

+ A property can have a name associated with it by annotating the member with the + Name annotation. The name is a String that is used + only for reporting in check results. If the Name annotation does not + appear on a property member, then the field or method name is used by default. +

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-tree.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-tree.html new file mode 100644 index 0000000..fda24da --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/reflect/package-tree.html @@ -0,0 +1,143 @@ + + + + + +fj.test.reflect Class Hierarchy (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.reflect

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.test.reflect.Check
      • +
    • fj.test.reflect.Main
      • +
    +
    • +
+

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html new file mode 100644 index 0000000..3b62942 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html @@ -0,0 +1,329 @@ + + + + + +PropertyTestRunner (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test.runner
+

Class PropertyTestRunner

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.junit.runner.Runner
      • +
    • +
        +
      • fj.test.runner.PropertyTestRunner
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.junit.runner.Describable, org.junit.runner.manipulation.Filterable
    +
    +
    +
    +
    public class PropertyTestRunner
+extends org.junit.runner.Runner
+implements org.junit.runner.manipulation.Filterable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PropertyTestRunner(java.lang.Class<?> clas) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidfilter(org.junit.runner.manipulation.Filter filter) 
      org.junit.runner.DescriptiongetDescription() 
      voidrun(org.junit.runner.notification.RunNotifier notifier) 
      +
        +
      • + + +

        Methods inherited from class org.junit.runner.Runner

        +testCount
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PropertyTestRunner

        +
        public PropertyTestRunner(java.lang.Class<?> clas)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public final org.junit.runner.Description getDescription()
        +
        +
        Specified by:
        +
        getDescription in interface org.junit.runner.Describable
        +
        Specified by:
        +
        getDescription in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final void run(org.junit.runner.notification.RunNotifier notifier)
        +
        +
        Specified by:
        +
        run in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final void filter(org.junit.runner.manipulation.Filter filter)
+                  throws org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        Specified by:
        +
        filter in interface org.junit.runner.manipulation.Filterable
        +
        Throws:
        +
        org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-frame.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-frame.html new file mode 100644 index 0000000..658b02c --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.test.runner (quickcheck 4.8 API) + + + + + +

fj.test.runner

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-summary.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-summary.html new file mode 100644 index 0000000..4182787 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-summary.html @@ -0,0 +1,140 @@ + + + + + +fj.test.runner (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.runner

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-tree.html b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-tree.html new file mode 100644 index 0000000..bfc5b3e --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/fj/test/runner/package-tree.html @@ -0,0 +1,139 @@ + + + + + +fj.test.runner Class Hierarchy (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.runner

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.junit.runner.Runner (implements org.junit.runner.Describable) +
        +
      • fj.test.runner.PropertyTestRunner (implements org.junit.runner.manipulation.Filterable)
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/help-doc.html b/javadoc/4.8/functionaljava-quickcheck/help-doc.html new file mode 100644 index 0000000..dfd0133 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/index-all.html b/javadoc/4.8/functionaljava-quickcheck/index-all.html new file mode 100644 index 0000000..3ca2c29 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/index-all.html @@ -0,0 +1,2127 @@ + + + + + +Index (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
A B C D E F G I J L M N O P R S T U V W  + + +

A

+
+
addArg(Arg<?>) - Method in class fj.test.Result
+
+
Adds an argument to this result.
+
+
and(Property) - Method in class fj.test.Property
+
+
Performs a conjunction of this property with the given property.
+
+
apply(Gen<F<A, B>>) - Method in class fj.test.Gen
+
+
Function application within this generator to produce a new generator.
+
+
arbAlphaNumString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with alpha-numeric characters.
+
+
arbArray(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for arrays.
+
+
arbArrayBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array blocking queues.
+
+
arbArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array lists.
+
+
arbBigDecimal - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big decimals.
+
+
arbBigInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big integers.
+
+
arbBitSet - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for bit sets.
+
+
arbBoolean - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for boolean values.
+
+
arbByte - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values.
+
+
arbByteBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbByte + the remainder of the time (93%).
+
+
arbCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for calendars.
+
+
arbCharacter - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values.
+
+
arbCharacterBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbCharacter + the remainder of the time (96%).
+
+
arbConcurrentHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent hash maps.
+
+
arbConcurrentLinkedQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent linked queues.
+
+
arbCopyOnWriteArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array lists.
+
+
arbCopyOnWriteArraySet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array sets.
+
+
arbDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for dates.
+
+
arbDelayQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for delay queues.
+
+
arbDouble - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values.
+
+
arbDoubleBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from Arbitrary.arbDouble the remainder of the time (91%).
+
+
arbEither(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for the disjoint union.
+
+
arbEnumMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum maps.
+
+
arbEnumSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum sets.
+
+
arbEnumValue(Class<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for a Java enumeration.
+
+
arbF(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbF2(Cogen<A>, Cogen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF2Invariant(Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF3(Cogen<A>, Cogen<B>, Cogen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF3Invariant(Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF4Invariant(Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF5Invariant(Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF6Invariant(Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF7Invariant(Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>, Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbF8Invariant(Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbFInvariant(Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbFloat - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values.
+
+
arbFloatBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + Arbitrary.arbFloat the remainder of the time (91%).
+
+
arbGen(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for generators.
+
+
arbGregorianCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for gregorian calendars.
+
+
arbHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash maps.
+
+
arbHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbHashtable(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash tables.
+
+
arbIdentityHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for identity hash maps.
+
+
arbInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values.
+
+
arbIntegerBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbInteger the remainder of the time (93%).
+
+
Arbitrary - Class in fj.test
+
+
Common Gen helper functions.
+
+
Arbitrary() - Constructor for class fj.test.Arbitrary
+
 
+
arbJavaTreeMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for java.util tree maps.
+
+
arbLcgRng() - Static method in class fj.test.Arbitrary
+
+
An arbitrary for the LcgRng.
+
+
arbLinkedBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked blocking queues.
+
+
arbLinkedHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked hash maps.
+
+
arbLinkedHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbLinkedList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked lists.
+
+
arbList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for lists.
+
+
arbListBoolean() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of booleans.
+
+
arbListDouble() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of doubles.
+
+
arbListInteger() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of integers.
+
+
arbListString() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of strings.
+
+
arbLocale - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for locales.
+
+
arbLong - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values.
+
+
arbLongBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbLong + the remainder of the time (93%).
+
+
arbNatural - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for naturals.
+
+
arbNonEmptyList(Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbOption(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for optional values.
+
+
arbP1(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-1 values.
+
+
arbP2(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-2 values.
+
+
arbP3(Gen<A>, Gen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-3 values.
+
+
arbP4(Gen<A>, Gen<B>, Gen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-4 values.
+
+
arbP5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-5 values.
+
+
arbP6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-6 values.
+
+
arbP7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-7 values.
+
+
arbP8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-8 values.
+
+
arbPriorityBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbPriorityQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority queues.
+
+
arbProperties - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for properties.
+
+
arbReader(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
 
+
arbSeq(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for sequences.
+
+
arbSet(Ord<A>, Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbSet(Ord<A>, Gen<A>, int) - Static method in class fj.test.Arbitrary
+
 
+
arbShort - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values.
+
+
arbShortBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbShort + the remainder of the time (93%).
+
+
arbSQLDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL dates.
+
+
arbStack(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for stacks.
+
+
arbState(Gen<S>, Cogen<S>, Gen<A>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for state.
+
+
arbStream(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for streams.
+
+
arbString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values.
+
+
arbStringBuffer - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string buffer values.
+
+
arbStringBuilder - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string builder values.
+
+
arbSynchronousQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbThrowable - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for throwables.
+
+
arbThrowable(Gen<String>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for throwables.
+
+
arbTime - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL times.
+
+
arbTimestamp - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL time stamps.
+
+
arbTreeMap(Ord<K>, Gen<List<P2<K, V>>>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, Gen<Integer>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, int) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
+
+
arbTreeSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree sets.
+
+
arbUSASCIIString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with characters in the US-ASCII range.
+
+
arbValidation(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary Validation for the given arbitrary parameters.
+
+
arbVector(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for vectors.
+
+
arbWeakHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for weak hash maps.
+
+
Arg<T> - Class in fj.test
+
+
An argument used in a property that may have undergone shrinking following falsification.
+
+
arg(T, int) - Static method in class fj.test.Arg
+
+
Construct a property argument with the given value and number of shrinks.
+
+
args() - Method in class fj.test.CheckResult
+
+
Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
+
+
args() - Method in class fj.test.Result
+
+
Returns the potential arguments associated with this result.
+
+
argShow - Static variable in class fj.test.Arg
+
+
The rendering of an argument (uses Object.toString() for the argument value).
+
+
assertResult(Property) - Static method in class fj.data.test.PropertyAssert
+
 
+
+ + + +

B

+
+
bind(F<A, Gen<B>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator to produce a new generator.
+
+
bind(Gen<B>, F<A, F<B, C>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generator to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, F<A, F<B, F<C, D>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
Bool - Class in fj.test
+
+
A boolean wrapper that works well with properties.
+
+
bool(boolean) - Static method in class fj.test.Bool
+
+
Construct a Bool from the given value.
+
+
+ + + +

C

+
+
Category - Annotation Type in fj.test.reflect
+
+
Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
+
+
check(Rand, int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given arguments and produces a result.
+
+
check(int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator and the given + arguments to produce a result.
+
+
check(Rand) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
check(Rand, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
+
+
check(int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
+
+
check() - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
Check - Class in fj.test.reflect
+
+
Functions for checking properties in a class that are found reflectively and according to various + annotations.
+
+
check(List<Class<T>>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(List<Class<T>>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
check(Class<T>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
CheckParams - Annotation Type in fj.test.reflect
+
+
Specifies the check parameters on a Property property with typical defaults.
+
+
CheckResult - Class in fj.test
+
+
An enumeration of the possible results after checking a property.
+
+
choose(int, int) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, long) - Static method in class fj.test.Gen
+
 
+
choose(double, double) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(long, long) - Method in class fj.test.Rand
+
 
+
choose(long, double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
Cogen<A> - Class in fj.test
+
+
Transforms a type and a generator to produce a new generator.
+
+
Cogen() - Constructor for class fj.test.Cogen
+
 
+
cogen(A, Gen<B>) - Method in class fj.test.Cogen
+
+
Transforms the given value and generator to a new generator with a high probability of being + independent.
+
+
cogen(A) - Method in class fj.test.Cogen
+
+
A curried version of Cogen.cogen(Object, Gen).
+
+
cogenArray(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for arrays.
+
+
cogenArrayBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array blocking queues.
+
+
cogenArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array lists.
+
+
cogenBigDecimal - Static variable in class fj.test.Cogen
+
 
+
cogenBigInteger - Static variable in class fj.test.Cogen
+
 
+
cogenBitSet - Static variable in class fj.test.Cogen
+
+
A cogen for bit sets.
+
+
cogenBoolean - Static variable in class fj.test.Cogen
+
+
A cogen for booleans.
+
+
cogenByte - Static variable in class fj.test.Cogen
+
+
A cogen for bytes.
+
+
cogenCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for calendars.
+
+
cogenCharacter - Static variable in class fj.test.Cogen
+
+
A cogen for characters.
+
+
cogenConcurrentHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent hash maps.
+
+
cogenConcurrentLinkedQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent linked queues.
+
+
cogenCopyOnWriteArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array lists.
+
+
cogenCopyOnWriteArraySet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array sets.
+
+
cogenDate - Static variable in class fj.test.Cogen
+
+
A cogen for dates.
+
+
cogenDelayQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for delay queues.
+
+
cogenDouble - Static variable in class fj.test.Cogen
+
+
A cogen for doubles.
+
+
cogenEither(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for the disjoint union.
+
+
cogenEnumMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for enum maps.
+
+
cogenEnumSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for enum sets.
+
+
cogenF(Gen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for a function.
+
+
cogenF2(Gen<A>, Gen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-2.
+
+
cogenF3(Gen<A>, Gen<B>, Gen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-3.
+
+
cogenF4(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-4.
+
+
cogenF5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-5.
+
+
cogenF6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-6.
+
+
cogenF7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-7.
+
+
cogenF8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Cogen<I>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-8.
+
+
cogenFloat - Static variable in class fj.test.Cogen
+
+
A cogen for floats.
+
+
cogenGregorianCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for gregorian calendars.
+
+
cogenHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash maps.
+
+
cogenHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for hash sets.
+
+
cogenHashtable(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash tables.
+
+
cogenIdentityHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for identity hash maps.
+
+
cogenInteger - Static variable in class fj.test.Cogen
+
+
A cogen for integers.
+
+
cogenLcgRng() - Static method in class fj.test.Cogen
+
+
A cogen for the provided LcgRng
+
+
cogenLinkedBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked blocking queues.
+
+
cogenLinkedHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash maps.
+
+
cogenLinkedHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash sets.
+
+
cogenLinkedList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked lists.
+
+
cogenList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for lists.
+
+
cogenLong - Static variable in class fj.test.Cogen
+
+
A cogen for longs.
+
+
cogenOption(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for the optional value.
+
+
cogenP1(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for product-1 values.
+
+
cogenP2(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for product-2 values.
+
+
cogenP3(Cogen<A>, Cogen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for product-3 values.
+
+
cogenP4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for product-4 values.
+
+
cogenP5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for product-5 values.
+
+
cogenP6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for product-6 values.
+
+
cogenP7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for product-7 values.
+
+
cogenP8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for product-8 values.
+
+
cogenPriorityBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority blocking queues.
+
+
cogenPriorityQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority queues.
+
+
cogenProperties - Static variable in class fj.test.Cogen
+
+
A cogen for properties.
+
+
cogenShort - Static variable in class fj.test.Cogen
+
+
A cogen for shorts.
+
+
cogenSQLDate - Static variable in class fj.test.Cogen
+
 
+
cogenStack(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for stacks.
+
+
cogenState(Gen<S>, F2<S, A, Long>) - Static method in class fj.test.Cogen
+
+
A cogen for state.
+
+
cogenStream(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for streams.
+
+
cogenString - Static variable in class fj.test.Cogen
+
+
A cogen for strings.
+
+
cogenStringBuffer - Static variable in class fj.test.Cogen
+
+
A cogen for string buffers.
+
+
cogenStringBuilder - Static variable in class fj.test.Cogen
+
+
A cogen for string builders.
+
+
cogenSynchronousQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for synchronous queues.
+
+
cogenThrowable - Static variable in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenThrowable(Cogen<String>) - Static method in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenTime - Static variable in class fj.test.Cogen
+
 
+
cogenTimestamp - Static variable in class fj.test.Cogen
+
 
+
cogenTreeMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for tree maps.
+
+
cogenTreeSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for tree sets.
+
+
cogenVector(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for vectors.
+
+
cogenWeakHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for weak hash maps.
+
+
combinationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
compose(F<B, A>) - Method in class fj.test.Cogen
+
+
Composes the given function with this cogen to produce a new cogen.
+
+
contramap(F<B, A>) - Method in class fj.test.Cogen
+
+
Contra-maps this cogen using the given function.
+
+
+ + + +

D

+
+
discarded() - Method in class fj.test.CheckResult
+
+
Returns the number of discarded checks of the property in this result.
+
+
+ + + +

E

+
+
elements(A...) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given arguments.
+
+
elemFrequency(List<P2<Integer, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given frequency and value pairs.
+
+
empty() - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy that cannot be reduced further.
+
+
exception() - Method in class fj.test.CheckResult
+
+
Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
+
+
exception(F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
+
+
exception() - Method in class fj.test.Result
+
+
Returns the potential exception associated with this result.
+
+
exception(List<Arg<?>>, Throwable) - Static method in class fj.test.Result
+
+
Returns an exception result.
+
+
exhausted(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property been exhausted in checking.
+
+
+ + + +

F

+
+
fail() - Static method in class fj.test.Gen
+
+
Returns a generator that never returns a value.
+
+
failed() - Method in class fj.test.Result
+
+
Returns true if this result is falsified or an exception; otherwise, + false.
+
+
falsified(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been falsified.
+
+
falsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a falsified result.
+
+
filter(F<A, Boolean>) - Method in class fj.test.Gen
+
+
Returns a generator that produces values that meet the given predicate.
+
+
filter(Filter) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
fj.data.test - package fj.data.test
+
 
+
fj.test - package fj.test
+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+
fj.test.reflect - package fj.test.reflect
+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+
fj.test.runner - package fj.test.runner
+
 
+
forall(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
foreach(Integer, Rand, F<A, Unit>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
foreachDoEffect(Integer, Rand, Effect1<A>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
frequency(List<P2<Integer, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses values from the given frequency and generator pairs.
+
+
fromGen(Gen<Result>) - Static method in class fj.test.Property
+
+
Constructs a property from a generator of results.
+
+
+ + + +

G

+
+
Gen<A> - Class in fj.test
+
+
A generator for values of the type of the given type parameter (A).
+
+
gen(int, Rand) - Method in class fj.test.Gen
+
+
Applies the given size and random generator to produce a value.
+
+
gen(F<Integer, F<Rand, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses the given function.
+
+
gen() - Method in class fj.test.Property
+
+
Returns a generator of results from this property.
+
+
genException(Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that generating values to check the property threw an exception.
+
+
getDescription() - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

I

+
+
implies(F0<Property>) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Property) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Bool) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean, F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, boolean) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, F0<Boolean>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
is() - Method in class fj.test.Bool
+
+
Returns true if this value is true, false otherwise.
+
+
isException() - Method in class fj.test.Result
+
+
Returns true if this result is an exception; otherwise, false.
+
+
isExhausted() - Method in class fj.test.CheckResult
+
+
Returns true if this result is exhausted, false otherwise.
+
+
isFalsified() - Method in class fj.test.CheckResult
+
+
Returns true if this result is falsified, false otherwise.
+
+
isFalsified() - Method in class fj.test.Result
+
+
Returns true if this result is falsified; otherwise, false.
+
+
isGenException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during generating of values for + property checking, false otherwise.
+
+
isNoResult() - Method in class fj.test.Result
+
+
Returns true if this result is no result; otherwise, false.
+
+
isNot() - Method in class fj.test.Bool
+
+
Returns false if this value is true, true otherwise.
+
+
isPassed() - Method in class fj.test.CheckResult
+
+
Returns true if this result is passed, false otherwise.
+
+
isPropException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during property execution, + false otherwise.
+
+
isProven() - Method in class fj.test.CheckResult
+
+
Returns true if this result is proven, false otherwise.
+
+
isProven() - Method in class fj.test.Result
+
+
Returns true if this result is proven; otherwise, false.
+
+
isUnfalsified() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified; otherwise, false.
+
+
+ + + +

J

+
+
join(Gen<Gen<A>>) - Static method in class fj.test.Gen
+
+
Joins the generator of generators through a Gen.bind(F) operation.
+
+
+ + + +

L

+
+
listOf(Gen<A>, int) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf1(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of non empty lists whose values come from the given generator.
+
+
listOfSorted(Gen<A>, int, Ord<A>) - Static method in class fj.test.Gen
+
 
+
+ + + +

M

+
+
Main - Class in fj.test.reflect
+
+
Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
+
+
main(String...) - Static method in class fj.test.reflect.Main
+
+
Check the given class and categories.
+
+
map(F<A, B>) - Method in class fj.test.Gen
+
+
Maps the given function across this generator.
+
+
map(F<A, B>, F<B, A>) - Method in class fj.test.Shrink
+
+
Creates a shrink from this shrink and the given symmetric transformations.
+
+
maxDiscarded(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxDiscarded(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
maxSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
minSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSuccessful(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
minSuccessful(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
+ + + +

N

+
+
Name - Annotation Type in fj.test.reflect
+
+
The name of a property to be used in reporting.
+
+
NoCheck - Annotation Type in fj.test.reflect
+
+
Denotes that a property should be excluded from any checking.
+
+
noResult(Option<Result>) - Static method in class fj.test.Result
+
+
Returns a result from the given potential result.
+
+
noResult() - Static method in class fj.test.Result
+
+
Returns a result representing no result.
+
+
+ + + +

O

+
+
oneOf(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from one of the given generators on subsequent + requests.
+
+
or(Property) - Method in class fj.test.Property
+
+
Performs a disjunction of this property with the given property.
+
+
+ + + +

P

+
+
parameterised(F<Integer, F<Rand, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its construction arguments — size and random + generator.
+
+
passed(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has passed.
+
+
passed() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified or proven; otherwise, + false.
+
+
permutationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
pick(int, List<A>) - Static method in class fj.test.Gen
+
+
Deprecated. +
As of release 4.6, use Gen.combinationOf(int, fj.data.List<A>)
+
+
+
pickOne(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator that picks one element from the given list.
+
+
promote(F<A, Gen<B>>) - Static method in class fj.test.Gen
+
+
Promotes the given function to a generator for functions.
+
+
prop(int, Rand) - Method in class fj.test.Property
+
+
Returns the result of applying the given size and random generator.
+
+
prop(F<Integer, F<Rand, Result>>) - Static method in class fj.test.Property
+
+
Returns a property from the given function.
+
+
prop(Result) - Static method in class fj.test.Property
+
+
Returns a property that always has the given result.
+
+
prop(boolean) - Static method in class fj.test.Property
+
+
Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
+
+
properties(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
+
+
Property - Class in fj.test
+
+
Represents an algebraic property about a program that may be checked for its truth value.
+
+
property(Gen<A>, Shrink<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyAssert - Class in fj.data.test
+
+
Created by MarkPerry on 18/12/2014.
+
+
propertyP(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyTestRunner - Class in fj.test.runner
+
 
+
PropertyTestRunner(Class<?>) - Constructor for class fj.test.runner.PropertyTestRunner
+
 
+
propException(List<Arg<?>>, Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that checking the property threw an exception.
+
+
proven(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been proven.
+
+
proven(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a proven result.
+
+
provenAsUnfalsified() - Method in class fj.test.Result
+
+
If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
+
+
+ + + +

R

+
+
Rand - Class in fj.test
+
+
A random number generator.
+
+
rand(F<Option<Long>, F<Integer, F<Integer, Integer>>>, F<Option<Long>, F<Double, F<Double, Double>>>) - Static method in class fj.test.Rand
+
+
Deprecated. +
As of release 4.6, use Rand.rand(F, F, F).
+
+
+
rand(F<Option<Long>, F<Integer, F<Integer, Integer>>>, F<Option<Long>, F<Double, F<Double, Double>>>, F<Long, Rand>) - Static method in class fj.test.Rand
+
+
Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
+
+
reseed(long) - Method in class fj.test.Rand
+
+
Gives this random generator a new seed.
+
+
resize(int) - Method in class fj.test.Gen
+
+
Resizes this generator with the given size.
+
+
Result - Class in fj.test
+
+
The result of evaluating a property.
+
+
run(RunNotifier) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

S

+
+
selectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
sequence(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Sequence the given generators through a Gen.bind(F) operation.
+
+
sequence(Property) - Method in class fj.test.Property
+
+
Performs a sequence of this property with the given property.
+
+
sequenceN(int, Gen<A>) - Static method in class fj.test.Gen
+
+
Sequences the given generator the given number of times through a Gen.bind(F) operation.
+
+
Shrink<A> - Class in fj.test
+
+
Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
+
+
shrink(A) - Method in class fj.test.Shrink
+
+
Returns a shrink of the given argument.
+
+
shrink(F<A, Stream<A>>) - Static method in class fj.test.Shrink
+
+
Constructs a shrink strategy from the given function that produces a tree of values given a + value.
+
+
shrinkArray(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for arrays.
+
+
shrinkArrayBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for array blocking queues.
+
+
shrinkArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for array lists.
+
+
shrinkBigDecimal - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big decimals.
+
+
shrinkBigInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big integers.
+
+
shrinkBitSet - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bit sets.
+
+
shrinkBoolean - Static variable in class fj.test.Shrink
+
+
A shrink strategy for booleans using false as the bottom of the shrink.
+
+
shrinkByte - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bytes using 0 as the bottom of the shrink.
+
+
shrinkCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for calendars.
+
+
shrinkCharacter - Static variable in class fj.test.Shrink
+
+
A shrink strategy for characters using 0 as the bottom of the shrink.
+
+
shrinkConcurrentHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent hash maps.
+
+
shrinkConcurrentLinkedQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent linked queues.
+
+
shrinkCopyOnWriteArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array lists.
+
+
shrinkCopyOnWriteArraySet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array sets.
+
+
shrinkDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for dates.
+
+
shrinkDelayQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for delay queues.
+
+
shrinkDouble - Static variable in class fj.test.Shrink
+
+
A shrink strategy for doubles using 0 as the bottom of the shrink.
+
+
shrinkEither(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for either values.
+
+
shrinkEnumMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum maps.
+
+
shrinkEnumSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum sets.
+
+
shrinkFloat - Static variable in class fj.test.Shrink
+
+
A shrink strategy for floats using 0 as the bottom of the shrink.
+
+
shrinkGregorianCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for gregorian calendars.
+
+
shrinkHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash maps.
+
+
shrinkHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash sets.
+
+
shrinkHashtable(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash tables.
+
+
shrinkIdentityHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for identity hash maps.
+
+
shrinkInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for integers using 0 as the bottom of the shrink.
+
+
shrinkLinkedBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked blocking queues.
+
+
shrinkLinkedHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash maps.
+
+
shrinkLinkedHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash sets.
+
+
shrinkLinkedList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked lists.
+
+
shrinkList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for lists.
+
+
shrinkLong - Static variable in class fj.test.Shrink
+
+
A shrink strategy for longs using 0 as the bottom of the shrink.
+
+
shrinkNatural - Static variable in class fj.test.Shrink
+
+
A shrink strategy for naturals.
+
+
shrinkOption(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for optional values.
+
+
shrinkP1(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-1 values.
+
+
shrinkP2(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-2 values.
+
+
shrinkP3(Shrink<A>, Shrink<B>, Shrink<C>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-3 values.
+
+
shrinkP4(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-4 values.
+
+
shrinkP5(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-5 values.
+
+
shrinkP6(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-6 values.
+
+
shrinkP7(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-7 values.
+
+
shrinkP8(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-8 values.
+
+
shrinkPriorityBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority blocking queues.
+
+
shrinkPriorityQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority queues.
+
+
shrinkProperties - Static variable in class fj.test.Shrink
+
+
A shrink strategy for properties.
+
+
shrinks() - Method in class fj.test.Arg
+
+
Returns the argument's number of shrinks following falsification.
+
+
shrinkShort - Static variable in class fj.test.Shrink
+
+
A shrink strategy for shorts using 0 as the bottom of the shrink.
+
+
shrinkSQLDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL dates.
+
+
shrinkStack(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for stacks.
+
+
shrinkStream(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for streams.
+
+
shrinkString - Static variable in class fj.test.Shrink
+
+
A shrink strategy for strings using the empty string as the bottom of the shrink.
+
+
shrinkStringBuffer - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string buffers using the empty string as the bottom of the shrink.
+
+
shrinkStringBuilder - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string builders using the empty string as the bottom of the shrink.
+
+
shrinkSynchronousQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for synchronous queues.
+
+
shrinkThrowable - Static variable in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkThrowable(Shrink<String>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkTime - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL times.
+
+
shrinkTimestamp - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL timestamps.
+
+
shrinkTreeMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree maps.
+
+
shrinkTreeSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree sets.
+
+
shrinkVector(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for vectors.
+
+
shrinkWeakHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for weak hash maps.
+
+
sized(F<Integer, Gen<A>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its size construction arguments.
+
+
someCombinationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someOf(List<A>) - Static method in class fj.test.Gen
+
+
Deprecated. +
As of release 4.6, use Gen.someCombinationOf(fj.data.List<A>)
+
+
+
somePermutationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someSelectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someWordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
standard - Static variable in class fj.test.Rand
+
+
A standard random generator that uses Random.
+
+
succeeded() - Method in class fj.test.CheckResult
+
+
Returns the number of succeeded checks of the property in this result.
+
+
summary - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summary(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summaryEx - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
summaryEx(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
+ + + +

T

+
+
toOption() - Method in class fj.test.Result
+
+
Returns a potential result for this result.
+
+
+ + + +

U

+
+
unfalsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns an unfalsified result.
+
+
+ + + +

V

+
+
value() - Method in class fj.test.Arg
+
+
Returns the argument's value.
+
+
value(A) - Static method in class fj.test.Gen
+
+
Returns a generator that always produces the given value.
+
+
Variant - Class in fj.test
+
+
A memoised generator variant.
+
+
variant(long, Gen<A>) - Static method in class fj.test.Variant
+
+
Produces a generator that is independent of the given generator using the given value.
+
+
variant(long) - Static method in class fj.test.Variant
+
+
A curried version of Variant.variant(long, Gen).
+
+
+ + + +

W

+
+
wordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
+A B C D E F G I J L M N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/index.html b/javadoc/4.8/functionaljava-quickcheck/index.html new file mode 100644 index 0000000..0a95a6e --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/index.html @@ -0,0 +1,75 @@ + + + + + +quickcheck 4.8 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8/functionaljava-quickcheck/overview-frame.html b/javadoc/4.8/functionaljava-quickcheck/overview-frame.html new file mode 100644 index 0000000..b6e4f16 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/overview-frame.html @@ -0,0 +1,24 @@ + + + + + +Overview List (quickcheck 4.8 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/4.8/functionaljava-quickcheck/overview-summary.html b/javadoc/4.8/functionaljava-quickcheck/overview-summary.html new file mode 100644 index 0000000..af7d3f1 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/overview-summary.html @@ -0,0 +1,154 @@ + + + + + +Overview (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

quickcheck 4.8 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj.data.test 
fj.test +
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
fj.test.reflect +
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
fj.test.runner 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/overview-tree.html b/javadoc/4.8/functionaljava-quickcheck/overview-tree.html new file mode 100644 index 0000000..f3040e8 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/overview-tree.html @@ -0,0 +1,163 @@ + + + + + +Class Hierarchy (quickcheck 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava-quickcheck/package-list b/javadoc/4.8/functionaljava-quickcheck/package-list new file mode 100644 index 0000000..34273ed --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/package-list @@ -0,0 +1,4 @@ +fj.data.test +fj.test +fj.test.reflect +fj.test.runner diff --git a/javadoc/4.8/functionaljava-quickcheck/script.js b/javadoc/4.8/functionaljava-quickcheck/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8/functionaljava-quickcheck/stylesheet.css b/javadoc/4.8/functionaljava-quickcheck/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8/functionaljava-quickcheck/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8/functionaljava/allclasses-frame.html b/javadoc/4.8/functionaljava/allclasses-frame.html new file mode 100644 index 0000000..33d9f66 --- /dev/null +++ b/javadoc/4.8/functionaljava/allclasses-frame.html @@ -0,0 +1,230 @@ + + + + + +All Classes (core 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava/allclasses-noframe.html b/javadoc/4.8/functionaljava/allclasses-noframe.html new file mode 100644 index 0000000..8e23126 --- /dev/null +++ b/javadoc/4.8/functionaljava/allclasses-noframe.html @@ -0,0 +1,230 @@ + + + + + +All Classes (core 4.8 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8/functionaljava/constant-values.html b/javadoc/4.8/functionaljava/constant-values.html new file mode 100644 index 0000000..bebb129 --- /dev/null +++ b/javadoc/4.8/functionaljava/constant-values.html @@ -0,0 +1,205 @@ + + + + + +Constant Field Values (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

fj.data.*

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/deprecated-list.html b/javadoc/4.8/functionaljava/deprecated-list.html new file mode 100644 index 0000000..42d052f --- /dev/null +++ b/javadoc/4.8/functionaljava/deprecated-list.html @@ -0,0 +1,332 @@ + + + + + +Deprecated List (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Bottom.html b/javadoc/4.8/functionaljava/fj/Bottom.html new file mode 100644 index 0000000..0796271 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Bottom.html @@ -0,0 +1,401 @@ + + + + + +Bottom (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Bottom

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Bottom
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bottom
+extends java.lang.Object
    +
    Represents the bottom _|_ value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> java.lang.Errordecons(A a, + Show<A> sa) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <A> java.lang.Errordecons(java.lang.Class<A> c) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eMessage() +
      A function that returns the getMessage for a throwable.
      +
      static <A> P1<A>error_(java.lang.String s) +
      Provides a thunk that throws an error using the given message when evaluated.
      +
      static java.lang.Errorerror(java.lang.String s) +
      Returns an error to represent undefinedness in a computation with early failure using the given + message.
      +
      static <A,B> F<A,B>errorF(java.lang.String s) +
      Provides a function that throws an error using the given message, ignoring its argument.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eToString() +
      A function that returns the toString for a throwable.
      +
      static java.lang.Errorundefined() +
      Returns an error to represent undefinedness in a computation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        undefined

        +
        public static java.lang.Error undefined()
        +
        Returns an error to represent undefinedness in a computation.
        +
        +
        Returns:
        +
        An error to represent undefinedness in a computation.
        +
        +
        • +
      + + + +
        +
      • +

        error

        +
        public static java.lang.Error error(java.lang.String s)
        +
        Returns an error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        An error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        • +
      + + + +
        +
      • +

        error_

        +
        public static <A> P1<A> error_(java.lang.String s)
        +
        Provides a thunk that throws an error using the given message when evaluated.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A thunk that throws an error using the given message when evaluated.
        +
        +
        • +
      + + + +
        +
      • +

        errorF

        +
        public static <A,B> F<A,B> errorF(java.lang.String s)
        +
        Provides a function that throws an error using the given message, ignoring its argument.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A function that throws an error using the given message, ignoring its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(A a,
+                                         Show<A> sa)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        a - The value being deconstructed.
        +
        sa - The rendering for the value being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(java.lang.Class<A> c)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        c - The type being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        eToString

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eToString()
        +
        A function that returns the toString for a throwable.
        +
        +
        Returns:
        +
        A function that returns the toString for a throwable.
        +
        +
        • +
      + + + +
        +
      • +

        eMessage

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eMessage()
        +
        A function that returns the getMessage for a throwable.
        +
        +
        Returns:
        +
        A function that returns the getMessage for a throwable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Class.html b/javadoc/4.8/functionaljava/fj/Class.html new file mode 100644 index 0000000..e85fe64 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Class.html @@ -0,0 +1,373 @@ + + + + + +Class (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Class<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Class<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Class<T>
+extends java.lang.Object
    +
    A wrapper for a Class that provides additional methods.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<T>clas() +
      Returns the underlying class.
      +
      static <T> Class<T>clas(java.lang.Class<T> c) +
      Constructs a class from the given argument.
      +
      Tree<java.lang.reflect.Type>classParameters() +
      Provides this class's type parameter information as a Tree of the type expression.
      +
      List<Class<? super T>>inheritance() +
      Returns the inheritance hierarchy of this class.
      +
      List<Tree<java.lang.reflect.Type>>interfaceParameters() +
      Provides this class's interface type parameter information as a list of trees.
      +
      Tree<java.lang.reflect.Type>superclassParameters() +
      Provides this class's superclass type parameter information as a Tree of the type expression.
      +
      static Tree<java.lang.reflect.Type>typeParameterTree(java.lang.reflect.Type t) +
      Provides type parameter information as a Tree of the type expression.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        inheritance

        +
        public List<Class<? super T>> inheritance()
        +
        Returns the inheritance hierarchy of this class.
        +
        +
        Returns:
        +
        The inheritance hierarchy of this class.
        +
        +
        • +
      + + + +
        +
      • +

        classParameters

        +
        public Tree<java.lang.reflect.Type> classParameters()
        +
        Provides this class's type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The rose tree representing the type expression for this class.
        +
        +
        • +
      + + + +
        +
      • +

        superclassParameters

        +
        public Tree<java.lang.reflect.Type> superclassParameters()
        +
        Provides this class's superclass type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The Tree representing the type expression for this class's superclass.
        +
        +
        • +
      + + + +
        +
      • +

        interfaceParameters

        +
        public List<Tree<java.lang.reflect.Type>> interfaceParameters()
        +
        Provides this class's interface type parameter information as a list of trees.
        +
        +
        Returns:
        +
        A list of trees representing the type expressions for this class's interfaces.
        +
        +
        • +
      + + + +
        +
      • +

        typeParameterTree

        +
        public static Tree<java.lang.reflect.Type> typeParameterTree(java.lang.reflect.Type t)
        +
        Provides type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Parameters:
        +
        t - The type (class) for which to get the generic type information.
        +
        Returns:
        +
        Type parameter information as a rose tree of the type expression.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public java.lang.Class<T> clas()
        +
        Returns the underlying class.
        +
        +
        Returns:
        +
        The underlying class.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public static <T> Class<T> clas(java.lang.Class<T> c)
        +
        Constructs a class from the given argument.
        +
        +
        Parameters:
        +
        c - The argument to construct this class with.
        +
        Returns:
        +
        A class from the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Digit.html b/javadoc/4.8/functionaljava/fj/Digit.html new file mode 100644 index 0000000..07b4ec2 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Digit.html @@ -0,0 +1,637 @@ + + + + + +Digit (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Digit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Digit>
      • +
    • +
        +
      • fj.Digit
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Digit>
    +
    +
    +
    +
    public enum Digit
+extends java.lang.Enum<Digit>
    +
    The digits zero to nine.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      _0 +
      Zero.
      +
      _1 +
      One.
      +
      _2 +
      Two.
      +
      _3 +
      Three.
      +
      _4 +
      Four.
      +
      _5 +
      Five.
      +
      _6 +
      Six.
      +
      _7 +
      Seven.
      +
      _8 +
      Eight.
      +
      _9 +
      Nine.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,Option<Digit>>fromChar +
      First-class conversion from a character to a digit.
      +
      static F<java.lang.Long,Digit>fromLong +
      First-class conversion from a long to a digit.
      +
      static F<Digit,java.lang.Character>toChar +
      First-class conversion from a digit to a character.
      +
      static F<Digit,java.lang.Long>toLong +
      First-class conversion from digit to a long.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Option<Digit>fromChar(char c) +
      Converts the given character in the given long value to a digit.
      +
      static DigitfromLong(long i) +
      Converts the right-most digit in the given long value to a digit.
      +
      chartoChar() +
      Converts this digit to a character.
      +
      longtoLong() +
      Converts this digit to a long.
      +
      static DigitvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Digit[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        _0

        +
        public static final Digit _0
        +
        Zero.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static final Digit _1
        +
        One.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static final Digit _2
        +
        Two.
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public static final Digit _3
        +
        Three.
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public static final Digit _4
        +
        Four.
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public static final Digit _5
        +
        Five.
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public static final Digit _6
        +
        Six.
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public static final Digit _7
        +
        Seven.
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public static final Digit _8
        +
        Eight.
        +
        • +
      + + + +
        +
      • +

        _9

        +
        public static final Digit _9
        +
        Nine.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        toLong

        +
        public static final F<Digit,java.lang.Long> toLong
        +
        First-class conversion from digit to a long.
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static final F<java.lang.Long,Digit> fromLong
        +
        First-class conversion from a long to a digit.
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public static final F<Digit,java.lang.Character> toChar
        +
        First-class conversion from a digit to a character.
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static final F<java.lang.Character,Option<Digit>> fromChar
        +
        First-class conversion from a character to a digit.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Digit[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Digit c : Digit.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Digit valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toLong

        +
        public long toLong()
        +
        Converts this digit to a long.
        +
        +
        Returns:
        +
        A long for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public char toChar()
        +
        Converts this digit to a character.
        +
        +
        Returns:
        +
        A character for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static Digit fromLong(long i)
        +
        Converts the right-most digit in the given long value to a digit.
        +
        +
        Parameters:
        +
        i - The long to convert.
        +
        Returns:
        +
        The right-most digit in the given long value as a digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static Option<Digit> fromChar(char c)
        +
        Converts the given character in the given long value to a digit.
        +
        +
        Parameters:
        +
        c - The character to convert.
        +
        Returns:
        +
        The character in the given long value as a digit.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Effect.html b/javadoc/4.8/functionaljava/fj/Effect.html new file mode 100644 index 0000000..2eb859f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Effect.html @@ -0,0 +1,384 @@ + + + + + +Effect (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Effect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Effect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Effect
+extends java.lang.Object
    +
    Represents a side-effect.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Effect1<B>contramap(Effect1<A> e1, + F<B,A> f) +
      A contra-variant functor on effect.
      +
      static P1<Unit>f(Effect0 e) 
      static <A> F<A,Unit>f(Effect1<A> e1) +
      Returns a function for the given effect.
      +
      static <A,B> F2<A,B,Unit>f(Effect2<A,B> e) 
      static <A,B,C> F3<A,B,C,Unit>f(Effect3<A,B,C> e) 
      static <A,B,C,D> F4<A,B,C,D,Unit>f(Effect4<A,B,C,D> e) 
      static <A,B,C,D,E>
      F5<A,B,C,D,E,Unit>      		f(Effect5<A,B,C,D,E> z) 
      static <A,B,C,D,E,$F>
      F6<A,B,C,D,E,$F,Unit>      		f(Effect6<A,B,C,D,E,$F> z) 
      static <A,B,C,D,E,$F,G>
      F7<A,B,C,D,E,$F,G,Unit>      		f(Effect7<A,B,C,D,E,$F,G> z) 
      static <A,B,C,D,E,$F,G,H>
      F8<A,B,C,D,E,$F,G,H,Unit>      		f(Effect8<A,B,C,D,E,$F,G,H> z) 
      static <A> Effect1<A>lazy(F<A,Unit> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        f

        +
        public static <A> F<A,Unit> f(Effect1<A> e1)
        +
        Returns a function for the given effect.
        +
        +
        Returns:
        +
        The function using the given effect.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B> F2<A,B,Unit> f(Effect2<A,B> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C> F3<A,B,C,Unit> f(Effect3<A,B,C> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D> F4<A,B,C,D,Unit> f(Effect4<A,B,C,D> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E> F5<A,B,C,D,E,Unit> f(Effect5<A,B,C,D,E> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F> F6<A,B,C,D,E,$F,Unit> f(Effect6<A,B,C,D,E,$F> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G> F7<A,B,C,D,E,$F,G,Unit> f(Effect7<A,B,C,D,E,$F,G> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G,H> F8<A,B,C,D,E,$F,G,H,Unit> f(Effect8<A,B,C,D,E,$F,G,H> z)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Effect1<B> contramap(Effect1<A> e1,
+                                         F<B,A> f)
        +
        A contra-variant functor on effect.
        +
        +
        Parameters:
        +
        f - The function to map over the effect.
        +
        Returns:
        +
        An effect after a contra-variant map.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> Effect1<A> lazy(F<A,Unit> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Equal.AltDefinition.html b/javadoc/4.8/functionaljava/fj/Equal.AltDefinition.html new file mode 100644 index 0000000..0d5b657 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Equal.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Equal.AltDefinition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Equal.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Equal<A>
    +
    +
    +
    +
    public static interface Equal.AltDefinition<A>
+extends Equal.Definition<A>
    +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Equal.Definition.html b/javadoc/4.8/functionaljava/fj/Equal.Definition.html new file mode 100644 index 0000000..bc0e3f8 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Equal.Definition.html @@ -0,0 +1,291 @@ + + + + + +Equal.Definition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.Definition<A>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        equal

        +
        F<A,java.lang.Boolean> equal(A a)
        +
        • +
      + + + + + +
        +
      • +

        equal

        +
        default boolean equal(A a1,
+                      A a2)
        +
        • +
      + + + +
        +
      • +

        then

        +
        default <B> Equal.Definition<A> then(F<A,B> f,
+                                     Equal<B> eq)
        +
        Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
        +
        +
        Parameters:
        +
        f - The function to map the original object
        +
        eq - Equality for the mapped object
        +
        Returns:
        +
        A new equal definition
        +
        See Also:
        +
        equal()
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        default Equal<A> equal()
        +
        Build an equal instance from this definition. + to be called after some successive then(F, Equal) calls.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Equal.html b/javadoc/4.8/functionaljava/fj/Equal.html new file mode 100644 index 0000000..4e59f41 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Equal.html @@ -0,0 +1,1651 @@ + + + + + +Equal (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Equal<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Equal<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Equal<A>
+extends java.lang.Object
    +
    Tests for equality between two objects.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEqual

        +
        public static final Equal<java.lang.Boolean> booleanEqual
        +
        An equal instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteEqual

        +
        public static final Equal<java.lang.Byte> byteEqual
        +
        An equal instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charEqual

        +
        public static final Equal<java.lang.Character> charEqual
        +
        An equal instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleEqual

        +
        public static final Equal<java.lang.Double> doubleEqual
        +
        An equal instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatEqual

        +
        public static final Equal<java.lang.Float> floatEqual
        +
        An equal instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intEqual

        +
        public static final Equal<java.lang.Integer> intEqual
        +
        An equal instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintEqual

        +
        public static final Equal<java.math.BigInteger> bigintEqual
        +
        An equal instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEqual

        +
        public static final Equal<java.math.BigDecimal> bigdecimalEqual
        +
        An equal instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longEqual

        +
        public static final Equal<java.lang.Long> longEqual
        +
        An equal instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortEqual

        +
        public static final Equal<java.lang.Short> shortEqual
        +
        An equal instance for the short type.
        +
        • +
      + + + +
        +
      • +

        naturalEqual

        +
        public static final Equal<Natural> naturalEqual
        +
        An equal instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringEqual

        +
        public static final Equal<java.lang.String> stringEqual
        +
        An equal instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferEqual

        +
        public static final Equal<java.lang.StringBuffer> stringBufferEqual
        +
        An equal instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderEqual

        +
        public static final Equal<java.lang.StringBuilder> stringBuilderEqual
        +
        An equal instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        bitSetSequal

        +
        public static final Equal<BitSet> bitSetSequal
        +
        An equal instance for the BitSet type.
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static final Equal<LazyString> eq
        +
        An equal instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static final Equal<HList.HNil> hListEqual
        +
        An equal instance for the empty heterogeneous list.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the two given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for equality against another.
        +
        a2 - An object to test for equality against another.
        +
        Returns:
        +
        true if the two given arguments are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        notEq

        +
        public boolean notEq(A a1,
+                     A a2)
        +
        Returns true if the two given arguments are not equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for inequality against another.
        +
        a2 - An object to test for inequality against another.
        +
        Returns:
        +
        true if the two given arguments are not equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public F2<A,A,java.lang.Boolean> eq()
        +
        First-class equality check.
        +
        +
        Returns:
        +
        A function that returns true if the two given arguments are equal.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public F<A,java.lang.Boolean> eq(A a)
        +
        Partially applied equality check.
        +
        +
        Parameters:
        +
        a - An object to test for equality against another.
        +
        Returns:
        +
        A function that returns true if the given argument equals the argument to this method.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Equal<B> contramap(F<B,A> f)
        +
        Maps the given function across this equal as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new equal.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public final Equal<A> not()
        +
        An equal instance, which reverts equality for self
        +
        +
        Returns:
        +
        A new equal instance
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Equal<A> contramap(F<A,B> f,
+                                       Equal<B> eq)
        +
        Static version of contramap(F)
        +
        • +
      + + + + + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F<A,F<A,java.lang.Boolean>> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F2<A,A,java.lang.Boolean> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.Definition<A> definition)
        +
        Constructs an equal instance from the given definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.AltDefinition<A> definition)
        +
        Constructs an equal instance from the given (alternative) definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyEqual

        +
        public static <A> Equal<A> anyEqual()
        +
        Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        Returns:
        +
        An equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        • +
      + + + +
        +
      • +

        eitherEqual

        +
        public static <A,B> Equal<Either<A,B>> eitherEqual(Equal<A> ea,
+                                                   Equal<B> eb)
        +
        An equal instance for the Either type.
        +
        +
        Parameters:
        +
        ea - Equality across the left side of Either.
        +
        eb - Equality across the right side of Either.
        +
        Returns:
        +
        An equal instance for the Either type.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        validationEqual

        +
        public static <A,B> Equal<Validation<A,B>> validationEqual(Equal<A> ea,
+                                                           Equal<B> eb)
        +
        An equal instance for the Validation type.
        +
        +
        Parameters:
        +
        ea - Equality across the failing side of Validation.
        +
        eb - Equality across the succeeding side of Validation.
        +
        Returns:
        +
        An equal instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listEqual

        +
        public static <A> Equal<List<A>> listEqual(Equal<A> ea)
        +
        An equal instance for the List type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the list.
        +
        Returns:
        +
        An equal instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListEqual

        +
        public static <A> Equal<NonEmptyList<A>> nonEmptyListEqual(Equal<A> ea)
        +
        An equal instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the non-empty list.
        +
        Returns:
        +
        An equal instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionEqual

        +
        public static <A> Equal<Option<A>> optionEqual(Equal<A> ea)
        +
        An equal instance for the Option type.
        +
        +
        Parameters:
        +
        ea - Equality across the element of the option.
        +
        Returns:
        +
        An equal instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqEqual

        +
        public static <A> Equal<Seq<A>> seqEqual(Equal<A> e)
        +
        • +
      + + + +
        +
      • +

        streamEqual

        +
        public static <A> Equal<Stream<A>> streamEqual(Equal<A> ea)
        +
        An equal instance for the Stream type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the stream.
        +
        Returns:
        +
        An equal instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperEqual

        +
        public static <A> Equal<Zipper<A>> zipperEqual(Equal<A> ea)
        +
        An equal instance for the Zipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the zipper.
        +
        Returns:
        +
        An equal instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperEqual

        +
        public static <A> Equal<TreeZipper<A>> treeZipperEqual(Equal<A> ea)
        +
        An equal instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree zipper.
        +
        Returns:
        +
        An equal instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayEqual

        +
        public static <A> Equal<Array<A>> arrayEqual(Equal<A> ea)
        +
        An equal instance for the Array type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the array.
        +
        Returns:
        +
        An equal instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        treeEqual

        +
        public static <A> Equal<Tree<A>> treeEqual(Equal<A> ea)
        +
        An equal instance for the Tree type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree.
        +
        Returns:
        +
        An equal instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Equal

        +
        public static <A> Equal<P1<A>> p1Equal(Equal<A> ea)
        +
        An equal instance for a product-1.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        Returns:
        +
        An equal instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Equal

        +
        public static <A,B> Equal<P2<A,B>> p2Equal(Equal<A> ea,
+                                           Equal<B> eb)
        +
        An equal instance for a product-2.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        Returns:
        +
        An equal instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Equal

        +
        public static <A,B,C> Equal<P3<A,B,C>> p3Equal(Equal<A> ea,
+                                               Equal<B> eb,
+                                               Equal<C> ec)
        +
        An equal instance for a product-3.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        Returns:
        +
        An equal instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Equal

        +
        public static <A,B,C,D> Equal<P4<A,B,C,D>> p4Equal(Equal<A> ea,
+                                                   Equal<B> eb,
+                                                   Equal<C> ec,
+                                                   Equal<D> ed)
        +
        An equal instance for a product-4.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        Returns:
        +
        An equal instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Equal

        +
        public static <A,B,C,D,E> Equal<P5<A,B,C,D,E>> p5Equal(Equal<A> ea,
+                                                       Equal<B> eb,
+                                                       Equal<C> ec,
+                                                       Equal<D> ed,
+                                                       Equal<E> ee)
        +
        An equal instance for a product-5.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        Returns:
        +
        An equal instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Equal

        +
        public static <A,B,C,D,E,F$> Equal<P6<A,B,C,D,E,F$>> p6Equal(Equal<A> ea,
+                                                             Equal<B> eb,
+                                                             Equal<C> ec,
+                                                             Equal<D> ed,
+                                                             Equal<E> ee,
+                                                             Equal<F$> ef)
        +
        An equal instance for a product-6.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        Returns:
        +
        An equal instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Equal

        +
        public static <A,B,C,D,E,F$,G> Equal<P7<A,B,C,D,E,F$,G>> p7Equal(Equal<A> ea,
+                                                                 Equal<B> eb,
+                                                                 Equal<C> ec,
+                                                                 Equal<D> ed,
+                                                                 Equal<E> ee,
+                                                                 Equal<F$> ef,
+                                                                 Equal<G> eg)
        +
        An equal instance for a product-7.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        Returns:
        +
        An equal instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Equal

        +
        public static <A,B,C,D,E,F$,G,H> Equal<P8<A,B,C,D,E,F$,G,H>> p8Equal(Equal<A> ea,
+                                                                     Equal<B> eb,
+                                                                     Equal<C> ec,
+                                                                     Equal<D> ed,
+                                                                     Equal<E> ee,
+                                                                     Equal<F$> ef,
+                                                                     Equal<G> eg,
+                                                                     Equal<H> eh)
        +
        An equal instance for a product-8.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        eh - Equality across the eighth element of the product.
        +
        Returns:
        +
        An equal instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Equal

        +
        public static <A> Equal<V2<A>> v2Equal(Equal<A> ea)
        +
        An equal instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Equal

        +
        public static <A> Equal<V3<A>> v3Equal(Equal<A> ea)
        +
        An equal instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Equal

        +
        public static <A> Equal<V4<A>> v4Equal(Equal<A> ea)
        +
        An equal instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Equal

        +
        public static <A> Equal<V5<A>> v5Equal(Equal<A> ea)
        +
        An equal instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Equal

        +
        public static <A> Equal<V6<A>> v6Equal(Equal<A> ea)
        +
        An equal instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Equal

        +
        public static <A> Equal<V7<A>> v7Equal(Equal<A> ea)
        +
        An equal instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Equal

        +
        public static <A> Equal<V8<A>> v8Equal(Equal<A> ea)
        +
        An equal instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static <E,L extends HList<L>> Equal<HList.HCons<E,L>> hListEqual(Equal<E> e,
+                                                                        Equal<L> l)
        +
        An equal instance for heterogeneous lists.
        +
        +
        Parameters:
        +
        e - Equality for the first element of the list.
        +
        l - Equality for the rest of the list.
        +
        Returns:
        +
        an equal instance for a heterogeneous list.
        +
        +
        • +
      + + + +
        +
      • +

        setEqual

        +
        public static <A> Equal<Set<A>> setEqual(Equal<A> e)
        +
        Equal instance for sets.
        +
        +
        Parameters:
        +
        e - Equality for the set elements.
        +
        Returns:
        +
        An equal instance for sets.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writerEqual

        +
        public static <A,B> Equal<Writer<A,B>> writerEqual(Equal<A> eq1,
+                                                   Equal<B> eq2)
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  Equal<A> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - an equal instance for the type of self (that use anyEqual() if generic type).
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  F0<Equal<A>> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - a lazy equal instance for the type (that use anyEqual() if generic type)..
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F.html b/javadoc/4.8/functionaljava/fj/F.html new file mode 100644 index 0000000..ab521dc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F.html @@ -0,0 +1,236 @@ + + + + + +F (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F<A,B>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F1W, F1W.F1WFunc
    +
    +
    +
    +
    public interface F<A,B>
    +
    A transformation or function from A to B. This type can be represented + using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
        +
        Transform A to B.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F0.html b/javadoc/4.8/functionaljava/fj/F0.html new file mode 100644 index 0000000..fd90d78 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F0.html @@ -0,0 +1,224 @@ + + + + + +F0 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F0<A>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    $, P1
    +
    +
    +
    +
    public interface F0<A>
    +
    Created by MarkPerry on 21/01/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F1Functions.html b/javadoc/4.8/functionaljava/fj/F1Functions.html new file mode 100644 index 0000000..c452b03 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F1Functions.html @@ -0,0 +1,1691 @@ + + + + + +F1Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F1Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F1Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<F<B,C>,F<A,C>>andThen(F<A,B> f) +
      First-class composition flipped.
      +
      static <A,B,C> F<A,C>andThen(F<A,B> f, + F<B,C> g) +
      Function composition flipped.
      +
      static <A,B,C> F<F<A,F<B,C>>,F<A,C>>apply(F<A,B> f) +
      First-class function application in an environment.
      +
      static <A,B,C> F<A,C>apply(F<A,B> f, + F<A,F<B,C>> g) +
      Function application in an environment (Applicative Functor).
      +
      static <A,B> F<A,Array<B>>arrayK(F<A,B> f) +
      Promotes this function so that it returns its result in a Array.
      +
      static <A,B,C> F<F<B,F<A,C>>,F<A,C>>bind(F<A,B> f) +
      First-class function binding.
      +
      static <A,B,C> F<A,C>bind(F<A,B> f, + F<B,F<A,C>> g) +
      Binds a given function across this function (Reader Monad).
      +
      static <A,B,C> F<C,B>contramap(F<A,B> target, + F<C,A> f) 
      static <A,B> F<Actor<B>,Actor<A>>contramapActor(F<A,B> f) +
      Returns a function that contramaps over a given actor.
      +
      static <A,B> F<Equal<B>,Equal<A>>contramapEqual(F<A,B> f) +
      Promotes this function to map over an Equal as a contravariant functor.
      +
      static <A,B> F<Hash<B>,Hash<A>>contramapHash(F<A,B> f) +
      Promotes this function to map over a Hash as a contravariant functor.
      +
      static <A,B> F<Show<B>,Show<A>>contramapShow(F<A,B> f) +
      Promotes this function to map over a Show as a contravariant functor.
      +
      static <A,B,C,D> F<C,D>dimap(F<A,B> target, + F<C,A> f, + F<B,D> g) +
      Both map (with g) and contramap (with f) the target function.
      +
      static <A,B,C> F<A,Either<B,C>>eitherLeftK(F<A,B> f) +
      Promotes this function so that it returns its result on the left side of an Either.
      +
      static <A,B,C> F<A,Either<C,B>>eitherRightK(F<A,B> f) +
      Promotes this function so that it returns its result on the right side of an Either.
      +
      static <A,B> P1<B>f(F<A,B> f, + A a) +
      Partial application.
      +
      static <A,B,C> F<A,Validation<B,C>>failK(F<A,B> f) +
      Promotes this function so that it returns its result on the failure side of a Validation.
      +
      static <A,B> F<Tree<A>,B>foldMapTree(F<A,B> f, + Monoid<B> m) +
      Returns a function that maps this function over a tree and folds it with the given monoid.
      +
      static <A,B> F<A,IterableW<B>>iterableK(F<A,B> f) +
      Promotes this function to return its value in an Iterable.
      +
      static <A,B> F<A,P1<B>>lazy(F<A,B> f) +
      Promotes this function so that it returns its result in a product-1.
      +
      static <A,B> F<A,List<B>>listK(F<A,B> f) +
      Promotes this function so that it returns its result in a List.
      +
      static <A,B,C> F<A,C>map(F<A,B> target, + F<B,C> f) 
      static <A,B> F<Array<A>,Array<B>>mapArray(F<A,B> f) +
      Promotes this function to map over a Array.
      +
      static <A,B> F<P2<A,A>,P2<B,B>>mapBoth(F<A,B> f) +
      Promotes this function to map over both elements of a pair.
      +
      static <A,B,X> F<Validation<A,X>,Validation<B,X>>mapFail(F<A,B> f) +
      Promotes this function to map over the failure side of a Validation.
      +
      static <A,B,C> F<P2<A,C>,P2<B,C>>mapFst(F<A,B> f) +
      Promotes this function to map over the first element of a pair.
      +
      static <A,B> F<java.lang.Iterable<A>,IterableW<B>>mapIterable(F<A,B> f) +
      Promotes this function to map over Iterables.
      +
      static <A,B> java.util.concurrent.ArrayBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.ArrayBlockingQueue<A> as) +
      Maps this function over an ArrayBlockingQueue.
      +
      static <A,B> java.util.ArrayList<B>mapJ(F<A,B> f, + java.util.ArrayList<A> as) +
      Maps this function over an ArrayList.
      +
      static <A,B> java.util.concurrent.ConcurrentLinkedQueue<B>mapJ(F<A,B> f, + java.util.concurrent.ConcurrentLinkedQueue<A> as) +
      Maps this function over a ConcurrentLinkedQueue.
      +
      static <A,B> java.util.concurrent.CopyOnWriteArrayList<B>mapJ(F<A,B> f, + java.util.concurrent.CopyOnWriteArrayList<A> as) +
      Maps this function over a CopyOnWriteArrayList.
      +
      static <A,B> java.util.concurrent.CopyOnWriteArraySet<B>mapJ(F<A,B> f, + java.util.concurrent.CopyOnWriteArraySet<A> as) +
      Maps this function over a CopyOnWriteArraySet.
      +
      static <A,B> java.util.concurrent.LinkedBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.LinkedBlockingQueue<A> as) +
      Maps this function over a LinkedBlockingQueue.
      +
      static <A,B> java.util.LinkedList<B>mapJ(F<A,B> f, + java.util.LinkedList<A> as) +
      Maps this function over a LinkedList.
      +
      static <A,B> java.util.concurrent.PriorityBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.PriorityBlockingQueue<A> as) +
      Maps this function over a PriorityBlockingQueue.
      +
      static <A,B> java.util.PriorityQueue<B>mapJ(F<A,B> f, + java.util.PriorityQueue<A> as) +
      Maps this function over a PriorityQueue.
      +
      static <A,B> java.util.concurrent.SynchronousQueue<B>mapJ(F<A,B> f, + java.util.concurrent.SynchronousQueue<A> as) +
      Maps this function over a SynchronousQueue.
      +
      static <A,B> java.util.TreeSet<B>mapJ(F<A,B> f, + java.util.TreeSet<A> as) +
      Maps this function over a TreeSet.
      +
      static <A,B,X> F<Either<A,X>,Either<B,X>>mapLeft(F<A,B> f) +
      Promotes this function to map over the left side of an Either.
      +
      static <A,B> F<List<A>,List<B>>mapList(F<A,B> f) +
      Promotes this function to map over a List.
      +
      static <A,B> F<NonEmptyList<A>,NonEmptyList<B>>mapNel(F<A,B> f) +
      Promotes this function to map over a NonEmptyList.
      +
      static <A,B> F<Option<A>,Option<B>>mapOption(F<A,B> f) +
      Promotes this function to map over an optional value.
      +
      static <A,B> F<P1<A>,P1<B>>mapP1(F<A,B> f) +
      Promotes this function to map over a product-1.
      +
      static <A,B> F<Promise<A>,Promise<B>>mapPromise(F<A,B> f) +
      Promotes this function to map over a Promise.
      +
      static <A,B,X> F<Either<X,A>,Either<X,B>>mapRight(F<A,B> f) +
      Promotes this function to map over the right side of an Either.
      +
      static <A,B> F<Set<A>,Set<B>>mapSet(F<A,B> f, + Ord<B> o) +
      Promotes this function to map over a Set.
      +
      static <A,B,C> F<P2<C,A>,P2<C,B>>mapSnd(F<A,B> f) +
      Promotes this function to map over the second element of a pair.
      +
      static <A,B> F<Stream<A>,Stream<B>>mapStream(F<A,B> f) +
      Promotes this function to map over a Stream.
      +
      static <A,B,X> F<Validation<X,A>,Validation<X,B>>mapSuccess(F<A,B> f) +
      Promotes this function to map over the success side of a Validation.
      +
      static <A,B> F<Tree<A>,Tree<B>>mapTree(F<A,B> f) +
      Promotes this function to map over a Tree.
      +
      static <A,B> F<TreeZipper<A>,TreeZipper<B>>mapTreeZipper(F<A,B> f) +
      Promotes this function to map over a TreeZipper.
      +
      static <A,B> F<Zipper<A>,Zipper<B>>mapZipper(F<A,B> f) +
      Promotes this function to map over a Zipper.
      +
      static <A,B> F<A,NonEmptyList<B>>nelK(F<A,B> f) +
      Promotes this function to return its value in a NonEmptyList.
      +
      static <A,B,C> F<F<C,A>,F<C,B>>o(F<A,B> f) +
      First-class function composition
      +
      static <A,B,C> F<C,B>o(F<A,B> f, + F<C,A> g) +
      Function composition
      +
      static <A,B,C> F<F<B,F<B,C>>,F<A,F<A,C>>>on(F<A,B> f) +
      Applies this function over the arguments of another function.
      +
      static <A,B,C> F<A,F<A,C>>on(F<A,B> f, + F<B,F<B,C>> g) +
      Applies this function over the arguments of another function.
      +
      static <A,B> F<Validation<B,A>,B>onFail(F<A,B> f) +
      Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
      +
      static <A,B> F<Either<B,A>,B>onLeft(F<A,B> f) +
      Returns a function that returns the left side of a given Either, or this function applied to the right side.
      +
      static <A,B> F<Either<A,B>,B>onRight(F<A,B> f) +
      Returns a function that returns the right side of a given Either, or this function applied to the left side.
      +
      static <A,B> F<Validation<A,B>,B>onSuccess(F<A,B> f) +
      Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
      +
      static <A,B> F<A,Option<B>>optionK(F<A,B> f) +
      Promotes this function so that it returns its result in an Option.
      +
      static <A,B> F<A,Promise<B>>promiseK(F<A,B> f, + Strategy<Unit> s) +
      Promotes this function to a concurrent function that returns a Promise of a value.
      +
      static <A,B> F<A,Set<B>>setK(F<A,B> f, + Ord<B> o) +
      Promotes this function to return its value in a Set.
      +
      static <A,B> F<A,Stream<B>>streamK(F<A,B> f) +
      Promotes this function so that it returns its result in a Stream.
      +
      static <A,B,C> F<A,Validation<C,B>>successK(F<A,B> f) +
      Promotes this function so that it returns its result on the success side of an Validation.
      +
      static <A,B> F<A,Tree<B>>treeK(F<A,B> f) +
      Promotes this function to return its value in a Tree.
      +
      static <A,B> F<A,TreeZipper<B>>treeZipperK(F<A,B> f) +
      Promotes this function to return its value in a TreeZipper.
      +
      static <A,B> F<A,Zipper<B>>zipperK(F<A,B> f) +
      Promotes this function to return its value in a Zipper.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        o

        +
        public static <A,B,C> F<C,B> o(F<A,B> f,
+                               F<C,A> g)
        +
        Function composition
        +
        +
        Parameters:
        +
        g - A function to compose with this one.
        +
        Returns:
        +
        The composed function such that this function is applied last.
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        public static <A,B,C> F<F<C,A>,F<C,B>> o(F<A,B> f)
        +
        First-class function composition
        +
        +
        Returns:
        +
        A function that composes this function with another.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<A,C> andThen(F<A,B> f,
+                                     F<B,C> g)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function with which to compose this one.
        +
        Returns:
        +
        The composed function such that this function is applied first.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<F<B,C>,F<A,C>> andThen(F<A,B> f)
        +
        First-class composition flipped.
        +
        +
        Returns:
        +
        A function that invokes this function and then a given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<A,C> bind(F<A,B> f,
+                                  F<B,F<A,C>> g)
        +
        Binds a given function across this function (Reader Monad).
        +
        +
        Parameters:
        +
        g - A function that takes the return value of this function as an argument, yielding a new function.
        +
        Returns:
        +
        A function that invokes this function on its argument and then the given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<F<B,F<A,C>>,F<A,C>> bind(F<A,B> f)
        +
        First-class function binding.
        +
        +
        Returns:
        +
        A function that binds another function across this function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<A,C> apply(F<A,B> f,
+                                   F<A,F<B,C>> g)
        +
        Function application in an environment (Applicative Functor).
        +
        +
        Parameters:
        +
        g - A function with the same argument type as this function, yielding a function that takes the return + value of this function.
        +
        Returns:
        +
        A new function that invokes the given function on its argument, yielding a new function that is then + applied to the result of applying this function to the argument.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<F<A,F<B,C>>,F<A,C>> apply(F<A,B> f)
        +
        First-class function application in an environment.
        +
        +
        Returns:
        +
        A function that applies a given function within the environment of this function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<A,F<A,C>> on(F<A,B> f,
+                                     F<B,F<B,C>> g)
        +
        Applies this function over the arguments of another function.
        +
        +
        Parameters:
        +
        g - The function over whose arguments to apply this function.
        +
        Returns:
        +
        A new function that invokes this function on its arguments before invoking the given function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<F<B,F<B,C>>,F<A,F<A,C>>> on(F<A,B> f)
        +
        Applies this function over the arguments of another function.
        +
        +
        Returns:
        +
        A function that applies this function over the arguments of another function.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> F<A,P1<B>> lazy(F<A,B> f)
        +
        Promotes this function so that it returns its result in a product-1. Kleisli arrow for P1.
        +
        +
        Returns:
        +
        This function promoted to return its result in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        public static <A,B> P1<B> f(F<A,B> f,
+                            A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument to return a lazy value.
        +
        +
        • +
      + + + +
        +
      • +

        mapP1

        +
        public static <A,B> F<P1<A>,P1<B>> mapP1(F<A,B> f)
        +
        Promotes this function to map over a product-1.
        +
        +
        Returns:
        +
        This function promoted to map over a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        optionK

        +
        public static <A,B> F<A,Option<B>> optionK(F<A,B> f)
        +
        Promotes this function so that it returns its result in an Option. Kleisli arrow for Option.
        +
        +
        Returns:
        +
        This function promoted to return its result in an Option.
        +
        +
        • +
      + + + +
        +
      • +

        mapOption

        +
        public static <A,B> F<Option<A>,Option<B>> mapOption(F<A,B> f)
        +
        Promotes this function to map over an optional value.
        +
        +
        Returns:
        +
        This function promoted to map over an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        listK

        +
        public static <A,B> F<A,List<B>> listK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a List. Kleisli arrow for List.
        +
        +
        Returns:
        +
        This function promoted to return its result in a List.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public static <A,B> F<List<A>,List<B>> mapList(F<A,B> f)
        +
        Promotes this function to map over a List.
        +
        +
        Returns:
        +
        This function promoted to map over a List.
        +
        +
        • +
      + + + +
        +
      • +

        streamK

        +
        public static <A,B> F<A,Stream<B>> streamK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a Stream. Kleisli arrow for Stream.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public static <A,B> F<Stream<A>,Stream<B>> mapStream(F<A,B> f)
        +
        Promotes this function to map over a Stream.
        +
        +
        Returns:
        +
        This function promoted to map over a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        arrayK

        +
        public static <A,B> F<A,Array<B>> arrayK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a Array. Kleisli arrow for Array.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Array.
        +
        +
        • +
      + + + +
        +
      • +

        mapArray

        +
        public static <A,B> F<Array<A>,Array<B>> mapArray(F<A,B> f)
        +
        Promotes this function to map over a Array.
        +
        +
        Returns:
        +
        This function promoted to map over a Array.
        +
        +
        • +
      + + + +
        +
      • +

        contramapActor

        +
        public static <A,B> F<Actor<B>,Actor<A>> contramapActor(F<A,B> f)
        +
        Returns a function that contramaps over a given actor.
        +
        +
        Returns:
        +
        A function that contramaps over a given actor.
        +
        +
        • +
      + + + +
        +
      • +

        promiseK

        +
        public static <A,B> F<A,Promise<B>> promiseK(F<A,B> f,
+                                             Strategy<Unit> s)
        +
        Promotes this function to a concurrent function that returns a Promise of a value.
        +
        +
        Parameters:
        +
        s - A parallel strategy for concurrent execution.
        +
        Returns:
        +
        A concurrent function that returns a Promise of a value.
        +
        +
        • +
      + + + +
        +
      • +

        mapPromise

        +
        public static <A,B> F<Promise<A>,Promise<B>> mapPromise(F<A,B> f)
        +
        Promotes this function to map over a Promise.
        +
        +
        Returns:
        +
        This function promoted to map over Promises.
        +
        +
        • +
      + + + +
        +
      • +

        eitherLeftK

        +
        public static <A,B,C> F<A,Either<B,C>> eitherLeftK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the left side of an Either. + Kleisli arrow for the Either left projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        eitherRightK

        +
        public static <A,B,C> F<A,Either<C,B>> eitherRightK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the right side of an Either. + Kleisli arrow for the Either right projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapLeft

        +
        public static <A,B,X> F<Either<A,X>,Either<B,X>> mapLeft(F<A,B> f)
        +
        Promotes this function to map over the left side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapRight

        +
        public static <A,B,X> F<Either<X,A>,Either<X,B>> mapRight(F<A,B> f)
        +
        Promotes this function to map over the right side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        onLeft

        +
        public static <A,B> F<Either<B,A>,B> onLeft(F<A,B> f)
        +
        Returns a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        Returns:
        +
        a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        • +
      + + + +
        +
      • +

        onRight

        +
        public static <A,B> F<Either<A,B>,B> onRight(F<A,B> f)
        +
        Returns a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        Returns:
        +
        a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        • +
      + + + +
        +
      • +

        iterableK

        +
        public static <A,B> F<A,IterableW<B>> iterableK(F<A,B> f)
        +
        Promotes this function to return its value in an Iterable.
        +
        +
        Returns:
        +
        This function promoted to return its value in an Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        mapIterable

        +
        public static <A,B> F<java.lang.Iterable<A>,IterableW<B>> mapIterable(F<A,B> f)
        +
        Promotes this function to map over Iterables.
        +
        +
        Returns:
        +
        This function promoted to map over Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        nelK

        +
        public static <A,B> F<A,NonEmptyList<B>> nelK(F<A,B> f)
        +
        Promotes this function to return its value in a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to return its value in a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        mapNel

        +
        public static <A,B> F<NonEmptyList<A>,NonEmptyList<B>> mapNel(F<A,B> f)
        +
        Promotes this function to map over a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to map over a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        setK

        +
        public static <A,B> F<A,Set<B>> setK(F<A,B> f,
+                                     Ord<B> o)
        +
        Promotes this function to return its value in a Set.
        +
        +
        Parameters:
        +
        o - An order for the set.
        +
        Returns:
        +
        This function promoted to return its value in a Set.
        +
        +
        • +
      + + + +
        +
      • +

        mapSet

        +
        public static <A,B> F<Set<A>,Set<B>> mapSet(F<A,B> f,
+                                            Ord<B> o)
        +
        Promotes this function to map over a Set.
        +
        +
        Parameters:
        +
        o - An order for the resulting set.
        +
        Returns:
        +
        This function promoted to map over a Set.
        +
        +
        • +
      + + + +
        +
      • +

        treeK

        +
        public static <A,B> F<A,Tree<B>> treeK(F<A,B> f)
        +
        Promotes this function to return its value in a Tree.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        mapTree

        +
        public static <A,B> F<Tree<A>,Tree<B>> mapTree(F<A,B> f)
        +
        Promotes this function to map over a Tree.
        +
        +
        Returns:
        +
        This function promoted to map over a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapTree

        +
        public static <A,B> F<Tree<A>,B> foldMapTree(F<A,B> f,
+                                             Monoid<B> m)
        +
        Returns a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        Parameters:
        +
        m - The monoid with which to fold the mapped tree.
        +
        Returns:
        +
        a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperK

        +
        public static <A,B> F<A,TreeZipper<B>> treeZipperK(F<A,B> f)
        +
        Promotes this function to return its value in a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapTreeZipper

        +
        public static <A,B> F<TreeZipper<A>,TreeZipper<B>> mapTreeZipper(F<A,B> f)
        +
        Promotes this function to map over a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to map over a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        failK

        +
        public static <A,B,C> F<A,Validation<B,C>> failK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the failure side of a Validation. + Kleisli arrow for the Validation failure projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        successK

        +
        public static <A,B,C> F<A,Validation<C,B>> successK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the success side of an Validation. + Kleisli arrow for the Validation success projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the success side of an Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapFail

        +
        public static <A,B,X> F<Validation<A,X>,Validation<B,X>> mapFail(F<A,B> f)
        +
        Promotes this function to map over the failure side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapSuccess

        +
        public static <A,B,X> F<Validation<X,A>,Validation<X,B>> mapSuccess(F<A,B> f)
        +
        Promotes this function to map over the success side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the success side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        onFail

        +
        public static <A,B> F<Validation<B,A>,B> onFail(F<A,B> f)
        +
        Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        Returns:
        +
        a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        public static <A,B> F<Validation<A,B>,B> onSuccess(F<A,B> f)
        +
        Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        Returns:
        +
        a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        • +
      + + + +
        +
      • +

        zipperK

        +
        public static <A,B> F<A,Zipper<B>> zipperK(F<A,B> f)
        +
        Promotes this function to return its value in a Zipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapZipper

        +
        public static <A,B> F<Zipper<A>,Zipper<B>> mapZipper(F<A,B> f)
        +
        Promotes this function to map over a Zipper.
        +
        +
        Returns:
        +
        This function promoted to map over a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        contramapEqual

        +
        public static <A,B> F<Equal<B>,Equal<A>> contramapEqual(F<A,B> f)
        +
        Promotes this function to map over an Equal as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over an Equal as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapHash

        +
        public static <A,B> F<Hash<B>,Hash<A>> contramapHash(F<A,B> f)
        +
        Promotes this function to map over a Hash as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Hash as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapShow

        +
        public static <A,B> F<Show<B>,Show<A>> contramapShow(F<A,B> f)
        +
        Promotes this function to map over a Show as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Show as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        mapFst

        +
        public static <A,B,C> F<P2<A,C>,P2<B,C>> mapFst(F<A,B> f)
        +
        Promotes this function to map over the first element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the first element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapSnd

        +
        public static <A,B,C> F<P2<C,A>,P2<C,B>> mapSnd(F<A,B> f)
        +
        Promotes this function to map over the second element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the second element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapBoth

        +
        public static <A,B> F<P2<A,A>,P2<B,B>> mapBoth(F<A,B> f)
        +
        Promotes this function to map over both elements of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over both elements of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.SynchronousQueue<B> mapJ(F<A,B> f,
+                                                                  java.util.concurrent.SynchronousQueue<A> as)
        +
        Maps this function over a SynchronousQueue.
        +
        +
        Parameters:
        +
        as - A SynchronousQueue to map this function over.
        +
        Returns:
        +
        A new SynchronousQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.PriorityBlockingQueue<B> mapJ(F<A,B> f,
+                                                                       java.util.concurrent.PriorityBlockingQueue<A> as)
        +
        Maps this function over a PriorityBlockingQueue.
        +
        +
        Parameters:
        +
        as - A PriorityBlockingQueue to map this function over.
        +
        Returns:
        +
        A new PriorityBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.LinkedBlockingQueue<B> mapJ(F<A,B> f,
+                                                                     java.util.concurrent.LinkedBlockingQueue<A> as)
        +
        Maps this function over a LinkedBlockingQueue.
        +
        +
        Parameters:
        +
        as - A LinkedBlockingQueue to map this function over.
        +
        Returns:
        +
        A new LinkedBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.CopyOnWriteArraySet<B> mapJ(F<A,B> f,
+                                                                     java.util.concurrent.CopyOnWriteArraySet<A> as)
        +
        Maps this function over a CopyOnWriteArraySet.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArraySet to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArraySet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.CopyOnWriteArrayList<B> mapJ(F<A,B> f,
+                                                                      java.util.concurrent.CopyOnWriteArrayList<A> as)
        +
        Maps this function over a CopyOnWriteArrayList.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArrayList to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.ConcurrentLinkedQueue<B> mapJ(F<A,B> f,
+                                                                       java.util.concurrent.ConcurrentLinkedQueue<A> as)
        +
        Maps this function over a ConcurrentLinkedQueue.
        +
        +
        Parameters:
        +
        as - A ConcurrentLinkedQueue to map this function over.
        +
        Returns:
        +
        A new ConcurrentLinkedQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.ArrayBlockingQueue<B> mapJ(F<A,B> f,
+                                                                    java.util.concurrent.ArrayBlockingQueue<A> as)
        +
        Maps this function over an ArrayBlockingQueue.
        +
        +
        Parameters:
        +
        as - An ArrayBlockingQueue to map this function over.
        +
        Returns:
        +
        A new ArrayBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.TreeSet<B> mapJ(F<A,B> f,
+                                              java.util.TreeSet<A> as)
        +
        Maps this function over a TreeSet.
        +
        +
        Parameters:
        +
        as - A TreeSet to map this function over.
        +
        Returns:
        +
        A new TreeSet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.PriorityQueue<B> mapJ(F<A,B> f,
+                                                    java.util.PriorityQueue<A> as)
        +
        Maps this function over a PriorityQueue.
        +
        +
        Parameters:
        +
        as - A PriorityQueue to map this function over.
        +
        Returns:
        +
        A new PriorityQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.LinkedList<B> mapJ(F<A,B> f,
+                                                 java.util.LinkedList<A> as)
        +
        Maps this function over a LinkedList.
        +
        +
        Parameters:
        +
        as - A LinkedList to map this function over.
        +
        Returns:
        +
        A new LinkedList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.ArrayList<B> mapJ(F<A,B> f,
+                                                java.util.ArrayList<A> as)
        +
        Maps this function over an ArrayList.
        +
        +
        Parameters:
        +
        as - An ArrayList to map this function over.
        +
        Returns:
        +
        A new ArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B,C> F<A,C> map(F<A,B> target,
+                                 F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B,C> F<C,B> contramap(F<A,B> target,
+                                       F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        dimap

        +
        public static <A,B,C,D> F<C,D> dimap(F<A,B> target,
+                                     F<C,A> f,
+                                     F<B,D> g)
        +
        Both map (with g) and contramap (with f) the target function. (Profunctor pattern)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F1W.F1WFunc.html b/javadoc/4.8/functionaljava/fj/F1W.F1WFunc.html new file mode 100644 index 0000000..71157f3 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F1W.F1WFunc.html @@ -0,0 +1,316 @@ + + + + + +F1W.F1WFunc (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F1W.F1WFunc<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1W<A,B>
      • +
    • +
        +
      • fj.F1W.F1WFunc<A,B>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F<A,B>
    +
    +
    +
    Enclosing class:
    +
    F1W<A,B>
    +
    +
    +
    +
    public static class F1W.F1WFunc<A,B>
+extends F1W<A,B>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F1WFunc

        +
        public F1WFunc(F<A,B> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final B f(A a)
        +
        Description copied from interface: F
        +
        Transform A to B.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F1W.html b/javadoc/4.8/functionaljava/fj/F1W.html new file mode 100644 index 0000000..ff66fb0 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F1W.html @@ -0,0 +1,1710 @@ + + + + + +F1W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F1W<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1W<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F<A,B>
    +
    +
    +
    Direct Known Subclasses:
    +
    F1W.F1WFunc
    +
    +
    +
    +
    public abstract class F1W<A,B>
+extends java.lang.Object
+implements F<A,B>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class F1W.F1WFunc<A,B> 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F1W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <C> F1W<F<B,C>,F<A,C>>andThen() +
      First-class composition flipped.
      +
      <C> F1W<A,C>andThen(F<B,C> g) +
      Function composition flipped.
      +
      <C> F1W<F<A,F<B,C>>,F<A,C>>apply() +
      First-class function application in an environment.
      +
      <C> F1W<A,C>apply(F<A,F<B,C>> g) +
      Function application in an environment (Applicative Functor).
      +
      F1W<A,Array<B>>arrayK() +
      Promotes this function so that it returns its result in a Array.
      +
      <C> F1W<F<B,F<A,C>>,F<A,C>>bind() +
      First-class function binding.
      +
      <C> F1W<A,C>bind(F<B,F<A,C>> g) +
      Binds a given function across this function (Reader Monad).
      +
      <C> F1W<C,B>contramap(F<C,A> f) 
      F1W<Actor<B>,Actor<A>>contramapActor() +
      Returns a function that contramaps over a given actor.
      +
      F1W<Equal<B>,Equal<A>>contramapEqual() +
      Promotes this function to map over an Equal as a contravariant functor.
      +
      F1W<Hash<B>,Hash<A>>contramapHash() +
      Promotes this function to map over a Hash as a contravariant functor.
      +
      F1W<Show<B>,Show<A>>contramapShow() +
      Promotes this function to map over a Show as a contravariant functor.
      +
      <C> F1W<A,Either<B,C>>eitherLeftK() +
      Promotes this function so that it returns its result on the left side of an Either.
      +
      <C> F1W<A,Either<C,B>>eitherRightK() +
      Promotes this function so that it returns its result on the right side of an Either.
      +
      <C> F1W<A,Validation<B,C>>failK() +
      Promotes this function so that it returns its result on the failure side of a Validation.
      +
      F1W<Tree<A>,B>foldMapTree(Monoid<B> m) +
      Returns a function that maps this function over a tree and folds it with the given monoid.
      +
      F1W<A,IterableW<B>>iterableK() +
      Promotes this function to return its value in an Iterable.
      +
      F1W<A,P1<B>>lazy() +
      Promotes this function so that it returns its result in a product-1.
      +
      P1<B>lazy(A a) +
      Partial application.
      +
      static <A,B> F1W<A,B>lift(F<A,B> f) +
      Lifts the function into the fully featured function wrapper
      +
      F1W<A,List<B>>listK() +
      Promotes this function so that it returns its result in a List.
      +
      <C> F1W<A,C>map(F<B,C> f) 
      F1W<Array<A>,Array<B>>mapArray() +
      Promotes this function to map over a Array.
      +
      F1W<P2<A,A>,P2<B,B>>mapBoth() +
      Promotes this function to map over both elements of a pair.
      +
      <X> F1W<Validation<A,X>,Validation<B,X>>mapFail() +
      Promotes this function to map over the failure side of a Validation.
      +
      <C> F1W<P2<A,C>,P2<B,C>>mapFst() +
      Promotes this function to map over the first element of a pair.
      +
      F1W<java.lang.Iterable<A>,IterableW<B>>mapIterable() +
      Promotes this function to map over Iterables.
      +
      java.util.concurrent.ArrayBlockingQueue<B>mapJ(java.util.concurrent.ArrayBlockingQueue<A> as) +
      Maps this function over an ArrayBlockingQueue.
      +
      java.util.ArrayList<B>mapJ(java.util.ArrayList<A> as) +
      Maps this function over an ArrayList.
      +
      java.util.concurrent.ConcurrentLinkedQueue<B>mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as) +
      Maps this function over a ConcurrentLinkedQueue.
      +
      java.util.concurrent.CopyOnWriteArrayList<B>mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as) +
      Maps this function over a CopyOnWriteArrayList.
      +
      java.util.concurrent.CopyOnWriteArraySet<B>mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as) +
      Maps this function over a CopyOnWriteArraySet.
      +
      java.util.concurrent.LinkedBlockingQueue<B>mapJ(java.util.concurrent.LinkedBlockingQueue<A> as) +
      Maps this function over a LinkedBlockingQueue.
      +
      java.util.LinkedList<B>mapJ(java.util.LinkedList<A> as) +
      Maps this function over a LinkedList.
      +
      java.util.concurrent.PriorityBlockingQueue<B>mapJ(java.util.concurrent.PriorityBlockingQueue<A> as) +
      Maps this function over a PriorityBlockingQueue.
      +
      java.util.PriorityQueue<B>mapJ(java.util.PriorityQueue<A> as) +
      Maps this function over a PriorityQueue.
      +
      java.util.concurrent.SynchronousQueue<B>mapJ(java.util.concurrent.SynchronousQueue<A> as) +
      Maps this function over a SynchronousQueue.
      +
      java.util.TreeSet<B>mapJ(java.util.TreeSet<A> as) +
      Maps this function over a TreeSet.
      +
      <X> F1W<Either<A,X>,Either<B,X>>mapLeft() +
      Promotes this function to map over the left side of an Either.
      +
      F1W<List<A>,List<B>>mapList() +
      Promotes this function to map over a List.
      +
      F1W<NonEmptyList<A>,NonEmptyList<B>>mapNel() +
      Promotes this function to map over a NonEmptyList.
      +
      F1W<Option<A>,Option<B>>mapOption() +
      Promotes this function to map over an optional value.
      +
      F1W<P1<A>,P1<B>>mapP1() +
      Promotes this function to map over a product-1.
      +
      F1W<Promise<A>,Promise<B>>mapPromise() +
      Promotes this function to map over a Promise.
      +
      <X> F1W<Either<X,A>,Either<X,B>>mapRight() +
      Promotes this function to map over the right side of an Either.
      +
      F1W<Set<A>,Set<B>>mapSet(Ord<B> o) +
      Promotes this function to map over a Set.
      +
      <C> F1W<P2<C,A>,P2<C,B>>mapSnd() +
      Promotes this function to map over the second element of a pair.
      +
      F1W<Stream<A>,Stream<B>>mapStream() +
      Promotes this function to map over a Stream.
      +
      <X> F1W<Validation<X,A>,Validation<X,B>>mapSuccess() +
      Promotes this function to map over the success side of a Validation.
      +
      F1W<Tree<A>,Tree<B>>mapTree() +
      Promotes this function to map over a Tree.
      +
      F1W<TreeZipper<A>,TreeZipper<B>>mapTreeZipper() +
      Promotes this function to map over a TreeZipper.
      +
      F1W<Zipper<A>,Zipper<B>>mapZipper() +
      Promotes this function to map over a Zipper.
      +
      F1W<A,NonEmptyList<B>>nelK() +
      Promotes this function to return its value in a NonEmptyList.
      +
      <C> F1W<F<C,A>,F<C,B>>o() +
      First-class function composition
      +
      <C> F1W<C,B>o(F<C,A> g) +
      Function composition
      +
      <C> F1W<F<B,F<B,C>>,F<A,F<A,C>>>on() +
      Applies this function over the arguments of another function.
      +
      <C> F1W<A,F<A,C>>on(F<B,F<B,C>> g) +
      Applies this function over the arguments of another function.
      +
      F1W<Validation<B,A>,B>onFail() +
      Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
      +
      F1W<Either<B,A>,B>onLeft() +
      Returns a function that returns the left side of a given Either, or this function applied to the right side.
      +
      F1W<Either<A,B>,B>onRight() +
      Returns a function that returns the right side of a given Either, or this function applied to the left side.
      +
      F1W<Validation<A,B>,B>onSuccess() +
      Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
      +
      F1W<A,Option<B>>optionK() +
      Promotes this function so that it returns its result in an Option.
      +
      F1W<A,Promise<B>>promiseK(Strategy<Unit> s) +
      Promotes this function to a concurrent function that returns a Promise of a value.
      +
      F1W<A,Set<B>>setK(Ord<B> o) +
      Promotes this function to return its value in a Set.
      +
      F1W<A,Stream<B>>streamK() +
      Promotes this function so that it returns its result in a Stream.
      +
      <C> F1W<A,Validation<C,B>>successK() +
      Promotes this function so that it returns its result on the success side of an Validation.
      +
      F1W<A,Tree<B>>treeK() +
      Promotes this function to return its value in a Tree.
      +
      F1W<A,TreeZipper<B>>treeZipperK() +
      Promotes this function to return its value in a TreeZipper.
      +
      F1W<A,Zipper<B>>zipperK() +
      Promotes this function to return its value in a Zipper.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F1W

        +
        public F1W()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        o

        +
        public final <C> F1W<C,B> o(F<C,A> g)
        +
        Function composition
        +
        +
        Parameters:
        +
        g - A function to compose with this one.
        +
        Returns:
        +
        The composed function such that this function is applied last.
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        public final <C> F1W<F<C,A>,F<C,B>> o()
        +
        First-class function composition
        +
        +
        Returns:
        +
        A function that composes this function with another.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> F1W<A,C> andThen(F<B,C> g)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function with which to compose this one.
        +
        Returns:
        +
        The composed function such that this function is applied first.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> F1W<F<B,C>,F<A,C>> andThen()
        +
        First-class composition flipped.
        +
        +
        Returns:
        +
        A function that invokes this function and then a given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <C> F1W<A,C> bind(F<B,F<A,C>> g)
        +
        Binds a given function across this function (Reader Monad).
        +
        +
        Parameters:
        +
        g - A function that takes the return value of this function as an argument, yielding a new function.
        +
        Returns:
        +
        A function that invokes this function on its argument and then the given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <C> F1W<F<B,F<A,C>>,F<A,C>> bind()
        +
        First-class function binding.
        +
        +
        Returns:
        +
        A function that binds another function across this function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <C> F1W<A,C> apply(F<A,F<B,C>> g)
        +
        Function application in an environment (Applicative Functor).
        +
        +
        Parameters:
        +
        g - A function with the same argument type as this function, yielding a function that takes the return + value of this function.
        +
        Returns:
        +
        A new function that invokes the given function on its argument, yielding a new function that is then + applied to the result of applying this function to the argument.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <C> F1W<F<A,F<B,C>>,F<A,C>> apply()
        +
        First-class function application in an environment.
        +
        +
        Returns:
        +
        A function that applies a given function within the environment of this function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final <C> F1W<A,F<A,C>> on(F<B,F<B,C>> g)
        +
        Applies this function over the arguments of another function.
        +
        +
        Parameters:
        +
        g - The function over whose arguments to apply this function.
        +
        Returns:
        +
        A new function that invokes this function on its arguments before invoking the given function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final <C> F1W<F<B,F<B,C>>,F<A,F<A,C>>> on()
        +
        Applies this function over the arguments of another function.
        +
        +
        Returns:
        +
        A function that applies this function over the arguments of another function.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public final F1W<A,P1<B>> lazy()
        +
        Promotes this function so that it returns its result in a product-1. Kleisli arrow for P1.
        +
        +
        Returns:
        +
        This function promoted to return its result in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        lazy

        +
        public final P1<B> lazy(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument to return a lazy value.
        +
        +
        • +
      + + + +
        +
      • +

        mapP1

        +
        public final F1W<P1<A>,P1<B>> mapP1()
        +
        Promotes this function to map over a product-1.
        +
        +
        Returns:
        +
        This function promoted to map over a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        optionK

        +
        public final F1W<A,Option<B>> optionK()
        +
        Promotes this function so that it returns its result in an Option. Kleisli arrow for Option.
        +
        +
        Returns:
        +
        This function promoted to return its result in an Option.
        +
        +
        • +
      + + + +
        +
      • +

        mapOption

        +
        public final F1W<Option<A>,Option<B>> mapOption()
        +
        Promotes this function to map over an optional value.
        +
        +
        Returns:
        +
        This function promoted to map over an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        listK

        +
        public final F1W<A,List<B>> listK()
        +
        Promotes this function so that it returns its result in a List. Kleisli arrow for List.
        +
        +
        Returns:
        +
        This function promoted to return its result in a List.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public final F1W<List<A>,List<B>> mapList()
        +
        Promotes this function to map over a List.
        +
        +
        Returns:
        +
        This function promoted to map over a List.
        +
        +
        • +
      + + + +
        +
      • +

        streamK

        +
        public final F1W<A,Stream<B>> streamK()
        +
        Promotes this function so that it returns its result in a Stream. Kleisli arrow for Stream.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public final F1W<Stream<A>,Stream<B>> mapStream()
        +
        Promotes this function to map over a Stream.
        +
        +
        Returns:
        +
        This function promoted to map over a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        arrayK

        +
        public final F1W<A,Array<B>> arrayK()
        +
        Promotes this function so that it returns its result in a Array. Kleisli arrow for Array.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Array.
        +
        +
        • +
      + + + +
        +
      • +

        mapArray

        +
        public final F1W<Array<A>,Array<B>> mapArray()
        +
        Promotes this function to map over a Array.
        +
        +
        Returns:
        +
        This function promoted to map over a Array.
        +
        +
        • +
      + + + +
        +
      • +

        contramapActor

        +
        public final F1W<Actor<B>,Actor<A>> contramapActor()
        +
        Returns a function that contramaps over a given actor.
        +
        +
        Returns:
        +
        A function that contramaps over a given actor.
        +
        +
        • +
      + + + +
        +
      • +

        promiseK

        +
        public final F1W<A,Promise<B>> promiseK(Strategy<Unit> s)
        +
        Promotes this function to a concurrent function that returns a Promise of a value.
        +
        +
        Parameters:
        +
        s - A parallel strategy for concurrent execution.
        +
        Returns:
        +
        A concurrent function that returns a Promise of a value.
        +
        +
        • +
      + + + +
        +
      • +

        mapPromise

        +
        public final F1W<Promise<A>,Promise<B>> mapPromise()
        +
        Promotes this function to map over a Promise.
        +
        +
        Returns:
        +
        This function promoted to map over Promises.
        +
        +
        • +
      + + + +
        +
      • +

        eitherLeftK

        +
        public final <C> F1W<A,Either<B,C>> eitherLeftK()
        +
        Promotes this function so that it returns its result on the left side of an Either. + Kleisli arrow for the Either left projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        eitherRightK

        +
        public final <C> F1W<A,Either<C,B>> eitherRightK()
        +
        Promotes this function so that it returns its result on the right side of an Either. + Kleisli arrow for the Either right projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapLeft

        +
        public final <X> F1W<Either<A,X>,Either<B,X>> mapLeft()
        +
        Promotes this function to map over the left side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapRight

        +
        public final <X> F1W<Either<X,A>,Either<X,B>> mapRight()
        +
        Promotes this function to map over the right side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        onLeft

        +
        public final F1W<Either<B,A>,B> onLeft()
        +
        Returns a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        Returns:
        +
        a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        • +
      + + + +
        +
      • +

        onRight

        +
        public final F1W<Either<A,B>,B> onRight()
        +
        Returns a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        Returns:
        +
        a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        • +
      + + + +
        +
      • +

        iterableK

        +
        public final F1W<A,IterableW<B>> iterableK()
        +
        Promotes this function to return its value in an Iterable.
        +
        +
        Returns:
        +
        This function promoted to return its value in an Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        mapIterable

        +
        public final F1W<java.lang.Iterable<A>,IterableW<B>> mapIterable()
        +
        Promotes this function to map over Iterables.
        +
        +
        Returns:
        +
        This function promoted to map over Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        nelK

        +
        public final F1W<A,NonEmptyList<B>> nelK()
        +
        Promotes this function to return its value in a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to return its value in a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        mapNel

        +
        public final F1W<NonEmptyList<A>,NonEmptyList<B>> mapNel()
        +
        Promotes this function to map over a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to map over a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        setK

        +
        public final F1W<A,Set<B>> setK(Ord<B> o)
        +
        Promotes this function to return its value in a Set.
        +
        +
        Parameters:
        +
        o - An order for the set.
        +
        Returns:
        +
        This function promoted to return its value in a Set.
        +
        +
        • +
      + + + +
        +
      • +

        mapSet

        +
        public final F1W<Set<A>,Set<B>> mapSet(Ord<B> o)
        +
        Promotes this function to map over a Set.
        +
        +
        Parameters:
        +
        o - An order for the resulting set.
        +
        Returns:
        +
        This function promoted to map over a Set.
        +
        +
        • +
      + + + +
        +
      • +

        treeK

        +
        public final F1W<A,Tree<B>> treeK()
        +
        Promotes this function to return its value in a Tree.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        mapTree

        +
        public final F1W<Tree<A>,Tree<B>> mapTree()
        +
        Promotes this function to map over a Tree.
        +
        +
        Returns:
        +
        This function promoted to map over a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapTree

        +
        public final F1W<Tree<A>,B> foldMapTree(Monoid<B> m)
        +
        Returns a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        Parameters:
        +
        m - The monoid with which to fold the mapped tree.
        +
        Returns:
        +
        a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperK

        +
        public final F1W<A,TreeZipper<B>> treeZipperK()
        +
        Promotes this function to return its value in a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapTreeZipper

        +
        public final F1W<TreeZipper<A>,TreeZipper<B>> mapTreeZipper()
        +
        Promotes this function to map over a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to map over a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        failK

        +
        public final <C> F1W<A,Validation<B,C>> failK()
        +
        Promotes this function so that it returns its result on the failure side of a Validation. + Kleisli arrow for the Validation failure projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        successK

        +
        public final <C> F1W<A,Validation<C,B>> successK()
        +
        Promotes this function so that it returns its result on the success side of an Validation. + Kleisli arrow for the Validation success projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the success side of an Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapFail

        +
        public final <X> F1W<Validation<A,X>,Validation<B,X>> mapFail()
        +
        Promotes this function to map over the failure side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapSuccess

        +
        public final <X> F1W<Validation<X,A>,Validation<X,B>> mapSuccess()
        +
        Promotes this function to map over the success side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the success side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        onFail

        +
        public final F1W<Validation<B,A>,B> onFail()
        +
        Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        Returns:
        +
        a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        public final F1W<Validation<A,B>,B> onSuccess()
        +
        Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        Returns:
        +
        a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        • +
      + + + +
        +
      • +

        zipperK

        +
        public final F1W<A,Zipper<B>> zipperK()
        +
        Promotes this function to return its value in a Zipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapZipper

        +
        public final F1W<Zipper<A>,Zipper<B>> mapZipper()
        +
        Promotes this function to map over a Zipper.
        +
        +
        Returns:
        +
        This function promoted to map over a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        contramapEqual

        +
        public final F1W<Equal<B>,Equal<A>> contramapEqual()
        +
        Promotes this function to map over an Equal as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over an Equal as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapHash

        +
        public final F1W<Hash<B>,Hash<A>> contramapHash()
        +
        Promotes this function to map over a Hash as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Hash as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapShow

        +
        public final F1W<Show<B>,Show<A>> contramapShow()
        +
        Promotes this function to map over a Show as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Show as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        mapFst

        +
        public final <C> F1W<P2<A,C>,P2<B,C>> mapFst()
        +
        Promotes this function to map over the first element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the first element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapSnd

        +
        public final <C> F1W<P2<C,A>,P2<C,B>> mapSnd()
        +
        Promotes this function to map over the second element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the second element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapBoth

        +
        public final F1W<P2<A,A>,P2<B,B>> mapBoth()
        +
        Promotes this function to map over both elements of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over both elements of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.SynchronousQueue<B> mapJ(java.util.concurrent.SynchronousQueue<A> as)
        +
        Maps this function over a SynchronousQueue.
        +
        +
        Parameters:
        +
        as - A SynchronousQueue to map this function over.
        +
        Returns:
        +
        A new SynchronousQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.PriorityBlockingQueue<B> mapJ(java.util.concurrent.PriorityBlockingQueue<A> as)
        +
        Maps this function over a PriorityBlockingQueue.
        +
        +
        Parameters:
        +
        as - A PriorityBlockingQueue to map this function over.
        +
        Returns:
        +
        A new PriorityBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.LinkedBlockingQueue<B> mapJ(java.util.concurrent.LinkedBlockingQueue<A> as)
        +
        Maps this function over a LinkedBlockingQueue.
        +
        +
        Parameters:
        +
        as - A LinkedBlockingQueue to map this function over.
        +
        Returns:
        +
        A new LinkedBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.CopyOnWriteArraySet<B> mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as)
        +
        Maps this function over a CopyOnWriteArraySet.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArraySet to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArraySet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.CopyOnWriteArrayList<B> mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as)
        +
        Maps this function over a CopyOnWriteArrayList.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArrayList to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.ConcurrentLinkedQueue<B> mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as)
        +
        Maps this function over a ConcurrentLinkedQueue.
        +
        +
        Parameters:
        +
        as - A ConcurrentLinkedQueue to map this function over.
        +
        Returns:
        +
        A new ConcurrentLinkedQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.ArrayBlockingQueue<B> mapJ(java.util.concurrent.ArrayBlockingQueue<A> as)
        +
        Maps this function over an ArrayBlockingQueue.
        +
        +
        Parameters:
        +
        as - An ArrayBlockingQueue to map this function over.
        +
        Returns:
        +
        A new ArrayBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.TreeSet<B> mapJ(java.util.TreeSet<A> as)
        +
        Maps this function over a TreeSet.
        +
        +
        Parameters:
        +
        as - A TreeSet to map this function over.
        +
        Returns:
        +
        A new TreeSet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.PriorityQueue<B> mapJ(java.util.PriorityQueue<A> as)
        +
        Maps this function over a PriorityQueue.
        +
        +
        Parameters:
        +
        as - A PriorityQueue to map this function over.
        +
        Returns:
        +
        A new PriorityQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.LinkedList<B> mapJ(java.util.LinkedList<A> as)
        +
        Maps this function over a LinkedList.
        +
        +
        Parameters:
        +
        as - A LinkedList to map this function over.
        +
        Returns:
        +
        A new LinkedList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.ArrayList<B> mapJ(java.util.ArrayList<A> as)
        +
        Maps this function over an ArrayList.
        +
        +
        Parameters:
        +
        as - An ArrayList to map this function over.
        +
        Returns:
        +
        A new ArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <C> F1W<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <C> F1W<C,B> contramap(F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B> F1W<A,B> lift(F<A,B> f)
        +
        Lifts the function into the fully featured function wrapper
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F2.html b/javadoc/4.8/functionaljava/fj/F2.html new file mode 100644 index 0000000..56b68e6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F2.html @@ -0,0 +1,239 @@ + + + + + +F2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F2<A,B,C>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F2W, F2W.F2WFunc
    +
    +
    +
    +
    public interface F2<A,B,C>
    +
    A transformation function of arity-2 from A and B to C. + This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
        +
        Transform A and B to C.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F2Functions.html b/javadoc/4.8/functionaljava/fj/F2Functions.html new file mode 100644 index 0000000..33adeb7 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F2Functions.html @@ -0,0 +1,742 @@ + + + + + +F2Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F2Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F2Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F2<Array<A>,Array<B>,Array<C>>arrayM(F2<A,B,C> f) +
      Promotes this function to a function on Arrays.
      +
      static <A,B,C,X,Y>
      F2<X,Y,C>      		contramap(F2<A,B,C> target, + F<X,A> f, + F<Y,B> g) 
      static <A,B,C,Z> F2<Z,B,C>contramapFirst(F2<A,B,C> target, + F<Z,A> f) 
      static <A,B,C,Z> F2<A,Z,C>contramapSecond(F2<A,B,C> target, + F<Z,B> f) 
      static <A,B,C> F<A,F<B,C>>curry(F2<A,B,C> f) +
      Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
      +
      static <A,B,C> F<B,C>f(F2<A,B,C> f, + A a) +
      Partial application.
      +
      static <A,B,C> F2<B,A,C>flip(F2<A,B,C> f) +
      Flips the arguments of this function.
      +
      static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>>iterableM(F2<A,B,C> f) +
      Promotes this function to a function on Iterables.
      +
      static <A,B,C> F2<List<A>,List<B>,List<C>>listM(F2<A,B,C> f) +
      Promotes this function to a function on Lists.
      +
      static <A,B,C,Z> F2<A,B,Z>map(F2<A,B,C> target, + F<C,Z> f) 
      static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>nelM(F2<A,B,C> f) +
      Promotes this function to a function on non-empty lists.
      +
      static <A,B,C> F2<Option<A>,Option<B>,Option<C>>optionM(F2<A,B,C> f) +
      Promotes this function to a function on Options.
      +
      static <A,B,C> F2<Promise<A>,Promise<B>,Promise<C>>promiseM(F2<A,B,C> f) +
      Promotes this function to a function on Promises.
      +
      static <A,B,C> F2<Set<A>,Set<B>,Set<C>>setM(F2<A,B,C> f, + Ord<C> o) +
      Promotes this function to a function on Sets.
      +
      static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>>streamM(F2<A,B,C> f) +
      Promotes this function to a function on Streams.
      +
      static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>>treeM(F2<A,B,C> f) +
      Promotes this function to a function on Trees.
      +
      static <A,B,C> F<P2<A,B>,C>tuple(F2<A,B,C> f) +
      Uncurries this function to a function on tuples.
      +
      static <A,B,C> F2<Array<A>,Array<B>,Array<C>>zipArrayM(F2<A,B,C> f) +
      Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
      +
      static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>>zipIterableM(F2<A,B,C> f) +
      Promotes this function to zip two iterables, applying the function lock-step over both iterables.
      +
      static <A,B,C> F2<List<A>,List<B>,List<C>>zipListM(F2<A,B,C> f) +
      Promotes this function to zip two lists, applying the function lock-step over both lists.
      +
      static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>zipNelM(F2<A,B,C> f) +
      Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
      +
      static <A,B,C> F2<Set<A>,Set<B>,Set<C>>zipSetM(F2<A,B,C> f, + Ord<C> o) +
      Promotes this function to zip two sets, applying the function lock-step over both sets.
      +
      static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>>zipStreamM(F2<A,B,C> f) +
      Promotes this function to zip two streams, applying the function lock-step over both streams.
      +
      static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>>zipTreeM(F2<A,B,C> f) +
      Promotes this function to zip two trees, applying the function lock-step over both trees.
      +
      static <A,B,C> F2<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>>zipTreeZipperM(F2<A,B,C> f) +
      Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
      +
      static <A,B,C> F2<Zipper<A>,Zipper<B>,Zipper<C>>zipZipperM(F2<A,B,C> f) +
      Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C> F<B,C> f(F2<A,B,C> f,
+                               A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
        +
        Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        Returns:
        +
        a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
        +
        Flips the arguments of this function.
        +
        +
        Returns:
        +
        A new function with the arguments of this function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
        +
        Uncurries this function to a function on tuples.
        +
        +
        Returns:
        +
        A new function that calls this function with the elements of a given tuple.
        +
        +
        • +
      + + + +
        +
      • +

        arrayM

        +
        public static <A,B,C> F2<Array<A>,Array<B>,Array<C>> arrayM(F2<A,B,C> f)
        +
        Promotes this function to a function on Arrays.
        +
        +
        Returns:
        +
        This function promoted to transform Arrays.
        +
        +
        • +
      + + + +
        +
      • +

        promiseM

        +
        public static <A,B,C> F2<Promise<A>,Promise<B>,Promise<C>> promiseM(F2<A,B,C> f)
        +
        Promotes this function to a function on Promises.
        +
        +
        Returns:
        +
        This function promoted to transform Promises.
        +
        +
        • +
      + + + +
        +
      • +

        iterableM

        +
        public static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>> iterableM(F2<A,B,C> f)
        +
        Promotes this function to a function on Iterables.
        +
        +
        Returns:
        +
        This function promoted to transform Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        listM

        +
        public static <A,B,C> F2<List<A>,List<B>,List<C>> listM(F2<A,B,C> f)
        +
        Promotes this function to a function on Lists.
        +
        +
        Returns:
        +
        This function promoted to transform Lists.
        +
        +
        • +
      + + + +
        +
      • +

        nelM

        +
        public static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> nelM(F2<A,B,C> f)
        +
        Promotes this function to a function on non-empty lists.
        +
        +
        Returns:
        +
        This function promoted to transform non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionM

        +
        public static <A,B,C> F2<Option<A>,Option<B>,Option<C>> optionM(F2<A,B,C> f)
        +
        Promotes this function to a function on Options.
        +
        +
        Returns:
        +
        This function promoted to transform Options.
        +
        +
        • +
      + + + +
        +
      • +

        setM

        +
        public static <A,B,C> F2<Set<A>,Set<B>,Set<C>> setM(F2<A,B,C> f,
+                                                    Ord<C> o)
        +
        Promotes this function to a function on Sets.
        +
        +
        Parameters:
        +
        o - An ordering for the result of the promoted function.
        +
        Returns:
        +
        This function promoted to transform Sets.
        +
        +
        • +
      + + + +
        +
      • +

        streamM

        +
        public static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>> streamM(F2<A,B,C> f)
        +
        Promotes this function to a function on Streams.
        +
        +
        Returns:
        +
        This function promoted to transform Streams.
        +
        +
        • +
      + + + +
        +
      • +

        treeM

        +
        public static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>> treeM(F2<A,B,C> f)
        +
        Promotes this function to a function on Trees.
        +
        +
        Returns:
        +
        This function promoted to transform Trees.
        +
        +
        • +
      + + + +
        +
      • +

        zipArrayM

        +
        public static <A,B,C> F2<Array<A>,Array<B>,Array<C>> zipArrayM(F2<A,B,C> f)
        +
        Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
        +
        +
        Returns:
        +
        A function that zips two arrays with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipIterableM

        +
        public static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>> zipIterableM(F2<A,B,C> f)
        +
        Promotes this function to zip two iterables, applying the function lock-step over both iterables.
        +
        +
        Returns:
        +
        A function that zips two iterables with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipListM

        +
        public static <A,B,C> F2<List<A>,List<B>,List<C>> zipListM(F2<A,B,C> f)
        +
        Promotes this function to zip two lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipStreamM

        +
        public static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>> zipStreamM(F2<A,B,C> f)
        +
        Promotes this function to zip two streams, applying the function lock-step over both streams.
        +
        +
        Returns:
        +
        A function that zips two streams with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipNelM

        +
        public static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> zipNelM(F2<A,B,C> f)
        +
        Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two non-empty lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipSetM

        +
        public static <A,B,C> F2<Set<A>,Set<B>,Set<C>> zipSetM(F2<A,B,C> f,
+                                                       Ord<C> o)
        +
        Promotes this function to zip two sets, applying the function lock-step over both sets.
        +
        +
        Parameters:
        +
        o - An ordering for the resulting set.
        +
        Returns:
        +
        A function that zips two sets with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeM

        +
        public static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>> zipTreeM(F2<A,B,C> f)
        +
        Promotes this function to zip two trees, applying the function lock-step over both trees. + The structure of the resulting tree is the structural intersection of the two trees.
        +
        +
        Returns:
        +
        A function that zips two trees with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipZipperM

        +
        public static <A,B,C> F2<Zipper<A>,Zipper<B>,Zipper<C>> zipZipperM(F2<A,B,C> f)
        +
        Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. + The structure of the resulting zipper is the structural intersection of the two zippers.
        +
        +
        Returns:
        +
        A function that zips two zippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeZipperM

        +
        public static <A,B,C> F2<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>> zipTreeZipperM(F2<A,B,C> f)
        +
        Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Returns:
        +
        A function that zips two TreeZippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        contramapFirst

        +
        public static <A,B,C,Z> F2<Z,B,C> contramapFirst(F2<A,B,C> target,
+                                                 F<Z,A> f)
        +
        • +
      + + + +
        +
      • +

        contramapSecond

        +
        public static <A,B,C,Z> F2<A,Z,C> contramapSecond(F2<A,B,C> target,
+                                                  F<Z,B> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B,C,X,Y> F2<X,Y,C> contramap(F2<A,B,C> target,
+                                              F<X,A> f,
+                                              F<Y,B> g)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B,C,Z> F2<A,B,Z> map(F2<A,B,C> target,
+                                      F<C,Z> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F2W.F2WFunc.html b/javadoc/4.8/functionaljava/fj/F2W.F2WFunc.html new file mode 100644 index 0000000..c81599b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F2W.F2WFunc.html @@ -0,0 +1,319 @@ + + + + + +F2W.F2WFunc (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F2W.F2WFunc<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2W<A,B,C>
      • +
    • +
        +
      • fj.F2W.F2WFunc<A,B,C>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F2<A,B,C>
    +
    +
    +
    Enclosing class:
    +
    F2W<A,B,C>
    +
    +
    +
    +
    public static class F2W.F2WFunc<A,B,C>
+extends F2W<A,B,C>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F2WFunc

        +
        public F2WFunc(F2<A,B,C> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final C f(A a,
+                 B b)
        +
        Description copied from interface: F2
        +
        Transform A and B to C.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F2W.html b/javadoc/4.8/functionaljava/fj/F2W.html new file mode 100644 index 0000000..657eb1c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F2W.html @@ -0,0 +1,813 @@ + + + + + +F2W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F2W<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2W<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F2<A,B,C>
    +
    +
    +
    Direct Known Subclasses:
    +
    F2W.F2WFunc
    +
    +
    +
    +
    public abstract class F2W<A,B,C>
+extends java.lang.Object
+implements F2<A,B,C>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F2W

        +
        public F2W()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final F1W<B,C> f(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public final F1W<A,F<B,C>> curry()
        +
        Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        Returns:
        +
        a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public final F2W<B,A,C> flip()
        +
        Flips the arguments of this function.
        +
        +
        Returns:
        +
        A new function with the arguments of this function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public final F1W<P2<A,B>,C> tuple()
        +
        Uncurries this function to a function on tuples.
        +
        +
        Returns:
        +
        A new function that calls this function with the elements of a given tuple.
        +
        +
        • +
      + + + +
        +
      • +

        arrayM

        +
        public final F2W<Array<A>,Array<B>,Array<C>> arrayM()
        +
        Promotes this function to a function on Arrays.
        +
        +
        Returns:
        +
        This function promoted to transform Arrays.
        +
        +
        • +
      + + + +
        +
      • +

        promiseM

        +
        public final F2W<Promise<A>,Promise<B>,Promise<C>> promiseM()
        +
        Promotes this function to a function on Promises.
        +
        +
        Returns:
        +
        This function promoted to transform Promises.
        +
        +
        • +
      + + + +
        +
      • +

        iterableM

        +
        public final F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>> iterableM()
        +
        Promotes this function to a function on Iterables.
        +
        +
        Returns:
        +
        This function promoted to transform Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        listM

        +
        public final F2W<List<A>,List<B>,List<C>> listM()
        +
        Promotes this function to a function on Lists.
        +
        +
        Returns:
        +
        This function promoted to transform Lists.
        +
        +
        • +
      + + + +
        +
      • +

        nelM

        +
        public final F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> nelM()
        +
        Promotes this function to a function on non-empty lists.
        +
        +
        Returns:
        +
        This function promoted to transform non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionM

        +
        public final F2W<Option<A>,Option<B>,Option<C>> optionM()
        +
        Promotes this function to a function on Options.
        +
        +
        Returns:
        +
        This function promoted to transform Options.
        +
        +
        • +
      + + + +
        +
      • +

        setM

        +
        public final F2W<Set<A>,Set<B>,Set<C>> setM(Ord<C> o)
        +
        Promotes this function to a function on Sets.
        +
        +
        Parameters:
        +
        o - An ordering for the result of the promoted function.
        +
        Returns:
        +
        This function promoted to transform Sets.
        +
        +
        • +
      + + + +
        +
      • +

        streamM

        +
        public final F2W<Stream<A>,Stream<B>,Stream<C>> streamM()
        +
        Promotes this function to a function on Streams.
        +
        +
        Returns:
        +
        This function promoted to transform Streams.
        +
        +
        • +
      + + + +
        +
      • +

        treeM

        +
        public final F2W<Tree<A>,Tree<B>,Tree<C>> treeM()
        +
        Promotes this function to a function on Trees.
        +
        +
        Returns:
        +
        This function promoted to transform Trees.
        +
        +
        • +
      + + + +
        +
      • +

        zipArrayM

        +
        public final F2W<Array<A>,Array<B>,Array<C>> zipArrayM()
        +
        Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
        +
        +
        Returns:
        +
        A function that zips two arrays with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipIterableM

        +
        public final F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>> zipIterableM()
        +
        Promotes this function to zip two iterables, applying the function lock-step over both iterables.
        +
        +
        Returns:
        +
        A function that zips two iterables with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipListM

        +
        public final F2W<List<A>,List<B>,List<C>> zipListM()
        +
        Promotes this function to zip two lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipStreamM

        +
        public final F2W<Stream<A>,Stream<B>,Stream<C>> zipStreamM()
        +
        Promotes this function to zip two streams, applying the function lock-step over both streams.
        +
        +
        Returns:
        +
        A function that zips two streams with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipNelM

        +
        public final F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> zipNelM()
        +
        Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two non-empty lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipSetM

        +
        public final F2W<Set<A>,Set<B>,Set<C>> zipSetM(Ord<C> o)
        +
        Promotes this function to zip two sets, applying the function lock-step over both sets.
        +
        +
        Parameters:
        +
        o - An ordering for the resulting set.
        +
        Returns:
        +
        A function that zips two sets with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeM

        +
        public final F2W<Tree<A>,Tree<B>,Tree<C>> zipTreeM()
        +
        Promotes this function to zip two trees, applying the function lock-step over both trees. + The structure of the resulting tree is the structural intersection of the two trees.
        +
        +
        Returns:
        +
        A function that zips two trees with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipZipperM

        +
        public final F2W<Zipper<A>,Zipper<B>,Zipper<C>> zipZipperM()
        +
        Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. + The structure of the resulting zipper is the structural intersection of the two zippers.
        +
        +
        Returns:
        +
        A function that zips two zippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeZipperM

        +
        public final F2W<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>> zipTreeZipperM()
        +
        Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Returns:
        +
        A function that zips two TreeZippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        contramapFirst

        +
        public final <Z> F2W<Z,B,C> contramapFirst(F<Z,A> f)
        +
        • +
      + + + +
        +
      • +

        contramapSecond

        +
        public final <Z> F2W<A,Z,C> contramapSecond(F<Z,B> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <X,Y> F2W<X,Y,C> contramap(F<X,A> f,
+                                        F<Y,B> g)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <Z> F2W<A,B,Z> map(F<C,Z> f)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C> F2W<A,B,C> lift(F2<A,B,C> f)
        +
        Lifts the function into the fully featured function wrapper
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F3.html b/javadoc/4.8/functionaljava/fj/F3.html new file mode 100644 index 0000000..e742967 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F3.html @@ -0,0 +1,242 @@ + + + + + +F3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F3<A,B,C,D>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F3W
    +
    +
    +
    +
    public interface F3<A,B,C,D>
    +
    A transformation function of arity-3 from A, B and C to + D. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
        +
        Transform A, B and C to D.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F3Functions.html b/javadoc/4.8/functionaljava/fj/F3Functions.html new file mode 100644 index 0000000..4090e30 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F3Functions.html @@ -0,0 +1,249 @@ + + + + + +F3Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F3Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F3Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F3Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D> F2<B,C,D>f(F3<A,B,C,D> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D> F2<B,C,D> f(F3<A,B,C,D> f,
+                                    A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F3W.html b/javadoc/4.8/functionaljava/fj/F3W.html new file mode 100644 index 0000000..371908f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F3W.html @@ -0,0 +1,248 @@ + + + + + +F3W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F3W<A,B,C,D>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F3W<A,B,C,D>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F3<A,B,C,D>
    +
    +
    +
    +
    public abstract class F3W<A,B,C,D>
+extends java.lang.Object
+implements F3<A,B,C,D>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F3W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F3

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F3W

        +
        public F3W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F4.html b/javadoc/4.8/functionaljava/fj/F4.html new file mode 100644 index 0000000..1e2d30e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F4.html @@ -0,0 +1,245 @@ + + + + + +F4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F4<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F4W
    +
    +
    +
    +
    public interface F4<A,B,C,D,E>
    +
    A transformation function of arity-4 from A, B, C and + D to E. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
        +
        Transform A, B, C and D to E.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F4Functions.html b/javadoc/4.8/functionaljava/fj/F4Functions.html new file mode 100644 index 0000000..ec6fad9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F4Functions.html @@ -0,0 +1,249 @@ + + + + + +F4Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F4Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F4Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F4Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E>
      F3<B,C,D,E>      		f(F4<A,B,C,D,E> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E> F3<B,C,D,E> f(F4<A,B,C,D,E> f,
+                                        A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F4W.html b/javadoc/4.8/functionaljava/fj/F4W.html new file mode 100644 index 0000000..a66f64c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F4W.html @@ -0,0 +1,248 @@ + + + + + +F4W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F4W<A,B,C,D,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F4W<A,B,C,D,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F4<A,B,C,D,E>
    +
    +
    +
    +
    public abstract class F4W<A,B,C,D,E>
+extends java.lang.Object
+implements F4<A,B,C,D,E>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F4W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F4

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F4W

        +
        public F4W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F5.html b/javadoc/4.8/functionaljava/fj/F5.html new file mode 100644 index 0000000..e96c8e3 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F5.html @@ -0,0 +1,251 @@ + + + + + +F5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F5<A,B,C,D,E,F$>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F5W
    +
    +
    +
    +
    public interface F5<A,B,C,D,E,F$>
    +
    A transformation function of arity-5 from A, B, C, + D and E to F$. This type can be represented using the Java + 7 closure syntax.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F$ f(A a,
+     B b,
+     C c,
+     D d,
+     E e)
        +
        Transform A, B, C, D and E to + F$.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F5Functions.html b/javadoc/4.8/functionaljava/fj/F5Functions.html new file mode 100644 index 0000000..5e9077a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F5Functions.html @@ -0,0 +1,249 @@ + + + + + +F5Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F5Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F5Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F5Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$>
      F4<B,C,D,E,F$>      		f(F5<A,B,C,D,E,F$> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$> F4<B,C,D,E,F$> f(F5<A,B,C,D,E,F$> f,
+                                              A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F5W.html b/javadoc/4.8/functionaljava/fj/F5W.html new file mode 100644 index 0000000..381b62f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F5W.html @@ -0,0 +1,248 @@ + + + + + +F5W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F5W<A,B,C,D,E,$F>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F5W<A,B,C,D,E,$F>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F5<A,B,C,D,E,$F>
    +
    +
    +
    +
    public abstract class F5W<A,B,C,D,E,$F>
+extends java.lang.Object
+implements F5<A,B,C,D,E,$F>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F5W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F5

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F5W

        +
        public F5W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F6.html b/javadoc/4.8/functionaljava/fj/F6.html new file mode 100644 index 0000000..1ec8a35 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F6.html @@ -0,0 +1,254 @@ + + + + + +F6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F6<A,B,C,D,E,F$,G>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F6W
    +
    +
    +
    +
    public interface F6<A,B,C,D,E,F$,G>
    +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G. This type can be + represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Gf(A a, + B b, + C c, + D d, + E e, + F$ f) +
      Transform A, B, C, D, E and + F$ to G.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f)
        +
        Transform A, B, C, D, E and + F$ to G.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F6Functions.html b/javadoc/4.8/functionaljava/fj/F6Functions.html new file mode 100644 index 0000000..d406316 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F6Functions.html @@ -0,0 +1,249 @@ + + + + + +F6Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F6Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F6Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F6Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G>
      F5<B,C,D,E,F$,G>      		f(F6<A,B,C,D,E,F$,G> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G> F5<B,C,D,E,F$,G> f(F6<A,B,C,D,E,F$,G> func,
+                                                  A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F6W.html b/javadoc/4.8/functionaljava/fj/F6W.html new file mode 100644 index 0000000..5db3f37 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F6W.html @@ -0,0 +1,248 @@ + + + + + +F6W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F6W<A,B,C,D,E,$F,G>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F6W<A,B,C,D,E,$F,G>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F6<A,B,C,D,E,$F,G>
    +
    +
    +
    +
    public abstract class F6W<A,B,C,D,E,$F,G>
+extends java.lang.Object
+implements F6<A,B,C,D,E,$F,G>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F6W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F6

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F6W

        +
        public F6W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F7.html b/javadoc/4.8/functionaljava/fj/F7.html new file mode 100644 index 0000000..a389cf8 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F7.html @@ -0,0 +1,257 @@ + + + + + +F7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F7<A,B,C,D,E,F$,G,H>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F7W
    +
    +
    +
    +
    public interface F7<A,B,C,D,E,F$,G,H>
    +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H. This type + can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Hf(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      Transform A, B, C, D, E, + F$ and G to H.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g)
        +
        Transform A, B, C, D, E, + F$ and G to H.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F7Functions.html b/javadoc/4.8/functionaljava/fj/F7Functions.html new file mode 100644 index 0000000..ffa3132 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F7Functions.html @@ -0,0 +1,249 @@ + + + + + +F7Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F7Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F7Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F7Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H>
      F6<B,C,D,E,F$,G,H>      		f(F7<A,B,C,D,E,F$,G,H> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G,H> F6<B,C,D,E,F$,G,H> f(F7<A,B,C,D,E,F$,G,H> func,
+                                                      A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F7W.html b/javadoc/4.8/functionaljava/fj/F7W.html new file mode 100644 index 0000000..9f4397f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F7W.html @@ -0,0 +1,248 @@ + + + + + +F7W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F7W<A,B,C,D,E,$F,G,H>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F7W<A,B,C,D,E,$F,G,H>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F7<A,B,C,D,E,$F,G,H>
    +
    +
    +
    +
    public abstract class F7W<A,B,C,D,E,$F,G,H>
+extends java.lang.Object
+implements F7<A,B,C,D,E,$F,G,H>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F7W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F7

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F7W

        +
        public F7W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F8.html b/javadoc/4.8/functionaljava/fj/F8.html new file mode 100644 index 0000000..0d3aaf9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F8.html @@ -0,0 +1,260 @@ + + + + + +F8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F8<A,B,C,D,E,F$,G,H,I>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F8W
    +
    +
    +
    +
    public interface F8<A,B,C,D,E,F$,G,H,I>
    +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      If(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      Transform A, B, C, D, E, + F$, G and H to I.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g,
+    H h)
        +
        Transform A, B, C, D, E, + F$, G and H to I.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        h - The H to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F8Functions.html b/javadoc/4.8/functionaljava/fj/F8Functions.html new file mode 100644 index 0000000..facbdb6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F8Functions.html @@ -0,0 +1,247 @@ + + + + + +F8Functions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F8Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F8Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F8Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H,I>
      F7<B,C,D,E,F$,G,H,I>      		f(F8<A,B,C,D,E,F$,G,H,I> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G,H,I> F7<B,C,D,E,F$,G,H,I> f(F8<A,B,C,D,E,F$,G,H,I> func,
+                                                          A a)
        +
        Partial application.
        +
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/F8W.html b/javadoc/4.8/functionaljava/fj/F8W.html new file mode 100644 index 0000000..8fc70bd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/F8W.html @@ -0,0 +1,248 @@ + + + + + +F8W (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F8W<A,B,C,D,E,$F,G,H,I>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F8W<A,B,C,D,E,$F,G,H,I>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F8<A,B,C,D,E,$F,G,H,I>
    +
    +
    +
    +
    public abstract class F8W<A,B,C,D,E,$F,G,H,I>
+extends java.lang.Object
+implements F8<A,B,C,D,E,$F,G,H,I>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F8W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F8

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F8W

        +
        public F8W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Function.html b/javadoc/4.8/functionaljava/fj/Function.html new file mode 100644 index 0000000..7d37f22 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Function.html @@ -0,0 +1,2162 @@ + + + + + +Function (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Function

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Function
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Function
+extends java.lang.Object
    +
    Transformations on functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>>andThen() +
      Function composition flipped.
      +
      static <A,B,C> F<A,C>andThen(F<A,B> g, + F<B,C> f) +
      Function composition flipped.
      +
      static <A,B> F<F<A,B>,B>apply(A a) +
      Function application with the arguments flipped.
      +
      static <A,B,C> F<C,B>apply(F<C,F<A,B>> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>apply(F2<C,A,B> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>bind(F<C,A> ma, + F<A,F<C,B>> f) +
      Binds the function in the second argument to the function in the first argument.
      +
      static <A,B,C,D> F<D,C>bind(F<D,A> ca, + F<D,B> cb, + F<A,F<B,C>> f) +
      Binds the given function f to the values of the given functions, with a final join.
      +
      static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>>compose() +
      Function composition.
      +
      static <A,B,C> F<A,C>compose(F<B,C> f, + F<A,B> g) +
      Function composition.
      +
      static <A,B,C,D> F<A,F<B,D>>compose2(F<C,D> f, + F<A,F<B,C>> g) +
      Function composition.
      +
      static <A,B> F<B,F<A,B>>constant() +
      Returns a function that given an argument, returns a function that ignores its argument.
      +
      static <A,B> F<A,B>constant(B b) +
      Returns a function that ignores its argument to constantly produce the given value.
      +
      static <A,B,C> F<A,F<B,C>>curry(F2<A,B,C> f) +
      Curry a function of arity-2.
      +
      static <A,B,C> F<B,C>curry(F2<A,B,C> f, + A a) +
      Curry a function of arity-2.
      +
      static <A,B,C,D> F<A,F<B,F<C,D>>>curry(F3<A,B,C,D> f) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<B,F<C,D>>curry(F3<A,B,C,D> f, + A a) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<C,D>curry(F3<A,B,C,D> f, + A a, + B b) +
      Curry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,E>>>>      		curry(F4<A,B,C,D,E> f) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<B,F<C,F<D,E>>>      		curry(F4<A,B,C,D,E> f, + A a) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<C,F<D,E>>      		curry(F4<A,B,C,D,E> f, + A a, + B b) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<D,E>      		curry(F4<A,B,C,D,E> f, + A a, + B b, + C c) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F$>>>>>      		curry(F5<A,B,C,D,E,F$> f) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<B,F<C,F<D,F<E,F$>>>>      		curry(F5<A,B,C,D,E,F$> f, + A a) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<C,F<D,F<E,F$>>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<D,F<E,F$>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<E,F$>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>      		curry(F6<A,B,C,D,E,F$,G> f) +
      Curry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<C,F<D,F<E,F<F$,F<G,H>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<D,F<E,F<F$,F<G,H>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<E,F<F$,F<G,H>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F$,F<G,H>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<G,H>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<D,F<E,F<F$,F<G,F<H,I>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<E,F<F$,F<G,F<H,I>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F$,F<G,F<H,I>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<G,F<H,I>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<H,I>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$, + G g) +
      Curry a function of arity-7.
      +
      static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>>flip() +
      Function argument flipping.
      +
      static <A,B,C> F<B,F<A,C>>flip(F<A,F<B,C>> f) +
      Function argument flipping.
      +
      static <A,B,C> F2<B,A,C>flip(F2<A,B,C> f) +
      Function argument flipping.
      +
      static <A,B,C> F<F2<A,B,C>,F2<B,A,C>>flip2() +
      Function argument flipping.
      +
      static <A> F<A,A>identity() +
      The identity transformation.
      +
      static <A,B> F<B,A>join(F<B,F<B,A>> f) +
      Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
      +
      static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>>lift(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a higher-order function.
      +
      static <A,B> F<A,Option<B>>nullable(F<A,B> f) +
      Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
      +
      static <A,B,C> F<B,F<B,C>>on(F<A,F<A,C>> a, + F<B,A> f) +
      Applies a given function over the arguments of another function of arity-2.
      +
      static <A,B,C> F<A,C>partialApply2(F<A,F<B,C>> f, + B b) +
      Partial application of the second argument to the supplied function to get a function of type + A -> C.
      +
      static <A,B,C,D> F<A,F<B,D>>partialApply3(F<A,F<B,F<C,D>>> f, + C c) +
      Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,E>>>      		partialApply4(F<A,F<B,F<C,F<D,E>>>> f, + D d) +
      Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F$>>>>      		partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f, + E e) +
      Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,G>>>>>      		partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f, + F$ f$) +
      Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>>      		partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f, + G g) +
      Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>>      		partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f, + H h) +
      Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
      +
      static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>>uncurryF2() +
      Uncurry a function of arity-2.
      +
      static <A,B,C> F2<A,B,C>uncurryF2(F<A,F<B,C>> f) +
      Uncurry a function of arity-2.
      +
      static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>>uncurryF3() +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D> F3<A,B,C,D>uncurryF3(F<A,F<B,F<C,D>>> f) +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>>      		uncurryF4() +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E>
      F4<A,B,C,D,E>      		uncurryF4(F<A,F<B,F<C,F<D,E>>>> f) +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>>      		uncurryF5() +
      Uncurry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F5<A,B,C,D,E,F$>      		uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>>      		uncurryF6() +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F6<A,B,C,D,E,F$,G>      		uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>>      		uncurryF7() +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F7<A,B,C,D,E,F$,G,H>      		uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>>      		uncurryF8() +
      Uncurry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F8<A,B,C,D,E,F$,G,H,I>      		uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Uncurry a function of arity-8.
      +
      static <C,A extends C,B,D extends B>
      F<F<C,D>,F<A,B>>      		vary() +
      Simultaneously covaries and contravaries a function.
      +
      static <A,B> F<A,B>vary(F<? super A,? extends B> f) +
      Simultaneously covaries and contravaries a function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public static <A,B> F<F<A,B>,B> apply(A a)
        +
        Function application with the arguments flipped.
        +
        +
        Parameters:
        +
        a - The value to apply the function to.
        +
        Returns:
        +
        A function that is partially-applied to the given value.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>> compose()
        +
        Function composition.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<A,C> compose(F<B,C> f,
+                                     F<A,B> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        compose2

        +
        public static <A,B,C,D> F<A,F<B,D>> compose2(F<C,D> f,
+                                             F<A,F<B,C>> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>> andThen()
        +
        Function composition flipped.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<A,C> andThen(F<A,B> g,
+                                     F<B,C> f)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function to compose with another.
        +
        f - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        identity

        +
        public static <A> F<A,A> identity()
        +
        The identity transformation.
        +
        +
        Returns:
        +
        The identity transformation.
        +
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public static <A,B> F<B,F<A,B>> constant()
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> F<A,B> constant(B b)
        +
        Returns a function that ignores its argument to constantly produce the given value.
        +
        +
        Parameters:
        +
        b - The value to return when the returned function is applied.
        +
        Returns:
        +
        A function that ignores its argument to constantly produce the given value.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <A,B> F<A,B> vary(F<? super A,? extends B> f)
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Parameters:
        +
        f - The function to vary.
        +
        Returns:
        +
        A co- and contravariant function that invokes f on its argument.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <C,A extends C,B,D extends B> F<F<C,D>,F<A,B>> vary()
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Returns:
        +
        A function that varies and covaries a function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>> flip()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that takes a function and flips its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<B,F<A,C>> flip(F<A,F<B,C>> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip2

        +
        public static <A,B,C> F<F2<A,B,C>,F2<B,A,C>> flip2()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that flips the arguments of a given function.
        +
        +
        • +
      + + + +
        +
      • +

        nullable

        +
        public static <A,B> F<A,Option<B>> nullable(F<A,B> f)
        +
        Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        Parameters:
        +
        f - The function to check for a null argument.
        +
        Returns:
        +
        A function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<B,C> curry(F2<A,B,C> f,
+                                   A a)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>> uncurryF2()
        +
        Uncurry a function of arity-2.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F2<A,B,C> uncurryF2(F<A,F<B,C>> f)
        +
        Uncurry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<A,F<B,F<C,D>>> curry(F3<A,B,C,D> f)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<B,F<C,D>> curry(F3<A,B,C,D> f,
+                                          A a)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<C,D> curry(F3<A,B,C,D> f,
+                                     A a,
+                                     B b)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>> uncurryF3()
        +
        Uncurry a function of arity-3.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F3<A,B,C,D> uncurryF3(F<A,F<B,F<C,D>>> f)
        +
        Uncurry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,E>>>> curry(F4<A,B,C,D,E> f)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<B,F<C,F<D,E>>> curry(F4<A,B,C,D,E> f,
+                                                 A a)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<C,F<D,E>> curry(F4<A,B,C,D,E> f,
+                                            A a,
+                                            B b)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<D,E> curry(F4<A,B,C,D,E> f,
+                                       A a,
+                                       B b,
+                                       C c)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>> uncurryF4()
        +
        Uncurry a function of arity-4.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F4<A,B,C,D,E> uncurryF4(F<A,F<B,F<C,F<D,E>>>> f)
        +
        Uncurry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F$>>>>> curry(F5<A,B,C,D,E,F$> f)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<B,F<C,F<D,F<E,F$>>>> curry(F5<A,B,C,D,E,F$> f,
+                                                          A a)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<C,F<D,F<E,F$>>> curry(F5<A,B,C,D,E,F$> f,
+                                                     A a,
+                                                     B b)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<D,F<E,F$>> curry(F5<A,B,C,D,E,F$> f,
+                                                A a,
+                                                B b,
+                                                C c)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<E,F$> curry(F5<A,B,C,D,E,F$> f,
+                                           A a,
+                                           B b,
+                                           C c,
+                                           D d)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>> uncurryF5()
        +
        Uncurry a function of arity-5.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F5<A,B,C,D,E,F$> uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> curry(F6<A,B,C,D,E,F$,G> f)
        +
        Curry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>> uncurryF6()
        +
        Uncurry a function of arity-6.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F6<A,B,C,D,E,F$,G> uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                        A a)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<C,F<D,F<E,F<F$,F<G,H>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                   A a,
+                                                                   B b)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<D,F<E,F<F$,F<G,H>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                              A a,
+                                                              B b,
+                                                              C c)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<E,F<F$,F<G,H>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                         A a,
+                                                         B b,
+                                                         C c,
+                                                         D d)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<F$,F<G,H>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                    A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<G,H> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                              A a,
+                                              B b,
+                                              C c,
+                                              D d,
+                                              E e,
+                                              F$ f$)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>> uncurryF7()
        +
        Uncurry a function of arity-7.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F7<A,B,C,D,E,F$,G,H> uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Uncurry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                               A a)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                          A a,
+                                                                          B b)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<D,F<E,F<F$,F<G,F<H,I>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                     A a,
+                                                                     B b,
+                                                                     C c)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<E,F<F$,F<G,F<H,I>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                A a,
+                                                                B b,
+                                                                C c,
+                                                                D d)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F$,F<G,F<H,I>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                           A a,
+                                                           B b,
+                                                           C c,
+                                                           D d,
+                                                           E e)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<G,F<H,I>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                     A a,
+                                                     B b,
+                                                     C c,
+                                                     D d,
+                                                     E e,
+                                                     F$ f$)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<H,I> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f$,
+                                                G g)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        g - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>> uncurryF8()
        +
        Uncurry a function of arity-8.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F8<A,B,C,D,E,F$,G,H,I> uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Uncurry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<C,B> bind(F<C,A> ma,
+                                  F<A,F<C,B>> f)
        +
        Binds the function in the second argument to the function in the first argument.
        +
        +
        Parameters:
        +
        ma - A function whose argument type is the same as the argument type of the return value.
        +
        f - A function whose argument type is the same as the return type of ma, + and yields the return value.
        +
        Returns:
        +
        A function that chains the given functions together such that the result of applying + ma to the argument is given to f, yielding a function + that is applied to the argument again.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F<C,F<A,B>> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F2<C,A,B> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C,D> F<D,C> bind(F<D,A> ca,
+                                    F<D,B> cb,
+                                    F<A,F<B,C>> f)
        +
        Binds the given function f to the values of the given functions, with a final join.
        +
        +
        Parameters:
        +
        ca - A function to bind f function to.
        +
        cb - A function to bind f function to.
        +
        f - The bound function to be composed with ca and then applied with cb
        +
        Returns:
        +
        A new function after performing the composition, then application.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<B,F<B,C>> on(F<A,F<A,C>> a,
+                                     F<B,A> f)
        +
        Applies a given function over the arguments of another function of arity-2.
        +
        +
        Parameters:
        +
        a - The function whose arguments to apply another function over.
        +
        f - The function to apply over the arguments of another function.
        +
        Returns:
        +
        A function whose arguments are fed through function f, before being passed to function a.
        +
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>> lift(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a higher-order function.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to compose with two functions.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,B> F<B,A> join(F<B,F<B,A>> f)
        +
        Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
        +
        +
        Parameters:
        +
        f - A function whose arguments to join.
        +
        Returns:
        +
        A function of arity-1 whose argument is substituted for both parameters of f.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply2

        +
        public static <A,B,C> F<A,C> partialApply2(F<A,F<B,C>> f,
+                                           B b)
        +
        Partial application of the second argument to the supplied function to get a function of type + A -> C. Same as flip(f).f(b).
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        b - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its second argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply3

        +
        public static <A,B,C,D> F<A,F<B,D>> partialApply3(F<A,F<B,F<C,D>>> f,
+                                                  C c)
        +
        Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        c - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its third argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply4

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,E>>> partialApply4(F<A,F<B,F<C,F<D,E>>>> f,
+                                                         D d)
        +
        Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        d - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fourth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply5

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F$>>>> partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f,
+                                                                  E e)
        +
        Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        e - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fifth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply6

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,G>>>>> partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f,
+                                                                        F$ f$)
        +
        Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        f$ - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its sixth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply7

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>> partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f,
+                                                                                G g)
        +
        Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        g - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its seventh argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>> partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f,
+                                                                                       H h)
        +
        Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        h - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its eigth argument applied.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Hash.html b/javadoc/4.8/functionaljava/fj/Hash.html new file mode 100644 index 0000000..80ffb2f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Hash.html @@ -0,0 +1,1264 @@ + + + + + +Hash (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Hash<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Hash<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Hash<A>
+extends java.lang.Object
    +
    Produces a hash code for an object which should attempt uniqueness.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanHash

        +
        public static final Hash<java.lang.Boolean> booleanHash
        +
        A hash instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteHash

        +
        public static final Hash<java.lang.Byte> byteHash
        +
        A hash instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charHash

        +
        public static final Hash<java.lang.Character> charHash
        +
        A hash instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleHash

        +
        public static final Hash<java.lang.Double> doubleHash
        +
        A hash instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatHash

        +
        public static final Hash<java.lang.Float> floatHash
        +
        A hash instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intHash

        +
        public static final Hash<java.lang.Integer> intHash
        +
        A hash instance for the int type.
        +
        • +
      + + + +
        +
      • +

        longHash

        +
        public static final Hash<java.lang.Long> longHash
        +
        A hash instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortHash

        +
        public static final Hash<java.lang.Short> shortHash
        +
        A hash instance for the short type.
        +
        • +
      + + + +
        +
      • +

        bigintHash

        +
        public static final Hash<java.math.BigInteger> bigintHash
        +
        A hash instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalHash

        +
        public static final Hash<java.math.BigDecimal> bigdecimalHash
        +
        A hash instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        naturalHash

        +
        public static final Hash<Natural> naturalHash
        +
        A hash instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringHash

        +
        public static final Hash<java.lang.String> stringHash
        +
        A hash instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferHash

        +
        public static final Hash<java.lang.StringBuffer> stringBufferHash
        +
        A hash instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderHash

        +
        public static final Hash<java.lang.StringBuilder> stringBuilderHash
        +
        A hash instance for the StringBuilder type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value.
        +
        +
        Parameters:
        +
        a - The value to compute the hash value for.
        +
        Returns:
        +
        The hash value.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Hash<B> contramap(F<B,A> g)
        +
        Maps the given function across this hash as a contra-variant functor.
        +
        +
        Parameters:
        +
        g - The function to map.
        +
        Returns:
        +
        A new hash.
        +
        +
        • +
      + + + +
        +
      • +

        hash

        +
        public static <A> Hash<A> hash(F<A,java.lang.Integer> f)
        +
        Construct a hash with the given hash function.
        +
        +
        Parameters:
        +
        f - The function to construct the hash with.
        +
        Returns:
        +
        A hash that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyHash

        +
        public static <A> Hash<A> anyHash()
        +
        A hash that uses Object.hashCode().
        +
        +
        Returns:
        +
        A hash that uses Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        eitherHash

        +
        public static <A,B> Hash<Either<A,B>> eitherHash(Hash<A> ha,
+                                                 Hash<B> hb)
        +
        A hash instance for the Either type.
        +
        +
        Parameters:
        +
        ha - Hash the left side of Either.
        +
        hb - Hash the right side of Either.
        +
        Returns:
        +
        A hash instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        resultHash

        +
        public static <I,A> Hash<Result<I,A>> resultHash(Hash<A> ha,
+                                                 Hash<I> hi)
        +
        A hash instance for the Result type.
        +
        +
        Parameters:
        +
        ha - Hash the Result value.
        +
        hi - Hash the Result remainder.
        +
        Returns:
        +
        A hash instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationHash

        +
        public static <A,B> Hash<Validation<A,B>> validationHash(Hash<A> ha,
+                                                         Hash<B> hb)
        +
        A hash instance for the Validation type.
        +
        +
        Parameters:
        +
        ha - Hash the failing side of Validation.
        +
        hb - Hash the succeeding side of Validation.
        +
        Returns:
        +
        A hash instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listHash

        +
        public static <A> Hash<List<A>> listHash(Hash<A> ha)
        +
        A hash instance for the List type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the list.
        +
        Returns:
        +
        A hash instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListHash

        +
        public static <A> Hash<NonEmptyList<A>> nonEmptyListHash(Hash<A> ha)
        +
        A hash instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the non-empty list.
        +
        Returns:
        +
        A hash instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionHash

        +
        public static <A> Hash<Option<A>> optionHash(Hash<A> ha)
        +
        A hash instance for the Option type.
        +
        +
        Parameters:
        +
        ha - A hash for the element of the optional value.
        +
        Returns:
        +
        A hash instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqHash

        +
        public static <A> Hash<Seq<A>> seqHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        setHash

        +
        public static <A> Hash<Set<A>> setHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        streamHash

        +
        public static <A> Hash<Stream<A>> streamHash(Hash<A> ha)
        +
        A hash instance for the Stream type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the stream.
        +
        Returns:
        +
        A hash instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayHash

        +
        public static <A> Hash<Array<A>> arrayHash(Hash<A> ha)
        +
        A hash instance for the Array type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the array.
        +
        Returns:
        +
        A hash instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperHash

        +
        public static <A> Hash<Zipper<A>> zipperHash(Hash<A> ha)
        +
        A hash instance for the Zipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the zipper.
        +
        Returns:
        +
        A hash instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperHash

        +
        public static <A> Hash<TreeZipper<A>> treeZipperHash(Hash<A> ha)
        +
        A hash instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree zipper.
        +
        Returns:
        +
        A hash instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeHash

        +
        public static <A> Hash<Tree<A>> treeHash(Hash<A> ha)
        +
        A hash instance for the Tree type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree.
        +
        Returns:
        +
        A hash instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapHash

        +
        public static <K,V> Hash<TreeMap<K,V>> treeMapHash(Hash<K> h,
+                                                   Hash<V> v)
        +
        • +
      + + + +
        +
      • +

        p1Hash

        +
        public static <A> Hash<P1<A>> p1Hash(Hash<A> ha)
        +
        A hash instance for a product-1.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        Returns:
        +
        A hash instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Hash

        +
        public static <A,B> Hash<P2<A,B>> p2Hash(Hash<A> ha,
+                                         Hash<B> hb)
        +
        A hash instance for a product-2.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        Returns:
        +
        A hash instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Hash

        +
        public static <A,B,C> Hash<P3<A,B,C>> p3Hash(Hash<A> ha,
+                                             Hash<B> hb,
+                                             Hash<C> hc)
        +
        A hash instance for a product-3.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        Returns:
        +
        A hash instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Hash

        +
        public static <A,B,C,D> Hash<P4<A,B,C,D>> p4Hash(Hash<A> ha,
+                                                 Hash<B> hb,
+                                                 Hash<C> hc,
+                                                 Hash<D> hd)
        +
        A hash instance for a product-4.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        Returns:
        +
        A hash instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Hash

        +
        public static <A,B,C,D,E> Hash<P5<A,B,C,D,E>> p5Hash(Hash<A> ha,
+                                                     Hash<B> hb,
+                                                     Hash<C> hc,
+                                                     Hash<D> hd,
+                                                     Hash<E> he)
        +
        A hash instance for a product-5.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        Returns:
        +
        A hash instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Hash

        +
        public static <A,B,C,D,E,F$> Hash<P6<A,B,C,D,E,F$>> p6Hash(Hash<A> ha,
+                                                           Hash<B> hb,
+                                                           Hash<C> hc,
+                                                           Hash<D> hd,
+                                                           Hash<E> he,
+                                                           Hash<F$> hf)
        +
        A hash instance for a product-6.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        Returns:
        +
        A hash instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Hash

        +
        public static <A,B,C,D,E,F$,G> Hash<P7<A,B,C,D,E,F$,G>> p7Hash(Hash<A> ha,
+                                                               Hash<B> hb,
+                                                               Hash<C> hc,
+                                                               Hash<D> hd,
+                                                               Hash<E> he,
+                                                               Hash<F$> hf,
+                                                               Hash<G> hg)
        +
        A hash instance for a product-7.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        Returns:
        +
        A hash instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Hash

        +
        public static <A,B,C,D,E,F$,G,H> Hash<P8<A,B,C,D,E,F$,G,H>> p8Hash(Hash<A> ha,
+                                                                   Hash<B> hb,
+                                                                   Hash<C> hc,
+                                                                   Hash<D> hd,
+                                                                   Hash<E> he,
+                                                                   Hash<F$> hf,
+                                                                   Hash<G> hg,
+                                                                   Hash<H> hh)
        +
        A hash instance for a product-8.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        hh - A hash for the eighth element of the product.
        +
        Returns:
        +
        A hash instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Hash

        +
        public static <A> Hash<V2<A>> v2Hash(Hash<A> ea)
        +
        A hash instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Hash

        +
        public static <A> Hash<V3<A>> v3Hash(Hash<A> ea)
        +
        A hash instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Hash

        +
        public static <A> Hash<V4<A>> v4Hash(Hash<A> ea)
        +
        A hash instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Hash

        +
        public static <A> Hash<V5<A>> v5Hash(Hash<A> ea)
        +
        A hash instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Hash

        +
        public static <A> Hash<V6<A>> v6Hash(Hash<A> ea)
        +
        A hash instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Hash

        +
        public static <A> Hash<V7<A>> v7Hash(Hash<A> ea)
        +
        A hash instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Hash

        +
        public static <A> Hash<V8<A>> v8Hash(Hash<A> ea)
        +
        A hash instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-8.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/LcgRng.html b/javadoc/4.8/functionaljava/fj/LcgRng.html new file mode 100644 index 0000000..2f70fcd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/LcgRng.html @@ -0,0 +1,330 @@ + + + + + +LcgRng (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class LcgRng

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    +
    public class LcgRng
+extends Rng
    +
    Created by MarkPerry on 7/07/2014. + + https://en.wikipedia.org/wiki/Linear_congruential_generator
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      LcgRng() 
      LcgRng(long s) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng()
        +
        • +
      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng(long s)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSeed

        +
        public final long getSeed()
        +
        • +
      + + + +
        +
      • +

        nextInt

        +
        public final P2<Rng,java.lang.Integer> nextInt()
        +
        +
        Specified by:
        +
        nextInt in class Rng
        +
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public final P2<Rng,java.lang.Long> nextLong()
        +
        +
        Specified by:
        +
        nextLong in class Rng
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Monoid.AltDefinition.html b/javadoc/4.8/functionaljava/fj/Monoid.AltDefinition.html new file mode 100644 index 0000000..2c54822 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Monoid.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Monoid.AltDefinition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Monoid.Definition.html b/javadoc/4.8/functionaljava/fj/Monoid.Definition.html new file mode 100644 index 0000000..b117545 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Monoid.Definition.html @@ -0,0 +1,329 @@ + + + + + +Monoid.Definition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Monoid.html b/javadoc/4.8/functionaljava/fj/Monoid.html new file mode 100644 index 0000000..0644268 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Monoid.html @@ -0,0 +1,1421 @@ + + + + + +Monoid (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Monoid<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Monoid<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Monoid<A>
+extends java.lang.Object
    +
    A monoid abstraction to be defined across types of the given type argument. Implementations must + follow the monoidal laws: +
      +
    • Left Identity; forall x. sum(zero(), x) == x
      • +
    • Right Identity; forall x. sum(x, zero()) == x
      • +
    • Associativity; forall x y z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionMonoid

        +
        public static final Monoid<java.lang.Integer> intAdditionMonoid
        +
        A monoid that adds integers.
        +
        • +
      + + + +
        +
      • +

        intMultiplicationMonoid

        +
        public static final Monoid<java.lang.Integer> intMultiplicationMonoid
        +
        A monoid that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        doubleAdditionMonoid

        +
        @Deprecated
+public static final Monoid<java.lang.Double> doubleAdditionMonoid
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        doubleMultiplicationMonoid

        +
        @Deprecated
+public static final Monoid<java.lang.Double> doubleMultiplicationMonoid
        +
        Deprecated. Since 4.7. Due to rounding errors, multiplication of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        bigintAdditionMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintAdditionMonoid
        +
        A monoid that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintMultiplicationMonoid
        +
        A monoid that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalAdditionMonoid
        +
        A monoid that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalMultiplicationMonoid
        +
        A monoid that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionMonoid

        +
        public static final Monoid<Natural> naturalAdditionMonoid
        +
        A monoid that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationMonoid

        +
        public static final Monoid<Natural> naturalMultiplicationMonoid
        +
        A monoid that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionMonoid

        +
        public static final Monoid<java.lang.Long> longAdditionMonoid
        +
        A monoid that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationMonoid

        +
        public static final Monoid<java.lang.Long> longMultiplicationMonoid
        +
        A monoid that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> disjunctionMonoid
        +
        A monoid that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> exclusiveDisjunctionMonoid
        +
        A monoid that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> conjunctionMonoid
        +
        A monoid that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringMonoid

        +
        public static final Monoid<java.lang.String> stringMonoid
        +
        A monoid that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferMonoid

        +
        public static final Monoid<java.lang.StringBuffer> stringBufferMonoid
        +
        A monoid that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderMonoid

        +
        public static final Monoid<java.lang.StringBuilder> stringBuilderMonoid
        +
        A monoid that appends string builders.
        +
        • +
      + + + +
        +
      • +

        intMaxMonoid

        +
        public static final Monoid<java.lang.Integer> intMaxMonoid
        +
        A monoid for the maximum of two integers.
        +
        • +
      + + + +
        +
      • +

        intMinMonoid

        +
        public static final Monoid<java.lang.Integer> intMinMonoid
        +
        A monoid for the minimum of two integers.
        +
        • +
      + + + +
        +
      • +

        unitMonoid

        +
        public static final Monoid<Unit> unitMonoid
        +
        A monoid for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compose

        +
        public <B> Monoid<P2<A,B>> compose(Monoid<B> m)
        +
        Composes this monoid with another.
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public Semigroup<A> semigroup()
        +
        Returns a semigroup projection of this monoid.
        +
        +
        Returns:
        +
        A semigroup projection of this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Monoid<B> xmap(F<A,B> f,
+                          F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public <B,C> Monoid<C> compose(Monoid<B> mb,
+                               F<C,A> a,
+                               F<C,B> b,
+                               F2<A,B,C> c)
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this monoid.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this monoid.
        +
        +
        Returns:
        +
        A function that sums according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public A zero()
        +
        The zero value for this monoid.
        +
        +
        Returns:
        +
        The zero value for this monoid.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply

        +
        public A multiply(int n,
+                  A a)
        +
        Returns a value summed n times (a + a + ... + a). + The default definition uses peasant multiplication, exploiting + associativity to only require `O(log n)` uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(List<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(Stream<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(List<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(Stream<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public F<List<A>,A> sumLeft()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public F<List<A>,A> sumRight()
        +
        Returns a function that sums the given values with right-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with right-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeftS

        +
        public F<Stream<A>,A> sumLeftS()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + + + +
        +
      • +

        join

        +
        public A join(java.lang.Iterable<A> as,
+              A a)
        +
        Intersperses the given value between each two elements of the iterable, and sums the result.
        +
        +
        Parameters:
        +
        as - An iterable of values to sum.
        +
        a - The value to intersperse between values of the given iterable.
        +
        Returns:
        +
        The sum of the given values and the interspersed value.
        +
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Monoid<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.Definition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.AltDefinition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.Definition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.AltDefinition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F<A,F<A,A>> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F2<A,A,A> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        @Deprecated
+public static <A> Monoid<A> monoid(Semigroup<A> s,
+                                               A zero)
        +
        Deprecated. since 4.7. Use monoidDef(Semigroup.Definition, Object) or Semigroup.monoid(Object) instead.
        +
        Constructs a monoid from the given semigroup and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        functionMonoid

        +
        public static <A,B> Monoid<F<A,B>> functionMonoid(Monoid<B> mb)
        +
        A monoid for functions.
        +
        +
        Parameters:
        +
        mb - The monoid for the function codomain.
        +
        Returns:
        +
        A monoid for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listMonoid

        +
        public static <A> Monoid<List<A>> listMonoid()
        +
        A monoid for lists.
        +
        +
        Returns:
        +
        A monoid for lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionMonoid

        +
        @Deprecated
+public static <A> Monoid<Option<A>> optionMonoid()
        +
        Deprecated. since 4.7. Use firstOptionMonoid().
        +
        A monoid for options.
        +
        +
        Returns:
        +
        A monoid for options.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionMonoid

        +
        public static <A> Monoid<Option<A>> firstOptionMonoid()
        +
        A monoid for options that take the first available value.
        +
        +
        Returns:
        +
        A monoid for options that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionMonoid

        +
        public static <A> Monoid<Option<A>> lastOptionMonoid()
        +
        A monoid for options that take the last available value.
        +
        +
        Returns:
        +
        A monoid for options that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamMonoid

        +
        public static <A> Monoid<Stream<A>> streamMonoid()
        +
        A monoid for streams.
        +
        +
        Returns:
        +
        A monoid for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arrayMonoid

        +
        public static <A> Monoid<Array<A>> arrayMonoid()
        +
        A monoid for arrays.
        +
        +
        Returns:
        +
        A monoid for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        ioMonoid

        +
        public static <A> Monoid<IO<A>> ioMonoid(Monoid<A> ma)
        +
        A monoid for IO values.
        +
        • +
      + + + +
        +
      • +

        setMonoid

        +
        public static <A> Monoid<Set<A>> setMonoid(Ord<A> o)
        +
        A monoid for sets.
        +
        +
        Parameters:
        +
        o - An order for set elements.
        +
        Returns:
        +
        A monoid for sets whose elements have the given order.
        +
        +
        • +
      + + + + + +
        +
      • +

        ordMaxMonoid

        +
        @Deprecated
+public static <A> Monoid<A> ordMaxMonoid(Ord<A> o,
+                                                     A zero)
        +
        Deprecated. since 4.7. Use Ord.maxMonoid(Object)
        +
        A monoid for the maximum of elements with ordering o.
        +
        +
        Parameters:
        +
        o - An ordering of elements.
        +
        zero - The minimum element.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Ord.AltDefinition.html b/javadoc/4.8/functionaljava/fj/Ord.AltDefinition.html new file mode 100644 index 0000000..8f66119 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Ord.AltDefinition.html @@ -0,0 +1,298 @@ + + + + + +Ord.AltDefinition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Ord.Definition.html b/javadoc/4.8/functionaljava/fj/Ord.Definition.html new file mode 100644 index 0000000..f00d279 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Ord.Definition.html @@ -0,0 +1,427 @@ + + + + + +Ord.Definition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Ord.html b/javadoc/4.8/functionaljava/fj/Ord.html new file mode 100644 index 0000000..fab8d04 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Ord.html @@ -0,0 +1,1439 @@ + + + + + +Ord (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Ord<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Ord<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Ord<A>
+extends java.lang.Object
    +
    Tests for ordering between two objects.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface Ord.AltDefinition<A> +
      Primitives functions of Ord: alternative minimal definition and overridable methods.
      +
      static interface Ord.Definition<A> +
      Primitives functions of Ord: minimal definition and overridable methods.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Ord<java.math.BigDecimal>bigdecimalOrd +
      An order instance for the BigDecimal type.
      +
      static Ord<java.math.BigInteger>bigintOrd +
      An order instance for the BigInteger type.
      +
      static Ord<java.lang.Boolean>booleanOrd +
      An order instance for the boolean type.
      +
      static Ord<java.lang.Byte>byteOrd +
      An order instance for the byte type.
      +
      static Ord<java.lang.Character>charOrd +
      An order instance for the char type.
      +
      static Ord<java.lang.Double>doubleOrd +
      An order instance for the double type.
      +
      static Ord<java.lang.Float>floatOrd +
      An order instance for the float type.
      +
      static Ord<java.lang.Integer>intOrd +
      An order instance for the int type.
      +
      static Ord<java.lang.Long>longOrd +
      An order instance for the long type.
      +
      F<A,F<A,A>>max +
      A function that returns the greater of its two arguments.
      +
      F<A,F<A,A>>min +
      A function that returns the lesser of its two arguments.
      +
      static Ord<Natural>naturalOrd +
      An order instance for the Natural type.
      +
      static Ord<Ordering>orderingOrd +
      An order instance for the Ordering type.
      +
      static Ord<java.lang.Short>shortOrd +
      An order instance for the short type.
      +
      static Ord<java.lang.StringBuffer>stringBufferOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.StringBuilder>stringBuilderOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.String>stringOrd +
      An order instance for the String type.
      +
      static Ord<Unit>unitOrd +
      An order instance for the Unit type.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> Ord<Array<A>>arrayOrd(Ord<A> oa) +
      An order instance for the Array type.
      +
      static <A extends java.lang.Comparable<A>>
      Ord<A>      		comparableOrd() +
      An order instance for the Comparable interface.
      +
      F<A,F<A,Ordering>>compare() +
      First-class ordering.
      +
      Orderingcompare(A a1, + A a2) +
      Returns an ordering for the given arguments.
      +
      static <A,B> Ord<A>contramap(F<A,B> f, + Ord<B> ord) +
      Static version of contramap(F)
      +
      <B> Ord<B>contramap(F<B,A> f) +
      Maps the given function across this ord as a contra-variant functor.
      +
      static <A,B> Ord<Either<A,B>>eitherOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Either type.
      +
      booleaneq(A a1, + A a2) +
      Returns true if the given arguments are equal, false otherwise.
      +
      Equal<A>equal() +
      Returns an Equal for this order.
      +
      static <A> Ord<A>hashEqualsOrd() +
      Deprecated.  +
      As of release 4.7.
      +
      +
      static <A> Ord<A>hashOrd() +
      Deprecated.  +
      As of release 4.7.
      +
      +
      F<A,java.lang.Boolean>isGreaterThan(A a) +
      Returns a function that returns true if its argument is greater than than the argument to this method.
      +
      booleanisGreaterThan(A a1, + A a2) +
      Returns true if the first given argument is greater than the second given + argument, false otherwise.
      +
      F<A,java.lang.Boolean>isLessThan(A a) +
      Returns a function that returns true if its argument is less than the argument to this method.
      +
      booleanisLessThan(A a1, + A a2) +
      Returns true if the first given argument is less than the second given argument, + false otherwise.
      +
      booleanisLessThanOrEqualTo(A a1, + A a2) +
      Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
      +
      static <A> Ord<List<A>>listOrd(Ord<A> oa) +
      An order instance for the List type.
      +
      Amax(A a1, + A a2) +
      Returns the greater of its two arguments.
      +
      Monoid<A>maxMonoid(A zero) 
      Semigroup<A>maxSemigroup() 
      Amin(A a1, + A a2) +
      Returns the lesser of its two arguments.
      +
      Monoid<A>minMonoid(A zero) 
      Semigroup<A>minSemigroup() 
      static <A> Ord<NonEmptyList<A>>nonEmptyListOrd(Ord<A> oa) +
      An order instance for the NonEmptyList type.
      +
      static <A,B> Ord.Definition<A>on(F<A,B> f, + Ord<B> ord) +
      Begin definition of an ord instance.
      +
      static <A> Ord<Option<A>>optionOrd(Ord<A> oa) +
      An order instance for the Option type.
      +
      static <A> Ord<A>ord(F<A,F<A,Ordering>> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ord(F2<A,A,Ordering> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ordDef(Ord.AltDefinition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<A>ordDef(Ord.Definition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<P1<A>>p1Ord(Ord<A> oa) +
      An order instance for a product-1.
      +
      static <A,B> Ord<P2<A,B>>p2Ord(Ord<A> oa, + Ord<B> ob) +
      An order instance for a product-2, with the first factor considered most significant.
      +
      static <A,B> Ord<P2<A,B>>p2Ord1(Ord<A> oa) 
      static <A,B> Ord<P2<A,B>>p2Ord2(Ord<B> ob) 
      static <A,B,C> Ord<P3<A,B,C>>p3Ord(Ord<A> oa, + Ord<B> ob, + Ord<C> oc) +
      An order instance for a product-3, with the first factor considered most significant.
      +
      Ord<A>reverse() 
      static <A> Ord<Set<A>>setOrd(Ord<A> oa) +
      An order instance for the Set type.
      +
      static <A> Ord<Stream<A>>streamOrd(Ord<A> oa) +
      An order instance for the Stream type.
      +
      java.util.Comparator<A>toComparator() 
      static <A,B> Ord<Validation<A,B>>validationOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Validation type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        max

        +
        public final F<A,F<A,A>> max
        +
        A function that returns the greater of its two arguments.
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final F<A,F<A,A>> min
        +
        A function that returns the lesser of its two arguments.
        +
        • +
      + + + +
        +
      • +

        booleanOrd

        +
        public static final Ord<java.lang.Boolean> booleanOrd
        +
        An order instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteOrd

        +
        public static final Ord<java.lang.Byte> byteOrd
        +
        An order instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charOrd

        +
        public static final Ord<java.lang.Character> charOrd
        +
        An order instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleOrd

        +
        public static final Ord<java.lang.Double> doubleOrd
        +
        An order instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatOrd

        +
        public static final Ord<java.lang.Float> floatOrd
        +
        An order instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intOrd

        +
        public static final Ord<java.lang.Integer> intOrd
        +
        An order instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintOrd

        +
        public static final Ord<java.math.BigInteger> bigintOrd
        +
        An order instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalOrd

        +
        public static final Ord<java.math.BigDecimal> bigdecimalOrd
        +
        An order instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longOrd

        +
        public static final Ord<java.lang.Long> longOrd
        +
        An order instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortOrd

        +
        public static final Ord<java.lang.Short> shortOrd
        +
        An order instance for the short type.
        +
        • +
      + + + +
        +
      • +

        orderingOrd

        +
        public static final Ord<Ordering> orderingOrd
        +
        An order instance for the Ordering type.
        +
        • +
      + + + +
        +
      • +

        stringOrd

        +
        public static final Ord<java.lang.String> stringOrd
        +
        An order instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferOrd

        +
        public static final Ord<java.lang.StringBuffer> stringBufferOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderOrd

        +
        public static final Ord<java.lang.StringBuilder> stringBuilderOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        unitOrd

        +
        public static final Ord<Unit> unitOrd
        +
        An order instance for the Unit type.
        +
        • +
      + + + +
        +
      • +

        naturalOrd

        +
        public static final Ord<Natural> naturalOrd
        +
        An order instance for the Natural type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public F<A,F<A,Ordering>> compare()
        +
        First-class ordering.
        +
        +
        Returns:
        +
        A function that returns an ordering for its arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        compare

        +
        public Ordering compare(A a1,
+                        A a2)
        +
        Returns an ordering for the given arguments.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        An ordering for the given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for equality to another.
        +
        a2 - An instance to compare for equality to another.
        +
        Returns:
        +
        true if the given arguments are equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public Equal<A> equal()
        +
        Returns an Equal for this order.
        +
        +
        Returns:
        +
        An Equal for this order.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Ord<B> contramap(F<B,A> f)
        +
        Maps the given function across this ord as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new ord.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(A a1,
+                          A a2)
        +
        Returns true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThanOrEqualTo

        +
        public boolean isLessThanOrEqualTo(A a1,
+                                   A a2)
        +
        Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(A a1,
+                             A a2)
        +
        Returns true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public F<A,java.lang.Boolean> isLessThan(A a)
        +
        Returns a function that returns true if its argument is less than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is less than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public F<A,java.lang.Boolean> isGreaterThan(A a)
        +
        Returns a function that returns true if its argument is greater than than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is greater than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        max

        +
        public A max(A a1,
+             A a2)
        +
        Returns the greater of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The greater of the two values.
        +
        +
        • +
      + + + + + +
        +
      • +

        min

        +
        public A min(A a1,
+             A a2)
        +
        Returns the lesser of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The lesser of the two values.
        +
        +
        • +
      + + + +
        +
      • +

        minSemigroup

        +
        public final Semigroup<A> minSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        minMonoid

        +
        public final Monoid<A> minMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        maxSemigroup

        +
        public final Semigroup<A> maxSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        maxMonoid

        +
        public final Monoid<A> maxMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Ord<A> reverse()
        +
        • +
      + + + + + + + +
        +
      • +

        contramap

        +
        public static <A,B> Ord<A> contramap(F<A,B> f,
+                                     Ord<B> ord)
        +
        Static version of contramap(F)
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F<A,F<A,Ordering>> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F2<A,A,Ordering> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.Definition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.AltDefinition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        optionOrd

        +
        public static <A> Ord<Option<A>> optionOrd(Ord<A> oa)
        +
        An order instance for the Option type.
        +
        +
        Parameters:
        +
        oa - Order across the element of the option.
        +
        Returns:
        +
        An order instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherOrd

        +
        public static <A,B> Ord<Either<A,B>> eitherOrd(Ord<A> oa,
+                                               Ord<B> ob)
        +
        An order instance for the Either type.
        +
        +
        Parameters:
        +
        oa - Order across the left side of Either.
        +
        ob - Order across the right side of Either.
        +
        Returns:
        +
        An order instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        validationOrd

        +
        public static <A,B> Ord<Validation<A,B>> validationOrd(Ord<A> oa,
+                                                       Ord<B> ob)
        +
        An order instance for the Validation type.
        +
        +
        Parameters:
        +
        oa - Order across the failing side of Validation.
        +
        ob - Order across the succeeding side of Validation.
        +
        Returns:
        +
        An order instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listOrd

        +
        public static <A> Ord<List<A>> listOrd(Ord<A> oa)
        +
        An order instance for the List type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the list.
        +
        Returns:
        +
        An order instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListOrd

        +
        public static <A> Ord<NonEmptyList<A>> nonEmptyListOrd(Ord<A> oa)
        +
        An order instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the non-empty list.
        +
        Returns:
        +
        An order instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        streamOrd

        +
        public static <A> Ord<Stream<A>> streamOrd(Ord<A> oa)
        +
        An order instance for the Stream type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the stream.
        +
        Returns:
        +
        An order instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayOrd

        +
        public static <A> Ord<Array<A>> arrayOrd(Ord<A> oa)
        +
        An order instance for the Array type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the array.
        +
        Returns:
        +
        An order instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        setOrd

        +
        public static <A> Ord<Set<A>> setOrd(Ord<A> oa)
        +
        An order instance for the Set type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the set.
        +
        Returns:
        +
        An order instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Ord

        +
        public static <A> Ord<P1<A>> p1Ord(Ord<A> oa)
        +
        An order instance for a product-1.
        +
        +
        Parameters:
        +
        oa - Order across the produced type.
        +
        Returns:
        +
        An order instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord

        +
        public static <A,B> Ord<P2<A,B>> p2Ord(Ord<A> oa,
+                                       Ord<B> ob)
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        Returns:
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord1

        +
        public static <A,B> Ord<P2<A,B>> p2Ord1(Ord<A> oa)
        +
        • +
      + + + +
        +
      • +

        p2Ord2

        +
        public static <A,B> Ord<P2<A,B>> p2Ord2(Ord<B> ob)
        +
        • +
      + + + +
        +
      • +

        p3Ord

        +
        public static <A,B,C> Ord<P3<A,B,C>> p3Ord(Ord<A> oa,
+                                           Ord<B> ob,
+                                           Ord<C> oc)
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        oc - An order instance for the third factor.
        +
        Returns:
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        comparableOrd

        +
        public static <A extends java.lang.Comparable<A>> Ord<A> comparableOrd()
        +
        An order instance for the Comparable interface.
        +
        +
        Returns:
        +
        An order instance for the Comparable interface.
        +
        +
        • +
      + + + +
        +
      • +

        hashOrd

        +
        @Deprecated
+public static <A> Ord<A> hashOrd()
        +
        Deprecated. As of release 4.7.
        +
        An order instance that uses Object.hashCode() for computing the order and equality, + thus objects returning the same hashCode are considered to be equals. + This is not safe and therefore this method is deprecated.
        +
        +
        Returns:
        +
        An order instance that is based on Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        hashEqualsOrd

        +
        @Deprecated
+public static <A> Ord<A> hashEqualsOrd()
        +
        Deprecated. As of release 4.7.
        +
        An order instance that uses Object.hashCode() and Object.equals(java.lang.Object) for computing + the order and equality. First the hashCode is compared, if this is equal, objects are compared + using Object.equals(java.lang.Object). + WARNING: This ordering violate antisymmetry on hash collisions.
        +
        +
        Returns:
        +
        An order instance that is based on Object.hashCode() and Object.equals(java.lang.Object).
        +
        +
        • +
      + + + +
        +
      • +

        toComparator

        +
        public java.util.Comparator<A> toComparator()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Ordering.html b/javadoc/4.8/functionaljava/fj/Ordering.html new file mode 100644 index 0000000..47aa1bb --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Ordering.html @@ -0,0 +1,401 @@ + + + + + +Ordering (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Ordering

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Ordering>
      • +
    • +
        +
      • fj.Ordering
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Ordering>
    +
    +
    +
    +
    public enum Ordering
+extends java.lang.Enum<Ordering>
    +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EQ +
      Equal.
      +
      GT +
      Greater than.
      +
      LT +
      Less than.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static OrderingfromInt(int cmp) 
      Orderingreverse() 
      inttoInt() 
      static OrderingvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Ordering[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        LT

        +
        public static final Ordering LT
        +
        Less than.
        +
        • +
      + + + +
        +
      • +

        EQ

        +
        public static final Ordering EQ
        +
        Equal.
        +
        • +
      + + + +
        +
      • +

        GT

        +
        public static final Ordering GT
        +
        Greater than.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Ordering[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Ordering c : Ordering.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Ordering valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public int toInt()
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Ordering reverse()
        +
        • +
      + + + +
        +
      • +

        fromInt

        +
        public static Ordering fromInt(int cmp)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P.html b/javadoc/4.8/functionaljava/fj/P.html new file mode 100644 index 0000000..888da0a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P.html @@ -0,0 +1,1057 @@ + + + + + +P (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class P
+extends java.lang.Object
    +
    Functions across products.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> P1<A>hardMemo(F0<A> f) +
      Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
      +
      static <A> P1<A>lazy(F<Unit,A> f) 
      static <A,B> P2<A,B>lazy(F<Unit,A> fa, + F<Unit,B> fb) 
      static <A,B,C> P3<A,B,C>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe) 
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff) 
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg) 
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg, + F<Unit,H> fh) 
      static <A> P1<A>lazy(F0<A> f) +
      Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
      +
      static <A,B> P2<A,B>lazy(F0<A> pa, + F0<B> pb) 
      static <A,B,C> P3<A,B,C>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe) 
      static <A,B,C,D,E,F>
      P6<A,B,C,D,E,F>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf) 
      static <A,B,C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg) 
      static <A,B,C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg, + F0<H> ph) 
      static <A,B> P2<A,B>lazyProduct(F0<P2<A,B>> f) 
      static <A> P1<A>p(A a) +
      A function that puts an element in a product-1.
      +
      static <A,B> P2<A,B>p(A a, + B b) +
      A function that puts elements in a product-2.
      +
      static <A,B,C> P3<A,B,C>p(A a, + B b, + C c) +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> P4<A,B,C,D>p(A a, + B b, + C c, + D d) +
      A function that puts elements in a product-4.
      +
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		p(A a, + B b, + C c, + D d, + E e) +
      A function that puts elements in a product-5.
      +
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		p(A a, + B b, + C c, + D d, + E e, + F$ f) +
      A function that puts elements in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      A function that puts elements in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      A function that puts elements in a product-8.
      +
      static <A> F<A,P1<A>>p1() +
      A function that puts an element in a product-1.
      +
      static <A,B> F<A,F<B,P2<A,B>>>p2() +
      A function that puts an element in a product-2.
      +
      static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>>p3() +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>>p4() +
      A function that puts an element in a product-4.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>>      		p5() +
      A function that puts an element in a product-5.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>>      		p6() +
      A function that puts an element in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>>      		p7() +
      A function that puts an element in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>>      		p8() +
      A function that puts an element in a product-8.
      +
      static <A> P1<A>softMemo(F0<A> f) +
      Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
      +
      static <A> P1<A>weakMemo(F0<A> f) +
      Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        p1

        +
        public static <A> F<A,P1<A>> p1()
        +
        A function that puts an element in a product-1.
        +
        +
        Returns:
        +
        A function that puts an element in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A> P1<A> p(A a)
        +
        A function that puts an element in a product-1.
        +
        +
        Parameters:
        +
        a - The element.
        +
        Returns:
        +
        The product-1.
        +
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public static <A> P1<A> hardMemo(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public static <A> P1<A> weakMemo(F0<A> f)
        +
        Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public static <A> P1<A> softMemo(F0<A> f)
        +
        Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie. to avoid OutOfMemoryErrors).
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F0<A> pa,
+                                 F0<B> pb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F0<A> pa,
+                                     F0<B> pb,
+                                     F0<C> pc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F0<A> pa,
+                                         F0<B> pb,
+                                         F0<C> pc,
+                                         F0<D> pd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F0<A> pa,
+                                             F0<B> pb,
+                                             F0<C> pc,
+                                             F0<D> pd,
+                                             F0<E> pe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F> P6<A,B,C,D,E,F> lazy(F0<A> pa,
+                                                 F0<B> pb,
+                                                 F0<C> pc,
+                                                 F0<D> pd,
+                                                 F0<E> pe,
+                                                 F0<F> pf)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G> P7<A,B,C,D,E,F,G> lazy(F0<A> pa,
+                                                     F0<B> pb,
+                                                     F0<C> pc,
+                                                     F0<D> pd,
+                                                     F0<E> pe,
+                                                     F0<F> pf,
+                                                     F0<G> pg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> lazy(F0<A> pa,
+                                                         F0<B> pb,
+                                                         F0<C> pc,
+                                                         F0<D> pd,
+                                                         F0<E> pe,
+                                                         F0<F> pf,
+                                                         F0<G> pg,
+                                                         F0<H> ph)
        +
        • +
      + + + +
        +
      • +

        lazyProduct

        +
        public static <A,B> P2<A,B> lazyProduct(F0<P2<A,B>> f)
        +
        • +
      + + + +
        +
      • +

        p2

        +
        public static <A,B> F<A,F<B,P2<A,B>>> p2()
        +
        A function that puts an element in a product-2.
        +
        +
        Returns:
        +
        A function that puts an element in a product-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B> P2<A,B> p(A a,
+                              B b)
        +
        A function that puts elements in a product-2.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        Returns:
        +
        The product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3

        +
        public static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>> p3()
        +
        A function that puts elements in a product-3.
        +
        +
        Returns:
        +
        A function that puts elements in a product-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C> P3<A,B,C> p(A a,
+                                  B b,
+                                  C c)
        +
        A function that puts elements in a product-3.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        Returns:
        +
        The product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4

        +
        public static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>> p4()
        +
        A function that puts an element in a product-4.
        +
        +
        Returns:
        +
        A function that puts an element in a product-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D> P4<A,B,C,D> p(A a,
+                                      B b,
+                                      C c,
+                                      D d)
        +
        A function that puts elements in a product-4.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        Returns:
        +
        The product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>> p5()
        +
        A function that puts an element in a product-5.
        +
        +
        Returns:
        +
        A function that puts an element in a product-5.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> p(A a,
+                                          B b,
+                                          C c,
+                                          D d,
+                                          E e)
        +
        A function that puts elements in a product-5.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        Returns:
        +
        The product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>> p6()
        +
        A function that puts an element in a product-6.
        +
        +
        Returns:
        +
        A function that puts an element in a product-6.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> p(A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f)
        +
        A function that puts elements in a product-6.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        Returns:
        +
        The product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>> p7()
        +
        A function that puts an element in a product-7.
        +
        +
        Returns:
        +
        A function that puts an element in a product-7.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> p(A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e,
+                                                    F$ f,
+                                                    G g)
        +
        A function that puts elements in a product-7.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        Returns:
        +
        The product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>> p8()
        +
        A function that puts an element in a product-8.
        +
        +
        Returns:
        +
        A function that puts an element in a product-8.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> p(A a,
+                                                        B b,
+                                                        C c,
+                                                        D d,
+                                                        E e,
+                                                        F$ f,
+                                                        G g,
+                                                        H h)
        +
        A function that puts elements in a product-8.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        h - An element.
        +
        Returns:
        +
        The product-8.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F<Unit,A> fa,
+                                 F<Unit,B> fb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F<Unit,A> fa,
+                                     F<Unit,B> fb,
+                                     F<Unit,C> fc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F<Unit,A> fa,
+                                         F<Unit,B> fb,
+                                         F<Unit,C> fc,
+                                         F<Unit,D> fd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F<Unit,A> fa,
+                                             F<Unit,B> fb,
+                                             F<Unit,C> fc,
+                                             F<Unit,D> fd,
+                                             F<Unit,E> fe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> lazy(F<Unit,A> fa,
+                                                   F<Unit,B> fb,
+                                                   F<Unit,C> fc,
+                                                   F<Unit,D> fd,
+                                                   F<Unit,E> fe,
+                                                   F<Unit,F$> ff)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> lazy(F<Unit,A> fa,
+                                                       F<Unit,B> fb,
+                                                       F<Unit,C> fc,
+                                                       F<Unit,D> fd,
+                                                       F<Unit,E> fe,
+                                                       F<Unit,F$> ff,
+                                                       F<Unit,G> fg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> lazy(F<Unit,A> fa,
+                                                           F<Unit,B> fb,
+                                                           F<Unit,C> fc,
+                                                           F<Unit,D> fd,
+                                                           F<Unit,E> fe,
+                                                           F<Unit,F$> ff,
+                                                           F<Unit,G> fg,
+                                                           F<Unit,H> fh)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P1.html b/javadoc/4.8/functionaljava/fj/P1.html new file mode 100644 index 0000000..99473cc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P1.html @@ -0,0 +1,951 @@ + + + + + +P1 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P1<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<A>
    +
    +
    +
    Direct Known Subclasses:
    +
    $
    +
    +
    +
    +
    public abstract class P1<A>
+extends java.lang.Object
+implements F0<A>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P1() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> F<P1<A>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      <B> P1<B>apply(P1<F<A,B>> cf) +
      Performs function application within a P1 (applicative functor pattern).
      +
      <B> P1<B>bind(F<A,P1<B>> f) +
      Binds the given function to the value in a product-1 with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F2<A,B,C> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B> F<B,A>constant() +
      Returns a constant function that always uses this value.
      +
      static <A,B> F<A,P1<B>>curry(F<A,B> f) +
      Promotes the given function so that it returns its value in a P1.
      +
      booleanequals(java.lang.Object other) 
      Af() 
      static <A,B> F<P1<A>,P1<B>>fmap(F<A,B> f) +
      Deprecated.  +
      As of release 4.5, use map_(fj.F<A, B>)
      +
      +
      P1<A>hardMemo() +
      Returns a P1 that remembers its value.
      +
      inthashCode() 
      static <A> P1<A>join(P1<P1<A>> a) +
      Joins a P1 of a P1 with a bind operation.
      +
      static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on P1s.
      +
      <B,C> P1<C>liftM2(P1<B> pb, + F2<A,B,C> f) 
      static <A,B> F<P1<A>,P1<B>>map_(F<A,B> f) +
      Promote any function to a transformation between P1s.
      +
      <B> P1<B>map(F<A,B> f) +
      Map the element of the product.
      +
      P1<A>memo() +
      Deprecated.  +
      since 4.7. Use weakMemo() instead.
      +
      +
      static <A> P1<A>memo(F<Unit,A> f) +
      Deprecated.  +
      since 4.7. Use P.weakMemo(F0) instead.
      +
      +
      static <A> P1<A>memo(F0<A> f) +
      Deprecated.  +
      since 4.7. Use P.weakMemo(F0) instead.
      +
      +
      static <A> P1<Array<A>>sequence(Array<P1<A>> as) +
      Turns an array of P1s into a single P1 of an array.
      +
      static <A> P1<List<A>>sequence(List<P1<A>> as) +
      Turns a List of P1s into a single P1 of a List.
      +
      static <A> P1<Option<A>>sequence(Option<P1<A>> o) +
      Turns an optional P1 into a lazy option.
      +
      static <A> P1<Stream<A>>sequence(Stream<P1<A>> as) +
      Turns a stream of P1s into a single P1 of a stream.
      +
      static <A> F<List<P1<A>>,P1<List<A>>>sequenceList() +
      A first-class version of the sequence method for lists of P1s.
      +
      P1<A>softMemo() +
      Like memo, but the memoized value is wrapped into a SoftReference
      +
      java.lang.StringtoString() 
      <B,X> Either<X,P1<B>>traverseEither(F<A,Either<X,B>> f) +
      Traversable instance of P1 for Either
      +
      <B> List<P1<B>>traverseList(F<A,List<B>> f) +
      Traversable instance of P1 for List
      +
      <B> Option<P1<B>>traverseOption(F<A,Option<B>> f) +
      Traversable instance of P1 for Option
      +
      <B> Stream<P1<B>>traverseStream(F<A,Stream<B>> f) +
      Traversable instance of P1 for Stream
      +
      <B,E> Validation<E,P1<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traversable instance of P1 for Validation
      +
      P1<A>weakMemo() +
      Like memo, but the memoized value is wrapped into a WeakReference
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P1

        +
        public P1()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        public final A f()
        +
        +
        Specified by:
        +
        f in interface F0<A>
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<P1<A>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public static <A,B> F<P1<A>,P1<B>> fmap(F<A,B> f)
        +
        Deprecated. As of release 4.5, use map_(fj.F<A, B>)
        +
        Promote any function to a transformation between P1s.
        +
        +
        Parameters:
        +
        f - A function to promote to a transformation between P1s.
        +
        Returns:
        +
        A function promoted to operate on P1s.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<P1<A>,P1<B>> map_(F<A,B> f)
        +
        Promote any function to a transformation between P1s.
        +
        +
        Parameters:
        +
        f - A function to promote to a transformation between P1s.
        +
        Returns:
        +
        A function promoted to operate on P1s.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> P1<B> bind(F<A,P1<B>> f)
        +
        Binds the given function to the value in a product-1 with a final join.
        +
        +
        Parameters:
        +
        f - A function to apply to the value in a product-1.
        +
        Returns:
        +
        The result of applying the given function to the value of given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B> F<A,P1<B>> curry(F<A,B> f)
        +
        Promotes the given function so that it returns its value in a P1.
        +
        +
        Parameters:
        +
        f - A function to have its result wrapped in a P1.
        +
        Returns:
        +
        A function whose result is wrapped in a P1.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> P1<B> apply(P1<F<A,B>> cf)
        +
        Performs function application within a P1 (applicative functor pattern).
        +
        +
        Parameters:
        +
        cf - The P1 function to apply.
        +
        Returns:
        +
        A new P1 after applying the given P1 function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        +
        Parameters:
        +
        cb - A given P1 to bind the given function with.
        +
        f - The function to apply to the values in the given P1s.
        +
        Returns:
        +
        A new P1 after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F2<A,B,C> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> P1<A> join(P1<P1<A>> a)
        +
        Joins a P1 of a P1 with a bind operation.
        +
        +
        Parameters:
        +
        a - The P1 of a P1 to join.
        +
        Returns:
        +
        A new P1 that is the join of the given P1.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on P1s.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over P1s.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> P1<C> liftM2(P1<B> pb,
+                                F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<List<A>> sequence(List<P1<A>> as)
        +
        Turns a List of P1s into a single P1 of a List.
        +
        +
        Parameters:
        +
        as - The list of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static <A> F<List<P1<A>>,P1<List<A>>> sequenceList()
        +
        A first-class version of the sequence method for lists of P1s.
        +
        +
        Returns:
        +
        A function from a List of P1s to a single P1 of a List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Stream<A>> sequence(Stream<P1<A>> as)
        +
        Turns a stream of P1s into a single P1 of a stream.
        +
        +
        Parameters:
        +
        as - The stream of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Option<A>> sequence(Option<P1<A>> o)
        +
        Turns an optional P1 into a lazy option.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Array<A>> sequence(Array<P1<A>> as)
        +
        Turns an array of P1s into a single P1 of an array.
        +
        +
        Parameters:
        +
        as - The array of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given array.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<P1<B>> traverseList(F<A,List<B>> f)
        +
        Traversable instance of P1 for List
        +
        +
        Parameters:
        +
        f - The function that takes A and produces a List (non-deterministic result)
        +
        Returns:
        +
        A List of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,X> Either<X,P1<B>> traverseEither(F<A,Either<X,B>> f)
        +
        Traversable instance of P1 for Either
        +
        +
        Parameters:
        +
        f - The function produces Either
        +
        Returns:
        +
        An Either of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<P1<B>> traverseOption(F<A,Option<B>> f)
        +
        Traversable instance of P1 for Option
        +
        +
        Parameters:
        +
        f - The function that produces Option
        +
        Returns:
        +
        An Option of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <B,E> Validation<E,P1<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traversable instance of P1 for Validation
        +
        +
        Parameters:
        +
        f - The function might produces Validation
        +
        Returns:
        +
        An Validation of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<P1<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traversable instance of P1 for Stream
        +
        +
        Parameters:
        +
        f - The function that produces Stream
        +
        Returns:
        +
        An Stream of P1
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> P1<B> map(F<A,B> f)
        +
        Map the element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public final P1<A> memo()
        +
        Deprecated. since 4.7. Use weakMemo() instead.
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public P1<A> hardMemo()
        +
        Returns a P1 that remembers its value.
        +
        +
        Returns:
        +
        A P1 that calls this P1 once and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public P1<A> weakMemo()
        +
        Like memo, but the memoized value is wrapped into a WeakReference
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public P1<A> softMemo()
        +
        Like memo, but the memoized value is wrapped into a SoftReference
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public static <A> P1<A> memo(F<Unit,A> f)
        +
        Deprecated. since 4.7. Use P.weakMemo(F0) instead.
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public static <A> P1<A> memo(F0<A> f)
        +
        Deprecated. since 4.7. Use P.weakMemo(F0) instead.
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public final <B> F<B,A> constant()
        +
        Returns a constant function that always uses this value.
        +
        +
        Returns:
        +
        A constant function that always uses this value.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P2.Optic.html b/javadoc/4.8/functionaljava/fj/P2.Optic.html new file mode 100644 index 0000000..f638558 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P2.Optic.html @@ -0,0 +1,291 @@ + + + + + +P2.Optic (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P2.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    P2<A,B>
    +
    +
    +
    +
    public static final class P2.Optic
+extends java.lang.Object
    +
    Optic factory methods for a P2
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Lens<P2<A,B>,A>_1() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C>_1p() +
      Polyomorphic lens targeted on _1.
      +
      static <A,B> Lens<P2<A,B>,B>_2() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C>_2p() +
      Polyomorphic lens targeted on _2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        _1p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C> _1p()
        +
        Polyomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static <A,B> Lens<P2<A,B>,A> _1()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _2p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C> _2p()
        +
        Polyomorphic lens targeted on _2.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static <A,B> Lens<P2<A,B>,B> _2()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P2.html b/javadoc/4.8/functionaljava/fj/P2.html new file mode 100644 index 0000000..9acf65b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P2.html @@ -0,0 +1,1079 @@ + + + + + +P2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class P2<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P2<A,B>
+extends java.lang.Object
    +
    A product-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class P2.Optic +
      Optic factory methods for a P2
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P2() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<P2<A,B>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B> F<P2<A,B>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      <C> P3<A,B,C>append(C el) +
      Creates a P3 by adding the given element to the current P2
      +
      <C,D> P4<A,B,C,D>append(P2<C,D> el) +
      Creates a P4 by adding the given element to the current P2
      +
      <C,D,E> P5<A,B,C,D,E>append(P3<C,D,E> el) +
      Creates a P5 by adding the given element to the current P2
      +
      <C,D,E,F> P6<A,B,C,D,E,F>append(P4<C,D,E,F> el) +
      Creates a P6 by adding the given element to the current P2
      +
      <C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		append(P5<C,D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P2
      +
      <C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P6<C,D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P2
      +
      <C> P2<C,B>cobind(F<P2<A,B>,C> k) +
      Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
      +
      P2<P2<A,B>,B>duplicate() +
      Duplicates this product into the first element (Comonad pattern).
      +
      booleanequals(java.lang.Object other) 
      static <B,C,D> P2<C,D>fanout(F<B,C> f, + F<B,D> g, + B b) +
      Sends the given input value to both argument functions and combines their output.
      +
      inthashCode() 
      <C> P2<C,B>inject(C c) +
      Replaces the first element of this product with the given value.
      +
      static <A,B> P2<B,B>map(F<A,B> f, + P2<A,A> p) +
      Maps the given function across both the elements of the given product.
      +
      static <A,B,X> F<P2<A,B>,P2<X,B>>map1_(F<A,X> f) +
      Promotes a function so that it maps the first element of a product.
      +
      <X> P2<X,B>map1(F<A,X> f) +
      Map the first element of the product.
      +
      static <A,B,X> F<P2<A,B>,P2<A,X>>map2_(F<B,X> f) +
      Promotes a function so that it maps the second element of a product.
      +
      <X> P2<A,X>map2(F<B,X> f) +
      Map the second element of the product.
      +
      P2<A,B>memo() +
      Provides a memoising P2 that remembers its values.
      +
      <C> List<C>sequenceW(List<F<P2<A,B>,C>> fs) +
      Applies a list of comonadic functions to this product, returning a list of values.
      +
      <C> Stream<C>sequenceW(Stream<F<P2<A,B>,C>> fs) +
      Applies a stream of comonadic functions to this product, returning a stream of values.
      +
      static <A,B,C,D> F<P2<A,B>,P2<C,D>>split_(F<A,C> f, + F<B,D> g) +
      A first-class version of the split function.
      +
      <C,D> P2<C,D>split(F<A,C> f, + F<B,D> g) +
      Split this product between two argument functions and combine their output.
      +
      static <A,B> F<P2<A,B>,P2<B,A>>swap_() +
      Returns a curried form of swap().
      +
      P2<B,A>swap() +
      Swaps the elements around in this product.
      +
      java.lang.StringtoString() 
      <C,X> Either<X,P2<A,C>>traverseEither(F<B,Either<X,C>> f) 
      <C> IO<P2<A,C>>traverseIO(F<B,IO<C>> f) 
      <C> List<P2<A,C>>traverseList(F<B,List<C>> f) 
      <C> Option<P2<A,C>>traverseOption(F<B,Option<C>> f) 
      <C> Stream<P2<A,C>>traverseStream(F<B,Stream<C>> f) 
      static <A,B,C> F<P2<A,B>,C>tuple(F<A,F<B,C>> f) +
      Transforms a curried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F<P2<A,B>,C>tuple(F2<A,B,C> f) +
      Transforms an uncurried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F2<A,B,C>untuple(F<P2<A,B>,C> f) +
      Transforms a function of a product-2 to an uncurried function or arity-2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P2

        +
        public P2()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final P2<B,A> swap()
        +
        Swaps the elements around in this product.
        +
        +
        Returns:
        +
        A new product-2 with the elements swapped.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P2<X,B> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P2<A,X> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final <C,D> P2<C,D> split(F<A,C> f,
+                                 F<B,D> g)
        +
        Split this product between two argument functions and combine their output.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of this product.
        +
        g - A function that will map the second element of this product.
        +
        Returns:
        +
        A new product with the first function applied to the second element + and the second function applied to the second element.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <C> P2<C,B> cobind(F<P2<A,B>,C> k)
        +
        Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
        +
        +
        Parameters:
        +
        k - A function to map over the duplicated product.
        +
        Returns:
        +
        A new product with the result of the given function applied to this product as the first element, + and with the second element intact.
        +
        +
        • +
      + + + +
        +
      • +

        duplicate

        +
        public final P2<P2<A,B>,B> duplicate()
        +
        Duplicates this product into the first element (Comonad pattern).
        +
        +
        Returns:
        +
        A new product with this product in its first element and with the second element intact.
        +
        +
        • +
      + + + + + +
        +
      • +

        inject

        +
        public final <C> P2<C,B> inject(C c)
        +
        Replaces the first element of this product with the given value.
        +
        +
        Parameters:
        +
        c - The value with which to replace the first element of this product.
        +
        Returns:
        +
        A new product with the first element replaced with the given value.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> List<C> sequenceW(List<F<P2<A,B>,C>> fs)
        +
        Applies a list of comonadic functions to this product, returning a list of values.
        +
        +
        Parameters:
        +
        fs - A list of functions to apply to this product.
        +
        Returns:
        +
        A list of the results of applying the given list of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <C> List<P2<A,C>> traverseList(F<B,List<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <C> Stream<P2<A,C>> traverseStream(F<B,Stream<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<P2<A,C>> traverseIO(F<B,IO<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <C> Option<P2<A,C>> traverseOption(F<B,Option<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <C,X> Either<X,P2<A,C>> traverseEither(F<B,Either<X,C>> f)
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> Stream<C> sequenceW(Stream<F<P2<A,B>,C>> fs)
        +
        Applies a stream of comonadic functions to this product, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this product.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <C> P3<A,B,C> append(C el)
        +
        Creates a P3 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P3 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D> P4<A,B,C,D> append(P2<C,D> el)
        +
        Creates a P4 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E> P5<A,B,C,D,E> append(P3<C,D,E> el)
        +
        Creates a P5 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F> P6<A,B,C,D,E,F> append(P4<C,D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G> P7<A,B,C,D,E,F,G> append(P5<C,D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P6<C,D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P2<A,B> memo()
        +
        Provides a memoising P2 that remembers its values.
        +
        +
        Returns:
        +
        A P2 that calls this P2 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        split_

        +
        public static <A,B,C,D> F<P2<A,B>,P2<C,D>> split_(F<A,C> f,
+                                                  F<B,D> g)
        +
        A first-class version of the split function.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of the given product.
        +
        g - A function that will map the second element of the given product.
        +
        Returns:
        +
        A function that splits a given product between the two given functions and combines their output.
        +
        +
        • +
      + + + +
        +
      • +

        map1_

        +
        public static <A,B,X> F<P2<A,B>,P2<X,B>> map1_(F<A,X> f)
        +
        Promotes a function so that it maps the first element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the first element of products.
        +
        +
        • +
      + + + +
        +
      • +

        map2_

        +
        public static <A,B,X> F<P2<A,B>,P2<A,X>> map2_(F<B,X> f)
        +
        Promotes a function so that it maps the second element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the second element of products.
        +
        +
        • +
      + + + + + +
        +
      • +

        fanout

        +
        public static <B,C,D> P2<C,D> fanout(F<B,C> f,
+                                     F<B,D> g,
+                                     B b)
        +
        Sends the given input value to both argument functions and combines their output.
        +
        +
        Parameters:
        +
        f - A function to receive an input value.
        +
        g - A function to receive an input value.
        +
        b - An input value to send to both functions.
        +
        Returns:
        +
        The product of the two functions applied to the input value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> P2<B,B> map(F<A,B> f,
+                                P2<A,A> p)
        +
        Maps the given function across both the elements of the given product.
        +
        +
        Parameters:
        +
        f - A function to map over a product.
        +
        p - A product over which to map.
        +
        Returns:
        +
        A new product with the given function applied to both elements.
        +
        +
        • +
      + + + +
        +
      • +

        swap_

        +
        public static <A,B> F<P2<A,B>,P2<B,A>> swap_()
        +
        Returns a curried form of swap().
        +
        +
        Returns:
        +
        A curried form of swap().
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B> F<P2<A,B>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B> F<P2<A,B>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F<A,F<B,C>> f)
        +
        Transforms a curried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - a curried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
        +
        Transforms an uncurried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - an uncurried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        untuple

        +
        public static <A,B,C> F2<A,B,C> untuple(F<P2<A,B>,C> f)
        +
        Transforms a function of a product-2 to an uncurried function or arity-2.
        +
        +
        Parameters:
        +
        f - A function of a product-2 to transform into an uncurried function.
        +
        Returns:
        +
        The function, transformed to an uncurried function of arity-2.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P3.html b/javadoc/4.8/functionaljava/fj/P3.html new file mode 100644 index 0000000..eb3c15f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P3.html @@ -0,0 +1,686 @@ + + + + + +P3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P3<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P3<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P3<A,B,C>
+extends java.lang.Object
    +
    A product-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P3() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<P3<A,B,C>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      <D> P4<A,B,C,D>append(D el) +
      Creates a P4 by adding the given element to the current P3
      +
      <D,E> P5<A,B,C,D,E>append(P2<D,E> el) +
      Creates a P5 by adding the given element to the current P3
      +
      <D,E,F> P6<A,B,C,D,E,F>append(P3<D,E,F> el) +
      Creates a P6 by adding the given element to the current P3
      +
      <D,E,F,G> P7<A,B,C,D,E,F,G>append(P4<D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P3
      +
      <D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P5<D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P3
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P3<X,B,C>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P3<A,X,C>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P3<A,B,X>map3(F<C,X> f) +
      Map the third element of the product.
      +
      P3<A,B,C>memo() +
      Provides a memoising P3 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P3

        +
        public P3()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P3<X,B,C> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P3<A,X,C> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P3<A,B,X> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <D> P4<A,B,C,D> append(D el)
        +
        Creates a P4 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E> P5<A,B,C,D,E> append(P2<D,E> el)
        +
        Creates a P5 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F> P6<A,B,C,D,E,F> append(P3<D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G> P7<A,B,C,D,E,F,G> append(P4<D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P5<D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P3<A,B,C> memo()
        +
        Provides a memoising P3 that remembers its values.
        +
        +
        Returns:
        +
        A P3 that calls this P3 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C> F<P3<A,B,C>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C> F<P3<A,B,C>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C> F<P3<A,B,C>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P4.html b/javadoc/4.8/functionaljava/fj/P4.html new file mode 100644 index 0000000..71f3ec7 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P4.html @@ -0,0 +1,746 @@ + + + + + +P4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P4<A,B,C,D>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P4<A,B,C,D>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P4<A,B,C,D>
+extends java.lang.Object
    +
    A product-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P4() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D> F<P4<A,B,C,D>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,D>__4() +
      Returns a function that returns the fourth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      <E> P5<A,B,C,D,E>append(E el) +
      Creates a P5 by adding the given element to the current P4
      +
      <E,F> P6<A,B,C,D,E,F>append(P2<E,F> el) +
      Creates a P6 by adding the given element to the current P4
      +
      <E,F,G> P7<A,B,C,D,E,F,G>append(P3<E,F,G> el) +
      Creates a P7 by adding the given element to the current P4
      +
      <E,F,G,H> P8<A,B,C,D,E,F,G,H>append(P4<E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P4
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P4<X,B,C,D>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P4<A,X,C,D>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P4<A,B,X,D>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P4<A,B,C,X>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      P4<A,B,C,D>memo() +
      Provides a memoising P4 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P4

        +
        public P4()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P4<X,B,C,D> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P4<A,X,C,D> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P4<A,B,X,D> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P4<A,B,C,X> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <E> P5<A,B,C,D,E> append(E el)
        +
        Creates a P5 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F> P6<A,B,C,D,E,F> append(P2<E,F> el)
        +
        Creates a P6 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G> P7<A,B,C,D,E,F,G> append(P3<E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P4<E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P4<A,B,C,D> memo()
        +
        Provides a memoising P4 that remembers its values.
        +
        +
        Returns:
        +
        A P4 that calls this P4 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P5.html b/javadoc/4.8/functionaljava/fj/P5.html new file mode 100644 index 0000000..f71b656 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P5.html @@ -0,0 +1,806 @@ + + + + + +P5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P5<A,B,C,D,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P5<A,B,C,D,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P5<A,B,C,D,E>
+extends java.lang.Object
    +
    A product-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P5() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      <F> P6<A,B,C,D,E,F>append(F el) +
      Creates a P6 by adding the given element to the current P5
      +
      <F,G> P7<A,B,C,D,E,F,G>append(P2<F,G> el) +
      Creates a P7 by adding the given element to the current P5
      +
      <F,G,H> P8<A,B,C,D,E,F,G,H>append(P3<F,G,H> el) +
      Creates a P8 by adding the given element to the current P5
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P5<X,B,C,D,E>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P5<A,X,C,D,E>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P5<A,B,X,D,E>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P5<A,B,C,X,E>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P5<A,B,C,D,X>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      P5<A,B,C,D,E>memo() +
      Provides a memoising P5 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P5

        +
        public P5()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P5<X,B,C,D,E> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P5<A,X,C,D,E> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P5<A,B,X,D,E> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P5<A,B,C,X,E> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P5<A,B,C,D,X> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <F> P6<A,B,C,D,E,F> append(F el)
        +
        Creates a P6 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G> P7<A,B,C,D,E,F,G> append(P2<F,G> el)
        +
        Creates a P7 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G,H> P8<A,B,C,D,E,F,G,H> append(P3<F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P5<A,B,C,D,E> memo()
        +
        Provides a memoising P5 that remembers its values.
        +
        +
        Returns:
        +
        A P5 that calls this P5 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P6.html b/javadoc/4.8/functionaljava/fj/P6.html new file mode 100644 index 0000000..0326ca9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P6.html @@ -0,0 +1,866 @@ + + + + + +P6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P6<A,B,C,D,E,F>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P6<A,B,C,D,E,F>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P6<A,B,C,D,E,F>
+extends java.lang.Object
    +
    A product-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P6() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      <G> P7<A,B,C,D,E,F,G>append(G el) +
      Creates a P7 by adding the given element to the current P6
      +
      <G,H> P8<A,B,C,D,E,F,G,H>append(P2<G,H> el) +
      Creates a P8 by adding the given element to the current P6
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P6<X,B,C,D,E,F>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P6<A,X,C,D,E,F>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P6<A,B,X,D,E,F>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P6<A,B,C,X,E,F>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P6<A,B,C,D,X,F>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P6<A,B,C,D,E,X>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      P6<A,B,C,D,E,F>memo() +
      Provides a memoising P6 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P6

        +
        public P6()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P6<X,B,C,D,E,F> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P6<A,X,C,D,E,F> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P6<A,B,X,D,E,F> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P6<A,B,C,X,E,F> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P6<A,B,C,D,X,F> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P6<A,B,C,D,E,X> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <G> P7<A,B,C,D,E,F,G> append(G el)
        +
        Creates a P7 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <G,H> P8<A,B,C,D,E,F,G,H> append(P2<G,H> el)
        +
        Creates a P8 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P6<A,B,C,D,E,F> memo()
        +
        Provides a memoising P6 that remembers its values.
        +
        +
        Returns:
        +
        A P6 that calls this P6 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P7.html b/javadoc/4.8/functionaljava/fj/P7.html new file mode 100644 index 0000000..0922ccd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P7.html @@ -0,0 +1,926 @@ + + + + + +P7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P7<A,B,C,D,E,F,G>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P7<A,B,C,D,E,F,G>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P7<A,B,C,D,E,F,G>
+extends java.lang.Object
    +
    A product-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P7() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      <H> P8<A,B,C,D,E,F,G,H>append(H el) +
      Creates a P8 by adding the given element to the current P7
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P7<X,B,C,D,E,F,G>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P7<A,X,C,D,E,F,G>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P7<A,B,X,D,E,F,G>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P7<A,B,C,X,E,F,G>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P7<A,B,C,D,X,F,G>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P7<A,B,C,D,E,X,G>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P7<A,B,C,D,E,F,X>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      P7<A,B,C,D,E,F,G>memo() +
      Provides a memoising P7 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P7

        +
        public P7()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P7<X,B,C,D,E,F,G> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P7<A,X,C,D,E,F,G> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P7<A,B,X,D,E,F,G> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P7<A,B,C,X,E,F,G> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P7<A,B,C,D,X,F,G> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P7<A,B,C,D,E,X,G> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P7<A,B,C,D,E,F,X> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <H> P8<A,B,C,D,E,F,G,H> append(H el)
        +
        Creates a P8 by adding the given element to the current P7
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P7 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P7<A,B,C,D,E,F,G> memo()
        +
        Provides a memoising P7 that remembers its values.
        +
        +
        Returns:
        +
        A P7 that calls this P7 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/P8.html b/javadoc/4.8/functionaljava/fj/P8.html new file mode 100644 index 0000000..bb2a806 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/P8.html @@ -0,0 +1,984 @@ + + + + + +P8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P8<A,B,C,D,E,F,G,H>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P8<A,B,C,D,E,F,G,H>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P8<A,B,C,D,E,F,G,H>
+extends java.lang.Object
    +
    A product-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P8() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,H>      		__8() +
      Returns a function that returns the eighth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      P1<H>_8_() +
      Returns the 1-product projection over the eighth element.
      +
      abstract H_8() +
      Access the eighth element of the product.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P8<X,B,C,D,E,F,G,H>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P8<A,X,C,D,E,F,G,H>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P8<A,B,X,D,E,F,G,H>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P8<A,B,C,X,E,F,G,H>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P8<A,B,C,D,X,F,G,H>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P8<A,B,C,D,E,X,G,H>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P8<A,B,C,D,E,F,X,H>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      <X> P8<A,B,C,D,E,F,G,X>map8(F<H,X> f) +
      Map the eighth element of the product.
      +
      P8<A,B,C,D,E,F,G,H>memo() +
      Provides a memoising P8 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P8

        +
        public P8()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public abstract H _8()
        +
        Access the eighth element of the product.
        +
        +
        Returns:
        +
        The eighth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P8<X,B,C,D,E,F,G,H> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P8<A,X,C,D,E,F,G,H> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P8<A,B,X,D,E,F,G,H> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P8<A,B,C,X,E,F,G,H> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P8<A,B,C,D,X,F,G,H> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P8<A,B,C,D,E,X,G,H> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P8<A,B,C,D,E,F,X,H> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map8

        +
        public final <X> P8<A,B,C,D,E,F,G,X> map8(F<H,X> f)
        +
        Map the eighth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + +
        +
      • +

        _8_

        +
        public final P1<H> _8_()
        +
        Returns the 1-product projection over the eighth element.
        +
        +
        Returns:
        +
        the 1-product projection over the eighth element.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P8<A,B,C,D,E,F,G,H> memo()
        +
        Provides a memoising P8 that remembers its values.
        +
        +
        Returns:
        +
        A P8 that calls this P8 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,H> __8()
        +
        Returns a function that returns the eighth element of a product.
        +
        +
        Returns:
        +
        A function that returns the eighth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Primitive.html b/javadoc/4.8/functionaljava/fj/Primitive.html new file mode 100644 index 0000000..4e29292 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Primitive.html @@ -0,0 +1,1121 @@ + + + + + +Primitive (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Primitive

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Primitive
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Primitive
+extends java.lang.Object
    +
    Functions that convert between Java primitive types.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,java.lang.Byte>Boolean_Byte +
      A function that converts booleans to bytes.
      +
      static F<java.lang.Boolean,java.lang.Character>Boolean_Character +
      A function that converts booleans to characters.
      +
      static F<java.lang.Boolean,java.lang.Double>Boolean_Double +
      A function that converts booleans to doubles.
      +
      static F<java.lang.Boolean,java.lang.Float>Boolean_Float +
      A function that converts booleans to floats.
      +
      static F<java.lang.Boolean,java.lang.Integer>Boolean_Integer +
      A function that converts booleans to integers.
      +
      static F<java.lang.Boolean,java.lang.Long>Boolean_Long +
      A function that converts booleans to longs.
      +
      static F<java.lang.Boolean,java.lang.Short>Boolean_Short +
      A function that converts booleans to shorts.
      +
      static F<java.lang.Byte,java.lang.Boolean>Byte_Boolean +
      A function that converts bytes to booleans.
      +
      static F<java.lang.Byte,java.lang.Character>Byte_Character +
      A function that converts bytes to characters.
      +
      static F<java.lang.Byte,java.lang.Double>Byte_Double +
      A function that converts bytes to doubles.
      +
      static F<java.lang.Byte,java.lang.Float>Byte_Float +
      A function that converts bytes to floats.
      +
      static F<java.lang.Byte,java.lang.Integer>Byte_Integer +
      A function that converts bytes to integers.
      +
      static F<java.lang.Byte,java.lang.Long>Byte_Long +
      A function that converts bytes to longs.
      +
      static F<java.lang.Byte,java.lang.Short>Byte_Short +
      A function that converts bytes to shorts.
      +
      static F<java.lang.Character,java.lang.Boolean>Character_Boolean +
      A function that converts characters to booleans.
      +
      static F<java.lang.Character,java.lang.Byte>Character_Byte +
      A function that converts characters to bytes.
      +
      static F<java.lang.Character,java.lang.Double>Character_Double +
      A function that converts characters to doubles.
      +
      static F<java.lang.Character,java.lang.Float>Character_Float +
      A function that converts characters to floats.
      +
      static F<java.lang.Character,java.lang.Integer>Character_Integer +
      A function that converts characters to integers.
      +
      static F<java.lang.Character,java.lang.Long>Character_Long +
      A function that converts characters to longs.
      +
      static F<java.lang.Character,java.lang.Short>Character_Short +
      A function that converts characters to shorts.
      +
      static F<java.lang.Double,java.lang.Boolean>Double_Boolean +
      A function that converts doubles to booleans.
      +
      static F<java.lang.Double,java.lang.Byte>Double_Byte +
      A function that converts doubles to bytes.
      +
      static F<java.lang.Double,java.lang.Character>Double_Character +
      A function that converts doubles to characters.
      +
      static F<java.lang.Double,java.lang.Float>Double_Float +
      A function that converts doubles to floats.
      +
      static F<java.lang.Double,java.lang.Integer>Double_Integer +
      A function that converts doubles to integers.
      +
      static F<java.lang.Double,java.lang.Long>Double_Long +
      A function that converts doubles to longs.
      +
      static F<java.lang.Double,java.lang.Short>Double_Short +
      A function that converts doubles to shorts.
      +
      static F<java.lang.Float,java.lang.Boolean>Float_Boolean +
      A function that converts floats to booleans.
      +
      static F<java.lang.Float,java.lang.Byte>Float_Byte +
      A function that converts floats to bytes.
      +
      static F<java.lang.Float,java.lang.Character>Float_Character +
      A function that converts floats to characters.
      +
      static F<java.lang.Float,java.lang.Double>Float_Double +
      A function that converts floats to doubles.
      +
      static F<java.lang.Float,java.lang.Integer>Float_Integer +
      A function that converts floats to integers.
      +
      static F<java.lang.Float,java.lang.Long>Float_Long +
      A function that converts floats to longs.
      +
      static F<java.lang.Float,java.lang.Short>Float_Short +
      A function that converts floats to shorts.
      +
      static F<java.lang.Integer,java.lang.Boolean>Integer_Boolean +
      A function that converts integers to booleans.
      +
      static F<java.lang.Integer,java.lang.Byte>Integer_Byte +
      A function that converts integers to bytes.
      +
      static F<java.lang.Integer,java.lang.Character>Integer_Character +
      A function that converts integers to characters.
      +
      static F<java.lang.Integer,java.lang.Double>Integer_Double +
      A function that converts integers to doubles.
      +
      static F<java.lang.Integer,java.lang.Float>Integer_Float +
      A function that converts integers to floats.
      +
      static F<java.lang.Integer,java.lang.Long>Integer_Long +
      A function that converts integers to longs.
      +
      static F<java.lang.Integer,java.lang.Short>Integer_Short +
      A function that converts integers to shorts.
      +
      static F<java.lang.Long,java.lang.Boolean>Long_Boolean +
      A function that converts longs to booleans.
      +
      static F<java.lang.Long,java.lang.Byte>Long_Byte +
      A function that converts longs to bytes.
      +
      static F<java.lang.Long,java.lang.Character>Long_Character +
      A function that converts longs to characters.
      +
      static F<java.lang.Long,java.lang.Double>Long_Double +
      A function that converts longs to doubles.
      +
      static F<java.lang.Long,java.lang.Float>Long_Float +
      A function that converts longs to floats.
      +
      static F<java.lang.Long,java.lang.Integer>Long_Integer +
      A function that converts longs to integers.
      +
      static F<java.lang.Long,java.lang.Short>Long_Short +
      A function that converts longs to shorts.
      +
      static F<java.lang.Short,java.lang.Boolean>Short_Boolean +
      A function that converts shorts to booleans.
      +
      static F<java.lang.Short,java.lang.Byte>Short_Byte +
      A function that converts shorts to bytes.
      +
      static F<java.lang.Short,java.lang.Character>Short_Character +
      A function that converts shorts to characters.
      +
      static F<java.lang.Short,java.lang.Double>Short_Double +
      A function that converts shorts to doubles.
      +
      static F<java.lang.Short,java.lang.Float>Short_Float +
      A function that converts shorts to floats.
      +
      static F<java.lang.Short,java.lang.Integer>Short_Integer +
      A function that converts shorts to integers.
      +
      static F<java.lang.Short,java.lang.Long>Short_Long +
      A function that converts shorts to longs.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        Boolean_Byte

        +
        public static final F<java.lang.Boolean,java.lang.Byte> Boolean_Byte
        +
        A function that converts booleans to bytes.
        +
        • +
      + + + +
        +
      • +

        Boolean_Character

        +
        public static final F<java.lang.Boolean,java.lang.Character> Boolean_Character
        +
        A function that converts booleans to characters.
        +
        • +
      + + + +
        +
      • +

        Boolean_Double

        +
        public static final F<java.lang.Boolean,java.lang.Double> Boolean_Double
        +
        A function that converts booleans to doubles.
        +
        • +
      + + + +
        +
      • +

        Boolean_Float

        +
        public static final F<java.lang.Boolean,java.lang.Float> Boolean_Float
        +
        A function that converts booleans to floats.
        +
        • +
      + + + +
        +
      • +

        Boolean_Integer

        +
        public static final F<java.lang.Boolean,java.lang.Integer> Boolean_Integer
        +
        A function that converts booleans to integers.
        +
        • +
      + + + +
        +
      • +

        Boolean_Long

        +
        public static final F<java.lang.Boolean,java.lang.Long> Boolean_Long
        +
        A function that converts booleans to longs.
        +
        • +
      + + + +
        +
      • +

        Boolean_Short

        +
        public static final F<java.lang.Boolean,java.lang.Short> Boolean_Short
        +
        A function that converts booleans to shorts.
        +
        • +
      + + + +
        +
      • +

        Byte_Boolean

        +
        public static final F<java.lang.Byte,java.lang.Boolean> Byte_Boolean
        +
        A function that converts bytes to booleans.
        +
        • +
      + + + +
        +
      • +

        Byte_Character

        +
        public static final F<java.lang.Byte,java.lang.Character> Byte_Character
        +
        A function that converts bytes to characters.
        +
        • +
      + + + +
        +
      • +

        Byte_Double

        +
        public static final F<java.lang.Byte,java.lang.Double> Byte_Double
        +
        A function that converts bytes to doubles.
        +
        • +
      + + + +
        +
      • +

        Byte_Float

        +
        public static final F<java.lang.Byte,java.lang.Float> Byte_Float
        +
        A function that converts bytes to floats.
        +
        • +
      + + + +
        +
      • +

        Byte_Integer

        +
        public static final F<java.lang.Byte,java.lang.Integer> Byte_Integer
        +
        A function that converts bytes to integers.
        +
        • +
      + + + +
        +
      • +

        Byte_Long

        +
        public static final F<java.lang.Byte,java.lang.Long> Byte_Long
        +
        A function that converts bytes to longs.
        +
        • +
      + + + +
        +
      • +

        Byte_Short

        +
        public static final F<java.lang.Byte,java.lang.Short> Byte_Short
        +
        A function that converts bytes to shorts.
        +
        • +
      + + + +
        +
      • +

        Character_Boolean

        +
        public static final F<java.lang.Character,java.lang.Boolean> Character_Boolean
        +
        A function that converts characters to booleans.
        +
        • +
      + + + +
        +
      • +

        Character_Byte

        +
        public static final F<java.lang.Character,java.lang.Byte> Character_Byte
        +
        A function that converts characters to bytes.
        +
        • +
      + + + +
        +
      • +

        Character_Double

        +
        public static final F<java.lang.Character,java.lang.Double> Character_Double
        +
        A function that converts characters to doubles.
        +
        • +
      + + + +
        +
      • +

        Character_Float

        +
        public static final F<java.lang.Character,java.lang.Float> Character_Float
        +
        A function that converts characters to floats.
        +
        • +
      + + + +
        +
      • +

        Character_Integer

        +
        public static final F<java.lang.Character,java.lang.Integer> Character_Integer
        +
        A function that converts characters to integers.
        +
        • +
      + + + +
        +
      • +

        Character_Long

        +
        public static final F<java.lang.Character,java.lang.Long> Character_Long
        +
        A function that converts characters to longs.
        +
        • +
      + + + +
        +
      • +

        Character_Short

        +
        public static final F<java.lang.Character,java.lang.Short> Character_Short
        +
        A function that converts characters to shorts.
        +
        • +
      + + + +
        +
      • +

        Double_Boolean

        +
        public static final F<java.lang.Double,java.lang.Boolean> Double_Boolean
        +
        A function that converts doubles to booleans.
        +
        • +
      + + + +
        +
      • +

        Double_Byte

        +
        public static final F<java.lang.Double,java.lang.Byte> Double_Byte
        +
        A function that converts doubles to bytes.
        +
        • +
      + + + +
        +
      • +

        Double_Character

        +
        public static final F<java.lang.Double,java.lang.Character> Double_Character
        +
        A function that converts doubles to characters.
        +
        • +
      + + + +
        +
      • +

        Double_Float

        +
        public static final F<java.lang.Double,java.lang.Float> Double_Float
        +
        A function that converts doubles to floats.
        +
        • +
      + + + +
        +
      • +

        Double_Integer

        +
        public static final F<java.lang.Double,java.lang.Integer> Double_Integer
        +
        A function that converts doubles to integers.
        +
        • +
      + + + +
        +
      • +

        Double_Long

        +
        public static final F<java.lang.Double,java.lang.Long> Double_Long
        +
        A function that converts doubles to longs.
        +
        • +
      + + + +
        +
      • +

        Double_Short

        +
        public static final F<java.lang.Double,java.lang.Short> Double_Short
        +
        A function that converts doubles to shorts.
        +
        • +
      + + + +
        +
      • +

        Float_Boolean

        +
        public static final F<java.lang.Float,java.lang.Boolean> Float_Boolean
        +
        A function that converts floats to booleans.
        +
        • +
      + + + +
        +
      • +

        Float_Byte

        +
        public static final F<java.lang.Float,java.lang.Byte> Float_Byte
        +
        A function that converts floats to bytes.
        +
        • +
      + + + +
        +
      • +

        Float_Character

        +
        public static final F<java.lang.Float,java.lang.Character> Float_Character
        +
        A function that converts floats to characters.
        +
        • +
      + + + +
        +
      • +

        Float_Double

        +
        public static final F<java.lang.Float,java.lang.Double> Float_Double
        +
        A function that converts floats to doubles.
        +
        • +
      + + + +
        +
      • +

        Float_Integer

        +
        public static final F<java.lang.Float,java.lang.Integer> Float_Integer
        +
        A function that converts floats to integers.
        +
        • +
      + + + +
        +
      • +

        Float_Long

        +
        public static final F<java.lang.Float,java.lang.Long> Float_Long
        +
        A function that converts floats to longs.
        +
        • +
      + + + +
        +
      • +

        Float_Short

        +
        public static final F<java.lang.Float,java.lang.Short> Float_Short
        +
        A function that converts floats to shorts.
        +
        • +
      + + + +
        +
      • +

        Integer_Boolean

        +
        public static final F<java.lang.Integer,java.lang.Boolean> Integer_Boolean
        +
        A function that converts integers to booleans.
        +
        • +
      + + + +
        +
      • +

        Integer_Byte

        +
        public static final F<java.lang.Integer,java.lang.Byte> Integer_Byte
        +
        A function that converts integers to bytes.
        +
        • +
      + + + +
        +
      • +

        Integer_Character

        +
        public static final F<java.lang.Integer,java.lang.Character> Integer_Character
        +
        A function that converts integers to characters.
        +
        • +
      + + + +
        +
      • +

        Integer_Double

        +
        public static final F<java.lang.Integer,java.lang.Double> Integer_Double
        +
        A function that converts integers to doubles.
        +
        • +
      + + + +
        +
      • +

        Integer_Float

        +
        public static final F<java.lang.Integer,java.lang.Float> Integer_Float
        +
        A function that converts integers to floats.
        +
        • +
      + + + +
        +
      • +

        Integer_Long

        +
        public static final F<java.lang.Integer,java.lang.Long> Integer_Long
        +
        A function that converts integers to longs.
        +
        • +
      + + + +
        +
      • +

        Integer_Short

        +
        public static final F<java.lang.Integer,java.lang.Short> Integer_Short
        +
        A function that converts integers to shorts.
        +
        • +
      + + + +
        +
      • +

        Long_Boolean

        +
        public static final F<java.lang.Long,java.lang.Boolean> Long_Boolean
        +
        A function that converts longs to booleans.
        +
        • +
      + + + +
        +
      • +

        Long_Byte

        +
        public static final F<java.lang.Long,java.lang.Byte> Long_Byte
        +
        A function that converts longs to bytes.
        +
        • +
      + + + +
        +
      • +

        Long_Character

        +
        public static final F<java.lang.Long,java.lang.Character> Long_Character
        +
        A function that converts longs to characters.
        +
        • +
      + + + +
        +
      • +

        Long_Double

        +
        public static final F<java.lang.Long,java.lang.Double> Long_Double
        +
        A function that converts longs to doubles.
        +
        • +
      + + + +
        +
      • +

        Long_Float

        +
        public static final F<java.lang.Long,java.lang.Float> Long_Float
        +
        A function that converts longs to floats.
        +
        • +
      + + + +
        +
      • +

        Long_Integer

        +
        public static final F<java.lang.Long,java.lang.Integer> Long_Integer
        +
        A function that converts longs to integers.
        +
        • +
      + + + +
        +
      • +

        Long_Short

        +
        public static final F<java.lang.Long,java.lang.Short> Long_Short
        +
        A function that converts longs to shorts.
        +
        • +
      + + + +
        +
      • +

        Short_Boolean

        +
        public static final F<java.lang.Short,java.lang.Boolean> Short_Boolean
        +
        A function that converts shorts to booleans.
        +
        • +
      + + + +
        +
      • +

        Short_Byte

        +
        public static final F<java.lang.Short,java.lang.Byte> Short_Byte
        +
        A function that converts shorts to bytes.
        +
        • +
      + + + +
        +
      • +

        Short_Character

        +
        public static final F<java.lang.Short,java.lang.Character> Short_Character
        +
        A function that converts shorts to characters.
        +
        • +
      + + + +
        +
      • +

        Short_Double

        +
        public static final F<java.lang.Short,java.lang.Double> Short_Double
        +
        A function that converts shorts to doubles.
        +
        • +
      + + + +
        +
      • +

        Short_Float

        +
        public static final F<java.lang.Short,java.lang.Float> Short_Float
        +
        A function that converts shorts to floats.
        +
        • +
      + + + +
        +
      • +

        Short_Integer

        +
        public static final F<java.lang.Short,java.lang.Integer> Short_Integer
        +
        A function that converts shorts to integers.
        +
        • +
      + + + +
        +
      • +

        Short_Long

        +
        public static final F<java.lang.Short,java.lang.Long> Short_Long
        +
        A function that converts shorts to longs.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Rng.html b/javadoc/4.8/functionaljava/fj/Rng.html new file mode 100644 index 0000000..e8acb2e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Rng.html @@ -0,0 +1,315 @@ + + + + + +Rng (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Rng

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Rng
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    LcgRng
    +
    +
    +
    +
    public abstract class Rng
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Rng() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Rng

        +
        public Rng()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextInt

        +
        public abstract P2<Rng,java.lang.Integer> nextInt()
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public abstract P2<Rng,java.lang.Long> nextLong()
        +
        • +
      + + + +
        +
      • +

        range

        +
        public final P2<Rng,java.lang.Integer> range(int low,
+                                             int high)
        +
        • +
      + + + +
        +
      • +

        nextNatural

        +
        public final P2<Rng,java.lang.Integer> nextNatural()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Semigroup.AltDefinition.html b/javadoc/4.8/functionaljava/fj/Semigroup.AltDefinition.html new file mode 100644 index 0000000..8a418af --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Semigroup.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Semigroup.AltDefinition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Semigroup.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Semigroup<A>
    +
    +
    +
    +
    public static interface Semigroup.AltDefinition<A>
+extends Semigroup.Definition<A>
    +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Semigroup.Definition.html b/javadoc/4.8/functionaljava/fj/Semigroup.Definition.html new file mode 100644 index 0000000..2d706c5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Semigroup.Definition.html @@ -0,0 +1,294 @@ + + + + + +Semigroup.Definition (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Semigroup.html b/javadoc/4.8/functionaljava/fj/Semigroup.html new file mode 100644 index 0000000..63eee87 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Semigroup.html @@ -0,0 +1,1355 @@ + + + + + +Semigroup (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Semigroup<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Semigroup<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Semigroup<A>
+extends java.lang.Object
    +
    Implementations must satisfy the law of associativity: +
      +
    • Associativity; forall x. forall y. forall z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionSemigroup

        +
        public static final Semigroup<java.lang.Integer> intAdditionSemigroup
        +
        A semigroup that adds integers.
        +
        • +
      + + + +
        +
      • +

        doubleAdditionSemigroup

        +
        @Deprecated
+public static final Semigroup<java.lang.Double> doubleAdditionSemigroup
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        intMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMultiplicationSemigroup
        +
        A semigroup that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        doubleMultiplicationSemigroup

        +
        @Deprecated
+public static final Semigroup<java.lang.Double> doubleMultiplicationSemigroup
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        intMaximumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMaximumSemigroup
        +
        A semigroup that yields the maximum of integers.
        +
        • +
      + + + +
        +
      • +

        intMinimumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMinimumSemigroup
        +
        A semigroup that yields the minimum of integers.
        +
        • +
      + + + +
        +
      • +

        bigintAdditionSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintAdditionSemigroup
        +
        A semigroup that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMultiplicationSemigroup
        +
        A semigroup that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMaximumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMaximumSemigroup
        +
        A semigroup that yields the maximum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMinimumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMinimumSemigroup
        +
        A semigroup that yields the minimum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalAdditionSemigroup
        +
        A semigroup that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalMultiplicationSemigroup
        +
        A semigroup that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMaximumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMaximumSemigroup
        +
        A semigroup that yields the maximum of big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMinimumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMinimumSemigroup
        +
        A semigroup that yields the minimum of big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationSemigroup

        +
        public static final Semigroup<Natural> naturalMultiplicationSemigroup
        +
        A semigroup that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionSemigroup

        +
        public static final Semigroup<Natural> naturalAdditionSemigroup
        +
        A semigroup that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMaximumSemigroup

        +
        public static final Semigroup<Natural> naturalMaximumSemigroup
        +
        A semigroup that yields the maximum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMinimumSemigroup

        +
        public static final Semigroup<Natural> naturalMinimumSemigroup
        +
        A semigroup that yields the minimum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionSemigroup

        +
        public static final Semigroup<java.lang.Long> longAdditionSemigroup
        +
        A semigroup that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Long> longMultiplicationSemigroup
        +
        A semigroup that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        longMaximumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMaximumSemigroup
        +
        A semigroup that yields the maximum of longs.
        +
        • +
      + + + +
        +
      • +

        longMinimumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMinimumSemigroup
        +
        A semigroup that yields the minimum of longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> disjunctionSemigroup
        +
        A semigroup that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionSemiGroup

        +
        public static final Semigroup<java.lang.Boolean> exclusiveDisjunctionSemiGroup
        +
        A semigroup that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> conjunctionSemigroup
        +
        A semigroup that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringSemigroup

        +
        public static final Semigroup<java.lang.String> stringSemigroup
        +
        A semigroup that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferSemigroup

        +
        public static final Semigroup<java.lang.StringBuffer> stringBufferSemigroup
        +
        A semigroup that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderSemigroup

        +
        public static final Semigroup<java.lang.StringBuilder> stringBuilderSemigroup
        +
        A semigroup that appends string builders.
        +
        • +
      + + + +
        +
      • +

        unitSemigroup

        +
        public static final Semigroup<Unit> unitSemigroup
        +
        A semigroup for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this semigroup.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this semigroup.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this semigroup.
        +
        +
        Returns:
        +
        A function that sums according to this semigroup.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply1p

        +
        public A multiply1p(int n,
+                    A a)
        +
        Returns a value summed n + 1 times ( + a + a + ... + a) The default definition uses peasant + multiplication, exploiting associativity to only require `O(log n)` uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed n + 1 times
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumNel

        +
        public A sumNel(NonEmptyList<A> as)
        +
        Sums the given values with left-fold.
        +
        • +
      + + + + + +
        +
      • +

        sumStream

        +
        public A sumStream(A a,
+                   F0<Stream<A>> as)
        +
        Sums the given values with left-fold, shortcutting the computation as early as possible.
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Semigroup<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public Monoid<Option<A>> lift()
        +
        Lifts the semigroup to obtain a trivial monoid.
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Semigroup<B> xmap(F<A,B> f,
+                             F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + + + + + + + +
        +
      • +

        monoid

        +
        public Monoid<A> monoid(A zero)
        +
        Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.Definition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.AltDefinition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F<A,F<A,A>> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F2<A,A,A> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(Definition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        firstSemigroup

        +
        public static <A> Semigroup<A> firstSemigroup()
        +
        A semigroup which always uses the "first" (left-hand side) value.
        +
        • +
      + + + +
        +
      • +

        lastSemigroup

        +
        public static <A> Semigroup<A> lastSemigroup()
        +
        A semigroup which always uses the "last" (right-hand side) value.
        +
        • +
      + + + +
        +
      • +

        functionSemigroup

        +
        public static <A,B> Semigroup<F<A,B>> functionSemigroup(Semigroup<B> sb)
        +
        A semigroup for functions.
        +
        +
        Parameters:
        +
        sb - The smeigroup for the codomain.
        +
        Returns:
        +
        A semigroup for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listSemigroup

        +
        public static <A> Semigroup<List<A>> listSemigroup()
        +
        A semigroup for lists.
        +
        +
        Returns:
        +
        A semigroup for lists.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListSemigroup

        +
        public static <A> Semigroup<NonEmptyList<A>> nonEmptyListSemigroup()
        +
        A semigroup for non-empty lists.
        +
        +
        Returns:
        +
        A semigroup for non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionSemigroup

        +
        public static <A> Semigroup<Option<A>> optionSemigroup()
        +
        Deprecated. since 4.7. Use firstOptionSemigroup().
        +
        A semigroup for optional values.
        +
        +
        Returns:
        +
        A semigroup for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> firstOptionSemigroup()
        +
        A semigroup for optional values that take the first available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> lastOptionSemigroup()
        +
        A semigroup for optional values that take the last available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamSemigroup

        +
        public static <A> Semigroup<Stream<A>> streamSemigroup()
        +
        A semigroup for streams.
        +
        +
        Returns:
        +
        A semigroup for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arraySemigroup

        +
        public static <A> Semigroup<Array<A>> arraySemigroup()
        +
        A semigroup for arrays.
        +
        +
        Returns:
        +
        A semigroup for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        p1Semigroup

        +
        public static <A> Semigroup<P1<A>> p1Semigroup(Semigroup<A> sa)
        +
        A lazy semigroup for unary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's type.
        +
        Returns:
        +
        A semigroup for unary products.
        +
        +
        • +
      + + + +
        +
      • +

        p2Semigroup

        +
        public static <A,B> Semigroup<P2<A,B>> p2Semigroup(Semigroup<A> sa,
+                                                   Semigroup<B> sb)
        +
        A lazy semigroup for binary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's first type.
        +
        sb - A semigroup for the product's second type.
        +
        Returns:
        +
        A semigroup for binary products.
        +
        +
        • +
      + + + +
        +
      • +

        ioSemigroup

        +
        public static <A> Semigroup<IO<A>> ioSemigroup(Semigroup<A> sa)
        +
        A semigroup for IO values.
        +
        • +
      + + + +
        +
      • +

        setSemigroup

        +
        public static <A> Semigroup<Set<A>> setSemigroup()
        +
        A semigroup for sets.
        +
        +
        Returns:
        +
        a semigroup for sets.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Show.html b/javadoc/4.8/functionaljava/fj/Show.html new file mode 100644 index 0000000..4a51f96 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Show.html @@ -0,0 +1,1759 @@ + + + + + +Show (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Show<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Show<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Show<A>
+extends java.lang.Object
    +
    Renders an object for display.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanShow

        +
        public static final Show<java.lang.Boolean> booleanShow
        +
        A show instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteShow

        +
        public static final Show<java.lang.Byte> byteShow
        +
        A show instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charShow

        +
        public static final Show<java.lang.Character> charShow
        +
        A show instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleShow

        +
        public static final Show<java.lang.Double> doubleShow
        +
        A show instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatShow

        +
        public static final Show<java.lang.Float> floatShow
        +
        A show instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intShow

        +
        public static final Show<java.lang.Integer> intShow
        +
        A show instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintShow

        +
        public static final Show<java.math.BigInteger> bigintShow
        +
        A show instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalShow

        +
        public static final Show<java.math.BigDecimal> bigdecimalShow
        +
        A show instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longShow

        +
        public static final Show<java.lang.Long> longShow
        +
        A show instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortShow

        +
        public static final Show<java.lang.Short> shortShow
        +
        A show instance for the short type.
        +
        • +
      + + + +
        +
      • +

        stringShow

        +
        public static final Show<java.lang.String> stringShow
        +
        A show instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferShow

        +
        public static final Show<java.lang.StringBuffer> stringBufferShow
        +
        A show instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderShow

        +
        public static final Show<java.lang.StringBuilder> stringBuilderShow
        +
        A show instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        naturalShow

        +
        public static final Show<Natural> naturalShow
        +
        A show instance for natural numbers.
        +
        • +
      + + + +
        +
      • +

        lazyStringShow

        +
        public static final Show<LazyString> lazyStringShow
        +
        A show instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static final Show<HList.HNil> HListShow
        +
        A show instance for the empty heterogeneous Stream.
        +
        • +
      + + + +
        +
      • +

        bitSetShow

        +
        public static final Show<BitSet> bitSetShow
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        contramap

        +
        public <B> Show<B> contramap(F<B,A> f)
        +
        Maps the given function across this show as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new show.
        +
        +
        • +
      + + + + + +
        +
      • +

        show

        +
        public Stream<java.lang.Character> show(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showl

        +
        public List<java.lang.Character> showl(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showS

        +
        public java.lang.String showS(A a)
        +
        Returns the display rendering of the given argument as a String.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument as a String.
        +
        +
        • +
      + + + +
        +
      • +

        showS_

        +
        public F<A,java.lang.String> showS_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + +
        +
      • +

        show_

        +
        public F<A,Stream<java.lang.Character>> show_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + + + +
        +
      • +

        println

        +
        public Unit println(A a)
        +
        Prints the given argument to the standard output stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        print

        +
        public Unit print(A a)
        +
        Prints the given argument to the standard output stream.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        printlnE

        +
        public void printlnE(A a)
        +
        Prints the given argument to the standard error stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<A> show(F<A,Stream<java.lang.Character>> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        showS

        +
        public static <A> Show<A> showS(F<A,java.lang.String> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        anyShow

        +
        public static <A> Show<A> anyShow()
        +
        Returns a show instance that uses Object.toString() to perform the display rendering.
        +
        +
        Returns:
        +
        A show instance that uses Object.toString() to perform the display rendering.
        +
        +
        • +
      + + + +
        +
      • +

        optionShow

        +
        public static <A> Show<Option<A>> optionShow(Show<A> sa)
        +
        A show instance for the Option type.
        +
        +
        Parameters:
        +
        sa - Show for the element of the option.
        +
        Returns:
        +
        A show instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherShow

        +
        public static <A,B> Show<Either<A,B>> eitherShow(Show<A> sa,
+                                                 Show<B> sb)
        +
        A show instance for the Either type.
        +
        +
        Parameters:
        +
        sa - Show for the left side of the Either.
        +
        sb - Show for the right side of the Either.
        +
        Returns:
        +
        A show instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        resultShow

        +
        public static <I,A> Show<Result<I,A>> resultShow(Show<A> sa,
+                                                 Show<I> si)
        +
        A show instance for the Result type.
        +
        +
        Parameters:
        +
        sa - Show for the Result value.
        +
        si - Show for the Result remainder.
        +
        Returns:
        +
        A show instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationShow

        +
        public static <A,B> Show<Validation<A,B>> validationShow(Show<A> sa,
+                                                         Show<B> sb)
        +
        A show instance for the Validation type.
        +
        +
        Parameters:
        +
        sa - Show for the fail side of the Validation.
        +
        sb - Show for the success side of the Validation.
        +
        Returns:
        +
        A show instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listShow

        +
        public static <A> Show<List<A>> listShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the Stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListShow

        +
        public static <A> Show<NonEmptyList<A>> nonEmptyListShow(Show<A> sa)
        +
        A show instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the non-empty Stream.
        +
        Returns:
        +
        A show instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        treeShow

        +
        public static <A> Show<Tree<A>> treeShow(Show<A> sa)
        +
        A show instance for the Tree type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the tree.
        +
        Returns:
        +
        A show instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        digitShow

        +
        public static <V,A> Show<Digit<V,A>> digitShow(Show<V> sv,
+                                               Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        nodeShow

        +
        public static <V,A> Show<Node<V,A>> nodeShow(Show<V> sv,
+                                             Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        fingerTreeShow

        +
        public static <V,A> Show<FingerTree<V,A>> fingerTreeShow(Show<V> sv,
+                                                         Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        seqShow

        +
        public static <A> Show<Seq<A>> seqShow(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        setShow

        +
        public static <A> Show<Set<A>> setShow(Show<A> sa)
        +
        A show instance for the Set type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the set.
        +
        Returns:
        +
        A show instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapShow

        +
        public static <K,V> Show<TreeMap<K,V>> treeMapShow(Show<K> sk,
+                                                   Show<V> sv)
        +
        A show instance for the TreeMap type.
        +
        +
        Parameters:
        +
        sk - Show for the keys of the TreeMap.
        +
        sv - Show for the values of the TreeMap.
        +
        Returns:
        +
        A show instance for the TreeMap type.
        +
        +
        • +
      + + + +
        +
      • +

        p2MapShow

        +
        public static <A,B> Show<P2<A,B>> p2MapShow(Show<A> sa,
+                                            Show<B> sb)
        +
        A show instance for the tuple-2 type in the style of a mapping from A to B.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb,
+                                         java.lang.String start,
+                                         java.lang.String sep,
+                                         java.lang.String end)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the tuple.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa,
+                                             java.lang.String start,
+                                             java.lang.String sep,
+                                             java.lang.String end)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the stream.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow_

        +
        public static <A> F<Stream<A>,Stream<java.lang.Character>> streamShow_(Show<A> sa,
+                                                                       java.lang.String start,
+                                                                       java.lang.String sep,
+                                                                       java.lang.String end)
        +
        Returns the transformation equivalent for the stream show.
        +
        • +
      + + + +
        +
      • +

        arrayShow

        +
        public static <A> Show<Array<A>> arrayShow(Show<A> sa)
        +
        A show instance for the Array type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the array.
        +
        Returns:
        +
        A show instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        classShow

        +
        public static <A> Show<Class<A>> classShow()
        +
        A show instance for the Class type.
        +
        +
        Returns:
        +
        A show instance for the Class type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Show

        +
        public static <A> Show<P1<A>> p1Show(Show<A> sa)
        +
        A show instance for the tuple-1 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-1 type.
        +
        +
        • +
      + + + +
        +
      • +

        p1ShowLazy

        +
        public static <A> Show<P1<A>> p1ShowLazy(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p1ShowEager

        +
        public static <A> Show<P1<A>> p1ShowEager(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p3Show

        +
        public static <A,B,C> Show<P3<A,B,C>> p3Show(Show<A> sa,
+                                             Show<B> sb,
+                                             Show<C> sc)
        +
        A show instance for the tuple-3 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-3 type.
        +
        +
        • +
      + + + +
        +
      • +

        p4Show

        +
        public static <A,B,C,D> Show<P4<A,B,C,D>> p4Show(Show<A> sa,
+                                                 Show<B> sb,
+                                                 Show<C> sc,
+                                                 Show<D> sd)
        +
        A show instance for the tuple-4 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-4 type.
        +
        +
        • +
      + + + +
        +
      • +

        p5Show

        +
        public static <A,B,C,D,E> Show<P5<A,B,C,D,E>> p5Show(Show<A> sa,
+                                                     Show<B> sb,
+                                                     Show<C> sc,
+                                                     Show<D> sd,
+                                                     Show<E> se)
        +
        A show instance for the tuple-5 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-5 type.
        +
        +
        • +
      + + + +
        +
      • +

        p6Show

        +
        public static <A,B,C,D,E,F$> Show<P6<A,B,C,D,E,F$>> p6Show(Show<A> sa,
+                                                           Show<B> sb,
+                                                           Show<C> sc,
+                                                           Show<D> sd,
+                                                           Show<E> se,
+                                                           Show<F$> sf)
        +
        A show instance for the tuple-6 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-6 type.
        +
        +
        • +
      + + + +
        +
      • +

        p7Show

        +
        public static <A,B,C,D,E,F$,G> Show<P7<A,B,C,D,E,F$,G>> p7Show(Show<A> sa,
+                                                               Show<B> sb,
+                                                               Show<C> sc,
+                                                               Show<D> sd,
+                                                               Show<E> se,
+                                                               Show<F$> sf,
+                                                               Show<G> sg)
        +
        A show instance for the tuple-7 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-7 type.
        +
        +
        • +
      + + + +
        +
      • +

        p8Show

        +
        public static <A,B,C,D,E,F$,G,H> Show<P8<A,B,C,D,E,F$,G,H>> p8Show(Show<A> sa,
+                                                                   Show<B> sb,
+                                                                   Show<C> sc,
+                                                                   Show<D> sd,
+                                                                   Show<E> se,
+                                                                   Show<F$> sf,
+                                                                   Show<G> sg,
+                                                                   Show<H> sh)
        +
        A show instance for the tuple-8 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        sh - Show for the eighth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-8 type.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        v2Show

        +
        public static <A> Show<V2<A>> v2Show(Show<A> ea)
        +
        A show instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Show

        +
        public static <A> Show<V3<A>> v3Show(Show<A> ea)
        +
        A show instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Show

        +
        public static <A> Show<V4<A>> v4Show(Show<A> ea)
        +
        A show instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Show

        +
        public static <A> Show<V5<A>> v5Show(Show<A> ea)
        +
        A show instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Show

        +
        public static <A> Show<V6<A>> v6Show(Show<A> ea)
        +
        A show instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Show

        +
        public static <A> Show<V7<A>> v7Show(Show<A> ea)
        +
        A show instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Show

        +
        public static <A> Show<V8<A>> v8Show(Show<A> ea)
        +
        A show instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        unlineShow

        +
        public static <A> Show<Stream<A>> unlineShow(Show<A> sa)
        +
        A show instance for streams that splits into lines.
        +
        +
        Parameters:
        +
        sa - A show instance for the elements of a stream.
        +
        Returns:
        +
        A show instance for streams that splits into lines.
        +
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static <E,L extends HList<L>> Show<HList.HCons<E,L>> HListShow(Show<E> e,
+                                                                      Show<L> l)
        +
        A show instance for heterogeneous Streams.
        +
        +
        Parameters:
        +
        e - A show instance for the first element of the Stream.
        +
        l - A show instance for the rest of the Stream.
        +
        Returns:
        +
        a show instance for heterogeneous Streams.
        +
        +
        • +
      + + + +
        +
      • +

        hamtNodeShow

        +
        public static <K,V> Show<Node<K,V>> hamtNodeShow(Show<K> sk,
+                                                 Show<V> sv)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Try.html b/javadoc/4.8/functionaljava/fj/Try.html new file mode 100644 index 0000000..61e59fc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Try.html @@ -0,0 +1,434 @@ + + + + + +Try (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Try

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Try
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Try
+extends java.lang.Object
    +
    Created by mperry on 24/07/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,E extends java.lang.Exception>
      P1<Validation<E,A>>      		f(Try0<A,E> t) +
      Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,E extends java.lang.Exception>
      F<A,Validation<E,B>>      		f(Try1<A,B,E> t) +
      Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,E extends java.lang.Exception>
      F2<A,B,Validation<E,C>>      		f(Try2<A,B,C,E> t) +
      Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E extends java.lang.Exception>
      F3<A,B,C,Validation<E,D>>      		f(Try3<A,B,C,D,E> t) +
      Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,Z extends java.lang.Exception>
      F4<A,B,C,D,Validation<Z,E>>      		f(Try4<A,B,C,D,E,Z> t) +
      Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,Z extends java.lang.Exception>
      F5<A,B,C,D,E,Validation<Z,F>>      		f(Try5<A,B,C,D,E,F,Z> t) +
      Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,Z extends java.lang.Exception>
      F6<A,B,C,D,E,F,Validation<Z,G>>      		f(Try6<A,B,C,D,E,F,G,Z> t) +
      Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
      F7<A,B,C,D,E,F,G,Validation<Z,H>>      		f(Try7<A,B,C,D,E,F,G,H,Z> t) +
      Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
      F8<A,B,C,D,E,F,G,H,Validation<Z,I>>      		f(Try8<A,B,C,D,E,F,G,H,I,Z> t) +
      Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A> IO<A>io(Try0<A,? extends java.io.IOException> t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public static <A,E extends java.lang.Exception> P1<Validation<E,A>> f(Try0<A,E> t)
        +
        Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try0 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,E extends java.lang.Exception> F<A,Validation<E,B>> f(Try1<A,B,E> t)
        +
        Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try1 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,E extends java.lang.Exception> F2<A,B,Validation<E,C>> f(Try2<A,B,C,E> t)
        +
        Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try2 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E extends java.lang.Exception> F3<A,B,C,Validation<E,D>> f(Try3<A,B,C,D,E> t)
        +
        Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try3 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,Z extends java.lang.Exception> F4<A,B,C,D,Validation<Z,E>> f(Try4<A,B,C,D,E,Z> t)
        +
        Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try4 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,Z extends java.lang.Exception> F5<A,B,C,D,E,Validation<Z,F>> f(Try5<A,B,C,D,E,F,Z> t)
        +
        Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try5 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,Z extends java.lang.Exception> F6<A,B,C,D,E,F,Validation<Z,G>> f(Try6<A,B,C,D,E,F,G,Z> t)
        +
        Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try6 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception> F7<A,B,C,D,E,F,G,Validation<Z,H>> f(Try7<A,B,C,D,E,F,G,H,Z> t)
        +
        Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try7 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> F8<A,B,C,D,E,F,G,H,Validation<Z,I>> f(Try8<A,B,C,D,E,F,G,H,I,Z> t)
        +
        Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try8 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        io

        +
        public static <A> IO<A> io(Try0<A,? extends java.io.IOException> t)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/TryEffect.html b/javadoc/4.8/functionaljava/fj/TryEffect.html new file mode 100644 index 0000000..3a9e52b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/TryEffect.html @@ -0,0 +1,340 @@ + + + + + +TryEffect (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class TryEffect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.TryEffect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class TryEffect
+extends java.lang.Object
    +
    Created by mperry on 29/08/2014.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Unit.html b/javadoc/4.8/functionaljava/fj/Unit.html new file mode 100644 index 0000000..5d89ebb --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Unit.html @@ -0,0 +1,260 @@ + + + + + +Unit (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Unit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Unit
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Unit
+extends java.lang.Object
    +
    The unit type which has only one value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static Unitunit() +
      The only value of the unit type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static Unit unit()
        +
        The only value of the unit type.
        +
        +
        Returns:
        +
        The only value of the unit type.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/Void.html b/javadoc/4.8/functionaljava/fj/Void.html new file mode 100644 index 0000000..cc0fc63 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/Void.html @@ -0,0 +1,239 @@ + + + + + +Void (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Void

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Void
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Void
+extends java.lang.Object
    +
    A logically uninhabited data type.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract <X> Xabsurd() +
      Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        absurd

        +
        public abstract <X> X absurd()
        +
        Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/Trampoline.html b/javadoc/4.8/functionaljava/fj/control/Trampoline.html new file mode 100644 index 0000000..3f5356c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/Trampoline.html @@ -0,0 +1,582 @@ + + + + + +Trampoline (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control
+

Class Trampoline<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.Trampoline<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Trampoline<A>
+extends java.lang.Object
    +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack. + It represent suspendable coroutines with subroutine calls, reified as a data structure.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Trampoline

        +
        public Trampoline()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pure

        +
        public static <A> F<A,Trampoline<A>> pure()
        +
        +
        Returns:
        +
        The first-class version of `pure`.
        +
        +
        • +
      + + + + + +
        +
      • +

        pure

        +
        public static <A> Trampoline<A> pure(A a)
        +
        Constructs a pure computation that results in the given value.
        +
        +
        Parameters:
        +
        a - The value of the result.
        +
        Returns:
        +
        A trampoline that results in the given value.
        +
        +
        • +
      + + + +
        +
      • +

        suspend

        +
        public static <A> Trampoline<A> suspend(P1<Trampoline<A>> a)
        +
        Suspends the given computation in a thunk.
        +
        +
        Parameters:
        +
        a - A trampoline suspended in a thunk.
        +
        Returns:
        +
        A trampoline whose next step runs the given thunk.
        +
        +
        • +
      + + + +
        +
      • +

        suspend_

        +
        public static <A> F<P1<Trampoline<A>>,Trampoline<A>> suspend_()
        +
        +
        Returns:
        +
        The first-class version of `suspend`.
        +
        +
        • +
      + + + +
        +
      • +

        fold

        +
        protected abstract <R> R fold(F<fj.control.Trampoline.Normal<A>,R> n,
+                              F<fj.control.Trampoline.Codense<A>,R> gs)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public abstract <B> Trampoline<B> bind(F<A,Trampoline<B>> f)
        +
        Binds the given continuation to the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that constructs a trampoline from the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then continues with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Trampoline<B> map(F<A,B> f)
        +
        Maps the given function across the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that gets applied to the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then applies the given function to the result.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Trampoline<A>,Trampoline<B>>> map_()
        +
        +
        Returns:
        +
        The first-class version of `map`.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        resume

        +
        public abstract Either<P1<Trampoline<A>>,A> resume()
        +
        Runs a single step of this computation.
        +
        +
        Returns:
        +
        The next step of this compuation.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final A run()
        +
        Runs this computation all the way to the end, in constant stack.
        +
        +
        Returns:
        +
        The end result of this computation.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Trampoline<B> apply(Trampoline<F<A,B>> lf)
        +
        Performs function application within a Trampoline (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - A Trampoline resulting in the function to apply.
        +
        Returns:
        +
        A new Trampoline after applying the given function through this Trampoline.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Trampoline<C> bind(Trampoline<B> lb,
+                                      F<A,F<B,C>> f)
        +
        Binds the given function across the result of this Trampoline and the given Trampoline.
        +
        +
        Parameters:
        +
        lb - A given Trampoline to bind the given function with.
        +
        f - The function to combine the results of this Trampoline and the given Trampoline.
        +
        Returns:
        +
        A new Trampoline combining the results of the two trampolines with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Trampoline<A>,F<Trampoline<B>,Trampoline<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on Trampolines.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on Trampolines.
        +
        Returns:
        +
        The given function, promoted to operate on Trampolines.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Trampoline<C> zipWith(Trampoline<B> b,
+                                         F2<A,B,C> f)
        +
        Combines two trampolines so they run cooperatively. The results are combined with the given function.
        +
        +
        Parameters:
        +
        b - Another trampoline to combine with this trampoline.
        +
        f - A function to combine the results of the two trampolines.
        +
        Returns:
        +
        A new trampoline that runs this trampoline and the given trampoline simultaneously.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/db/Connector.html b/javadoc/4.8/functionaljava/fj/control/db/Connector.html new file mode 100644 index 0000000..7e1cf01 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/Connector.html @@ -0,0 +1,275 @@ + + + + + +Connector (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class Connector

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.Connector
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Connector
+extends java.lang.Object
    +
    A method of connecting to the database.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Connector() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract java.sql.Connectionconnect() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Connector

        +
        public Connector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        connect

        +
        public abstract java.sql.Connection connect()
+                                     throws java.sql.SQLException
        +
        +
        Throws:
        +
        java.sql.SQLException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/db/DB.html b/javadoc/4.8/functionaljava/fj/control/db/DB.html new file mode 100644 index 0000000..7a73a9a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/DB.html @@ -0,0 +1,459 @@ + + + + + +DB (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class DB<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DB<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class DB<A>
+extends java.lang.Object
    +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DB() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      F<java.sql.Connection,java.util.concurrent.Callable<A>>asFunction() +
      Returns the callable-valued function projection of this database action.
      +
      <B> DB<B>bind(F<A,DB<B>> f) +
      Binds the given action across the result of this database action.
      +
      static <A> DB<A>db(F<java.sql.Connection,A> f) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>db(Try1<java.sql.Connection,A,java.sql.SQLException> t) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>join(DB<DB<A>> a) +
      Removes one layer of monadic structure.
      +
      static <A,B> F<DB<A>,DB<B>>liftM(F<A,B> f) +
      Promotes any given function so that it transforms between values in the database.
      +
      <B> DB<B>map(F<A,B> f) +
      Map a function over the result of this action.
      +
      abstract Arun(java.sql.Connection c) +
      Executes the database action, given a database connection.
      +
      static <A> DB<A>unit(A a) +
      Constructs a database action that returns the given value completely intact.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DB

        +
        public DB()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public abstract A run(java.sql.Connection c)
+               throws java.sql.SQLException
        +
        Executes the database action, given a database connection.
        +
        +
        Parameters:
        +
        c - The connection against which to execute the action.
        +
        Returns:
        +
        The result of the action.
        +
        Throws:
        +
        java.sql.SQLException - if a database error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(F<java.sql.Connection,A> f)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        f - A function from a database connection to a value.
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(Try1<java.sql.Connection,A,java.sql.SQLException> t)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        t - A function from a database connection to a value allowed to throw + SQLException
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        asFunction

        +
        public final F<java.sql.Connection,java.util.concurrent.Callable<A>> asFunction()
        +
        Returns the callable-valued function projection of this database action.
        +
        +
        Returns:
        +
        The callable-valued function which is isomorphic to this database action.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> DB<B> map(F<A,B> f)
        +
        Map a function over the result of this action.
        +
        +
        Parameters:
        +
        f - The function to map over the result.
        +
        Returns:
        +
        A new database action that applies the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        liftM

        +
        public static <A,B> F<DB<A>,DB<B>> liftM(F<A,B> f)
        +
        Promotes any given function so that it transforms between values in the database.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function equivalent to the given one, which operates on values in the database.
        +
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> DB<A> unit(A a)
        +
        Constructs a database action that returns the given value completely intact.
        +
        +
        Parameters:
        +
        a - A value to be wrapped in a database action.
        +
        Returns:
        +
        A new database action that returns the given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> DB<B> bind(F<A,DB<B>> f)
        +
        Binds the given action across the result of this database action.
        +
        +
        Parameters:
        +
        f - The function to bind across the result of this database action.
        +
        Returns:
        +
        A new database action equivalent to applying the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> DB<A> join(DB<DB<A>> a)
        +
        Removes one layer of monadic structure.
        +
        +
        Parameters:
        +
        a - A database action that results in another.
        +
        Returns:
        +
        A new database action equivalent to the result of the given action.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/db/DbState.html b/javadoc/4.8/functionaljava/fj/control/db/DbState.html new file mode 100644 index 0000000..f8c0ffe --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/DbState.html @@ -0,0 +1,358 @@ + + + + + +DbState (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.db
+

Class DbState

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DbState
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DbState
+extends java.lang.Object
    +
    Performs database I/O, in order to read or write the database state.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ConnectordriverManager(java.lang.String url) +
      A simple connector (the default) that gets connections to the given database URL from the driver manager.
      +
      static DbStatereader(Connector pc) +
      Returns a new reader that reads the database via the given Connector.
      +
      static DbStatereader(java.lang.String url) +
      Creates a database state reader given a connection URL.
      +
      <A> Arun(DB<A> dba) +
      Runs the given database action as a single transaction.
      +
      static DbStatewriter(Connector pc) +
      Returns a new writer that writes the database via the given Connector.
      +
      static DbStatewriter(java.lang.String url) +
      Creates a database state writer given a connection URL.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        driverManager

        +
        public static Connector driverManager(java.lang.String url)
        +
        A simple connector (the default) that gets connections to the given database URL from the driver manager.
        +
        +
        Parameters:
        +
        url - The database URL to connect to.
        +
        Returns:
        +
        A connector that generates connections to the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(java.lang.String url)
        +
        Creates a database state reader given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state reader that reads the given database.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(java.lang.String url)
        +
        Creates a database state writer given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state writer that writes the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(Connector pc)
        +
        Returns a new reader that reads the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new reader that reads the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(Connector pc)
        +
        Returns a new writer that writes the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new writer that writes the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public <A> A run(DB<A> dba)
+          throws java.sql.SQLException
        +
        Runs the given database action as a single transaction.
        +
        +
        Parameters:
        +
        dba - A database action to run.
        +
        Returns:
        +
        The result of running the action against the database.
        +
        Throws:
        +
        java.sql.SQLException - in case of a database error.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/db/package-frame.html b/javadoc/4.8/functionaljava/fj/control/db/package-frame.html new file mode 100644 index 0000000..8196a3a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/package-frame.html @@ -0,0 +1,22 @@ + + + + + +fj.control.db (core 4.8 API) + + + + + +

fj.control.db

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/control/db/package-summary.html b/javadoc/4.8/functionaljava/fj/control/db/package-summary.html new file mode 100644 index 0000000..75ae9ea --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/package-summary.html @@ -0,0 +1,163 @@ + + + + + +fj.control.db (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.db

+
+
Abstractions for JDBC connections.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Connector +
    A method of connecting to the database.
    +
    DB<A> +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    DbState +
    Performs database I/O, in order to read or write the database state.
    +
    +
    • +
+ + + +

Package fj.control.db Description

+
Abstractions for JDBC connections.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/db/package-tree.html b/javadoc/4.8/functionaljava/fj/control/db/package-tree.html new file mode 100644 index 0000000..2033a78 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/db/package-tree.html @@ -0,0 +1,137 @@ + + + + + +fj.control.db Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.db

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/package-frame.html b/javadoc/4.8/functionaljava/fj/control/package-frame.html new file mode 100644 index 0000000..18d07f6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.control (core 4.8 API) + + + + + +

fj.control

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/control/package-summary.html b/javadoc/4.8/functionaljava/fj/control/package-summary.html new file mode 100644 index 0000000..a54f260 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/package-summary.html @@ -0,0 +1,151 @@ + + + + + +fj.control (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control

+
+
Functional control abstractions.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Trampoline<A> +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
    +
    +
    • +
+ + + +

Package fj.control Description

+
Functional control abstractions.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/package-tree.html b/javadoc/4.8/functionaljava/fj/control/package-tree.html new file mode 100644 index 0000000..7536487 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/package-tree.html @@ -0,0 +1,135 @@ + + + + + +fj.control Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/Actor.html b/javadoc/4.8/functionaljava/fj/control/parallel/Actor.html new file mode 100644 index 0000000..71164be --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/Actor.html @@ -0,0 +1,371 @@ + + + + + +Actor (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Actor<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Actor<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Actor<A>
+extends java.lang.Object
    +
    Light weight actors for Java. Concurrency is controlled by a parallel Strategy. + The Strategy serves as the Actor's execution engine, and as its mailbox. +

    + Given some effect, the Actor performs the effect on its messages using its Strategy, transforming them + into instances of fj.P1. The P1 represents a possibly running computation which is executing the effect. +

    + NOTE: A value of this type may generally process more than one message at a time, depending on its Strategy. + An actor is not thread-safe unless either its Effect imposes an order on incoming messages or its Strategy is + single-threaded. + + A queue actor which imposes an order on its messages is provided by the queueActor(fj.control.parallel.Strategy<fj.Unit>, fj.function.Effect1<T>) static method.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      P1<Unit>act(A a) +
      Pass a message to this actor, applying its side-effect to the message.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + Effect1<A> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + F<A,P1<Unit>> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      <B> Actor<B>contramap(F<B,A> f) +
      Contravariant functor pattern.
      +
      Actor<Promise<A>>promise() +
      Transforms this actor to an actor on promises.
      +
      static <T> Actor<T>queueActor(Strategy<Unit> s, + Effect1<T> ea) +
      An Actor equipped with a queue and which is guaranteed to process one message at a time.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        queueActor

        +
        public static <T> Actor<T> queueActor(Strategy<Unit> s,
+                                      Effect1<T> ea)
        +
        An Actor equipped with a queue and which is guaranteed to process one message at a time. + With respect to an enqueueing actor or thread, this actor will process messages in the same order + as they are sent.
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 Effect1<A> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 F<A,P1<Unit>> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The function projection of a side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + + + +
        +
      • +

        act

        +
        public P1<Unit> act(A a)
        +
        Pass a message to this actor, applying its side-effect to the message. The side-effect is applied in a concurrent + computation, resulting in a product referencing that computation.
        +
        +
        Parameters:
        +
        a - The message to send to this actor.
        +
        Returns:
        +
        A unit-product that represents the action running concurrently.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Actor<B> contramap(F<B,A> f)
        +
        Contravariant functor pattern. Creates a new actor whose message is transformed by the given function + before being passed to this actor.
        +
        +
        Parameters:
        +
        f - The function to use for the transformation
        +
        Returns:
        +
        A new actor which passes its messages through the given function, to this actor.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public Actor<Promise<A>> promise()
        +
        Transforms this actor to an actor on promises.
        +
        +
        Returns:
        +
        A new actor, equivalent to this actor, that acts on promises.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/Callables.html b/javadoc/4.8/functionaljava/fj/control/parallel/Callables.html new file mode 100644 index 0000000..37adcc4 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/Callables.html @@ -0,0 +1,731 @@ + + + + + +Callables (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Callables

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Callables
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Callables
+extends java.lang.Object
    +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.concurrent.Callable<B>apply(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<F<A,B>> cf) +
      Performs function application within a callable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>>arrow() +
      Provides a transformation from a function to a Callable-valued function that is equivalent to it.
      +
      static <A,B,C> java.util.concurrent.Callable<C>bind(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given callables with a final join.
      +
      static <A,B> java.util.concurrent.Callable<B>bind(java.util.concurrent.Callable<A> a, + F<A,java.util.concurrent.Callable<B>> f) +
      Binds the given function to the value in a Callable with a final join.
      +
      static <A> F<A,java.util.concurrent.Callable<A>>callable() +
      Provides a transformation from a value to a Callable that completely preserves that value.
      +
      static <A> java.util.concurrent.Callable<A>callable(A a) +
      Returns a callable that completely preserves the argument.
      +
      static <A> java.util.concurrent.Callable<A>callable(java.lang.Exception e) +
      Returns a callable that throws the given exception.
      +
      static <A,B> F<A,java.util.concurrent.Callable<B>>callable(F<A,B> f) +
      Wraps a given function's return value in a Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>>either() +
      Returns a transformation from a Callable to an Either.
      +
      static <A> P1<Either<java.lang.Exception,A>>either(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into either an exception or the value in the Callable.
      +
      static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>>fmap(F<A,B> f) +
      Lifts any function to a function on Callables.
      +
      static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>>fromEither() +
      Returns a transformation from an Either to a Callable.
      +
      static <A> java.util.concurrent.Callable<A>fromEither(F0<Either<java.lang.Exception,A>> e) +
      Turns a given Either value into the equivalent Callable.
      +
      static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>>fromOption() +
      Returns a transformation from an optional value to a Callable
      +
      static <A> java.util.concurrent.Callable<A>fromOption(F0<Option<A>> o) +
      Turns an optional value into a Callable.
      +
      static <A> java.util.concurrent.Callable<A>join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a) +
      Joins a Callable of a Callable with a bind operation.
      +
      static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on callables.
      +
      static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>>normalise() +
      A first-class version of the normalise function.
      +
      static <A> java.util.concurrent.Callable<A>normalise(java.util.concurrent.Callable<A> a) +
      Normalises the given Callable by calling it and wrapping the result in a new Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>>option() +
      Returns a transformation from a Callable to an optional value.
      +
      static <A> P1<Option<A>>option(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into an optional value.
      +
      static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>>sequence_() +
      A first-class version of the sequence method.
      +
      static <A> java.util.concurrent.Callable<List<A>>sequence(List<java.util.concurrent.Callable<A>> as) +
      Turns a List of Callables into a single Callable of a List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(A a)
        +
        Returns a callable that completely preserves the argument. The unit function for Callables.
        +
        +
        Parameters:
        +
        a - A value to preserve in a Callable
        +
        Returns:
        +
        A Callable that yields the argument when called.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(java.lang.Exception e)
        +
        Returns a callable that throws the given exception. The unit function for Callables.
        +
        +
        Parameters:
        +
        e - The exception to throw when the Callable is called.
        +
        Returns:
        +
        A callable that always throws the given exception.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> F<A,java.util.concurrent.Callable<A>> callable()
        +
        Provides a transformation from a value to a Callable that completely preserves that value.
        +
        +
        Returns:
        +
        A function from a value to a Callable that completely preserves that value.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A,B> F<A,java.util.concurrent.Callable<B>> callable(F<A,B> f)
        +
        Wraps a given function's return value in a Callable. + The Kleisli arrow for Callables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Callable.
        +
        Returns:
        +
        The equivalent function whose return value is wrapped in a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>> arrow()
        +
        Provides a transformation from a function to a Callable-valued function that is equivalent to it. + The first-class Kleisli arrow for Callables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Callable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.concurrent.Callable<B> bind(java.util.concurrent.Callable<A> a,
+                                                          F<A,java.util.concurrent.Callable<B>> f)
        +
        Binds the given function to the value in a Callable with a final join.
        +
        +
        Parameters:
        +
        a - A value in a Callable to which to apply a function.
        +
        f - A function to apply to the value in a Callable.
        +
        Returns:
        +
        The result of applying the function in the second argument to the value of the Callable in the first.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>> fmap(F<A,B> f)
        +
        Lifts any function to a function on Callables.
        +
        +
        Parameters:
        +
        f - A function to lift to a function on Callables.
        +
        Returns:
        +
        That function lifted to a function on Callables.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> java.util.concurrent.Callable<B> apply(java.util.concurrent.Callable<A> ca,
+                                                           java.util.concurrent.Callable<F<A,B>> cf)
        +
        Performs function application within a callable (applicative functor pattern).
        +
        +
        Parameters:
        +
        ca - The callable to which to apply a function.
        +
        cf - The callable function to apply.
        +
        Returns:
        +
        A new callable after applying the given callable function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> java.util.concurrent.Callable<C> bind(java.util.concurrent.Callable<A> ca,
+                                                            java.util.concurrent.Callable<B> cb,
+                                                            F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given callables with a final join.
        +
        +
        Parameters:
        +
        ca - A given callable to bind the given function with.
        +
        cb - A given callable to bind the given function with.
        +
        f - The function to apply to the values in the given callables.
        +
        Returns:
        +
        A new callable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> java.util.concurrent.Callable<A> join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a)
        +
        Joins a Callable of a Callable with a bind operation.
        +
        +
        Parameters:
        +
        a - The Callable of a Callable to join.
        +
        Returns:
        +
        A new Callable that is the join of the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on callables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over callables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> java.util.concurrent.Callable<List<A>> sequence(List<java.util.concurrent.Callable<A>> as)
        +
        Turns a List of Callables into a single Callable of a List.
        +
        +
        Parameters:
        +
        as - The list of callables to transform.
        +
        Returns:
        +
        A single callable for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>> sequence_()
        +
        A first-class version of the sequence method.
        +
        +
        Returns:
        +
        A function from a List of Callables to a single Callable of a List.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> P1<Option<A>> option(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into an optional value.
        +
        +
        Parameters:
        +
        a - The callable to convert to an optional value.
        +
        Returns:
        +
        An optional value that yields the value in the Callable, or None if the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>> option()
        +
        Returns a transformation from a Callable to an optional value.
        +
        +
        Returns:
        +
        a function that turns a Callable into an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> P1<Either<java.lang.Exception,A>> either(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into either an exception or the value in the Callable.
        +
        +
        Parameters:
        +
        a - The callable to convert to an Either value.
        +
        Returns:
        +
        Either the value in the given Callable, or the Exception with which the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>> either()
        +
        Returns a transformation from a Callable to an Either.
        +
        +
        Returns:
        +
        a function that turns a Callable into an Either.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> java.util.concurrent.Callable<A> fromEither(F0<Either<java.lang.Exception,A>> e)
        +
        Turns a given Either value into the equivalent Callable.
        +
        +
        Parameters:
        +
        e - Either an exception or a value to wrap in a Callable
        +
        Returns:
        +
        A Callable equivalent to the given Either value.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>> fromEither()
        +
        Returns a transformation from an Either to a Callable.
        +
        +
        Returns:
        +
        a function that turns an Either into a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> java.util.concurrent.Callable<A> fromOption(F0<Option<A>> o)
        +
        Turns an optional value into a Callable.
        +
        +
        Parameters:
        +
        o - An optional value to turn into a Callable.
        +
        Returns:
        +
        A Callable that yields some value or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>> fromOption()
        +
        Returns a transformation from an optional value to a Callable
        +
        +
        Returns:
        +
        A function that turns an optional value into a Callable that yields some value + or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> java.util.concurrent.Callable<A> normalise(java.util.concurrent.Callable<A> a)
        +
        Normalises the given Callable by calling it and wrapping the result in a new Callable. + If the given Callable throws an Exception, the resulting Callable will throw that same Exception.
        +
        +
        Parameters:
        +
        a - The callable to evaluate.
        +
        Returns:
        +
        A normalised callable that just returns the result of calling the given callable.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>> normalise()
        +
        A first-class version of the normalise function.
        +
        +
        Returns:
        +
        A function that normalises the given Callable by calling it and wrapping the result in a new Callable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/ParModule.html b/javadoc/4.8/functionaljava/fj/control/parallel/ParModule.html new file mode 100644 index 0000000..8a08d37 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/ParModule.html @@ -0,0 +1,1412 @@ + + + + + +ParModule (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class ParModule

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.ParModule
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class ParModule
+extends java.lang.Object
    +
    A module of higher-order concurrency features.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> F<Effect1<A>,Actor<A>>actor() +
      A first-class constructor of actors.
      +
      <A> Actor<A>actor(Effect1<A> e) +
      Creates a concurrent actor that is guaranteed to process only one message at a time.
      +
      <A> F<Effect1<A>,Actor<A>>effect() +
      A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
      +
      <A> Actor<A>effect(Effect1<A> e) +
      Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
      +
      <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>>mapList() +
      First-class function that maps a concurrent function over a List inside a promise.
      +
      <A,B> Promise<List<B>>mapM(List<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
      +
      <A,B> Promise<P1<B>>mapM(P1<A> a, + F<A,Promise<B>> f) +
      Maps a concurrent function over a Product-1 inside a Promise.
      +
      <A,B> Promise<Stream<B>>mapM(Stream<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
      +
      <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>>mapStream() +
      First-class function that maps a concurrent function over a Stream inside a promise.
      +
      <A,B> Promise<NonEmptyList<B>>parExtend(NonEmptyList<A> as, + F<NonEmptyList<A>,B> f) +
      Maps the given function across all sublists of the given NonEmptyList in parallel.
      +
      <A,B> Promise<Tree<B>>parExtend(Tree<A> ta, + F<Tree<A>,B> f) +
      Maps the given function across all subtrees of the given Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parExtend(TreeZipper<A> za, + F<TreeZipper<A>,B> f) +
      Maps the given function across all positions of the given TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parExtend(Zipper<A> za, + F<Zipper<A>,B> f) +
      Maps the given function across all positions of the given zipper in parallel.
      +
      <A,B> Promise<Array<B>>parFlatMap(Array<A> as, + F<A,Array<B>> f) +
      Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
      +
      <A,B> Promise<java.lang.Iterable<B>>parFlatMap(java.lang.Iterable<A> as, + F<A,java.lang.Iterable<B>> f) +
      Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
      +
      <A,B> Promise<List<B>>parFlatMap(List<A> as, + F<A,List<B>> f) +
      Binds a list-valued function across a list in parallel, concatenating the results into a new list.
      +
      <A,B> Promise<Stream<B>>parFlatMap(Stream<A> as, + F<A,Stream<B>> f) +
      Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce, + F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking) +
      Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce, + F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking) +
      Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<Array<B>>parMap(Array<A> as, + F<A,B> f) +
      Maps across an Array in parallel.
      +
      <A,B> Promise<java.lang.Iterable<B>>parMap(java.lang.Iterable<A> as, + F<A,B> f) +
      Maps across an Iterable in parallel.
      +
      <A,B> Promise<List<B>>parMap(List<A> as, + F<A,B> f) +
      Maps across a list in parallel.
      +
      <A,B> Promise<NonEmptyList<B>>parMap(NonEmptyList<A> as, + F<A,B> f) +
      Maps across a nonempty list in parallel.
      +
      <A,B> Promise<Stream<B>>parMap(Stream<A> as, + F<A,B> f) +
      Maps across a Stream in parallel.
      +
      <A,B> Promise<Tree<B>>parMap(Tree<A> ta, + F<A,B> f) +
      Maps a function across a Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parMap(TreeZipper<A> za, + F<A,B> f) +
      Maps a function across a TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parMap(Zipper<A> za, + F<A,B> f) +
      Maps a function across a Zipper in parallel.
      +
      <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>>parMapArray() +
      A first-class function that maps another function across an array in parallel.
      +
      <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>>parMapIterable() +
      A first-class function that maps another function across an iterable in parallel.
      +
      <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>>parMapList() +
      A first-class function that maps another function across a list in parallel.
      +
      <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>>parMapStream() +
      A first-class function that maps another function across a stream in parallel.
      +
      <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>>parMapTree() +
      A first-class function that maps across a Tree in parallel.
      +
      static ParModuleparModule(Strategy<Unit> u) +
      Constructor method for ParModule
      +
      <A,B,C> Promise<Array<C>>parZipWith(Array<A> as, + Array<B> bs, + F<A,F<B,C>> f) +
      Zips two arrays together with a given function, in parallel.
      +
      <A,B,C> Promise<java.lang.Iterable<C>>parZipWith(java.lang.Iterable<A> as, + java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips two iterables together with a given function, in parallel.
      +
      <A,B,C> Promise<List<C>>parZipWith(List<A> as, + List<B> bs, + F<A,F<B,C>> f) +
      Zips two lists together with a given function, in parallel.
      +
      <A,B,C> Promise<Stream<C>>parZipWith(Stream<A> as, + Stream<B> bs, + F<A,F<B,C>> f) +
      Zips two streams together with a given function, in parallel.
      +
      <A> F<P1<A>,Promise<A>>promise() +
      Returns a function that evaluates a given product concurrently and returns a Promise of the result.
      +
      <A,B> F<A,Promise<B>>promise(F<A,B> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A,B,C> F2<A,B,Promise<C>>promise(F2<A,B,C> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A> Promise<A>promise(P1<A> p) +
      Evaluates the given product concurrently and returns a Promise of the result.
      +
      <A,B> F<F<A,B>,F<A,Promise<B>>>promisePure() +
      Returns a function that promotes a given function to a concurrent function that returns a Promise.
      +
      <A> Promise<List<A>>sequence(List<Promise<A>> ps) +
      List iteration inside a Promise.
      +
      <A> Promise<P1<A>>sequence(P1<Promise<A>> p) +
      Traverses a product-1 inside a promise.
      +
      <A> Promise<Stream<A>>sequence(Stream<Promise<A>> ps) +
      Stream iteration inside a Promise.
      +
      <A> F<List<Promise<A>>,Promise<List<A>>>sequenceList() +
      A first-class function that traverses a list inside a promise.
      +
      <A> F<Stream<Promise<A>>,Promise<Stream<A>>>sequenceStream() +
      A first-class function that traverses a stream inside a promise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        parModule

        +
        public static ParModule parModule(Strategy<Unit> u)
        +
        Constructor method for ParModule
        +
        +
        Parameters:
        +
        u - A parallel strategy for the module.
        +
        Returns:
        +
        A ParModule that uses the given strategy for parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> Promise<A> promise(P1<A> p)
        +
        Evaluates the given product concurrently and returns a Promise of the result.
        +
        +
        Parameters:
        +
        p - A product to evaluate concurrently.
        +
        Returns:
        +
        A Promise of the value of the given product, that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> F<P1<A>,Promise<A>> promise()
        +
        Returns a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        Returns:
        +
        a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B> F<A,Promise<B>> promise(F<A,B> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promisePure

        +
        public <A,B> F<F<A,B>,F<A,Promise<B>>> promisePure()
        +
        Returns a function that promotes a given function to a concurrent function that returns a Promise. + The pure Kleisli arrow of Promise.
        +
        +
        Returns:
        +
        A higher-order function that takes pure functions to promise-valued functions.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B,C> F2<A,B,Promise<C>> promise(F2<A,B,C> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> Actor<A> effect(Effect1<A> e)
        +
        Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that does not guarantee ordering of its messages.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> F<Effect1<A>,Actor<A>> effect()
        +
        A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Returns:
        +
        A function that takes an effect and returns a concurrent effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> Actor<A> actor(Effect1<A> e)
        +
        Creates a concurrent actor that is guaranteed to process only one message at a time.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that is guaranteed to process its messages in order.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> F<Effect1<A>,Actor<A>> actor()
        +
        A first-class constructor of actors.
        +
        +
        Returns:
        +
        A function that takes an effect and returns an actor that processes messages in some order.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<List<A>> sequence(List<Promise<A>> ps)
        +
        List iteration inside a Promise. Traverses a List of Promises yielding a Promise of a List.
        +
        +
        Parameters:
        +
        ps - A list of promises to sequence.
        +
        Returns:
        +
        A promise of the List of values promised by the list of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public <A> F<List<Promise<A>>,Promise<List<A>>> sequenceList()
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<Stream<A>> sequence(Stream<Promise<A>> ps)
        +
        Stream iteration inside a Promise. Traverses a Stream of Promises yielding a Promise of a Stream.
        +
        +
        Parameters:
        +
        ps - A Stream of promises to sequence.
        +
        Returns:
        +
        A promise of the Stream of values promised by the Stream of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public <A> F<Stream<Promise<A>>,Promise<Stream<A>>> sequenceStream()
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<P1<A>> sequence(P1<Promise<A>> p)
        +
        Traverses a product-1 inside a promise.
        +
        +
        Parameters:
        +
        p - A product-1 of a promised value.
        +
        Returns:
        +
        A promise of a product of the value promised by the argument.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<List<B>> mapM(List<A> as,
+                                   F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
        +
        +
        Parameters:
        +
        as - A list to map across.
        +
        f - A promise-valued function to map across the list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>> mapList()
        +
        First-class function that maps a concurrent function over a List inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a List inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<Stream<B>> mapM(Stream<A> as,
+                                     F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
        +
        +
        Parameters:
        +
        as - A Stream to map across.
        +
        f - A promise-valued function to map across the Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>> mapStream()
        +
        First-class function that maps a concurrent function over a Stream inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a Stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<P1<B>> mapM(P1<A> a,
+                                 F<A,Promise<B>> f)
        +
        Maps a concurrent function over a Product-1 inside a Promise.
        +
        +
        Parameters:
        +
        a - A product-1 across which to map.
        +
        f - A concurrent function to map over the product inside a promise.
        +
        Returns:
        +
        A promised product of the result of mapping the given function over the given product.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<List<B>> parMap(List<A> as,
+                                     F<A,B> f)
        +
        Maps across a list in parallel.
        +
        +
        Parameters:
        +
        as - A list to map across in parallel.
        +
        f - A function to map across the given list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>> parMapList()
        +
        A first-class function that maps another function across a list in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a list in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<NonEmptyList<B>> parMap(NonEmptyList<A> as,
+                                             F<A,B> f)
        +
        Maps across a nonempty list in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to map across in parallel.
        +
        f - A function to map across the given NonEmptyList.
        +
        Returns:
        +
        A Promise of a new NonEmptyList with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Stream<B>> parMap(Stream<A> as,
+                                       F<A,B> f)
        +
        Maps across a Stream in parallel.
        +
        +
        Parameters:
        +
        as - A Stream to map across in parallel.
        +
        f - A function to map across the given Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapStream

        +
        public <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>> parMapStream()
        +
        A first-class function that maps another function across a stream in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a stream in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parMap(java.lang.Iterable<A> as,
+                                                   F<A,B> f)
        +
        Maps across an Iterable in parallel.
        +
        +
        Parameters:
        +
        as - An Iterable to map across in parallel.
        +
        f - A function to map across the given Iterable.
        +
        Returns:
        +
        A Promise of a new Iterable with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapIterable

        +
        public <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>> parMapIterable()
        +
        A first-class function that maps another function across an iterable in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an iterable in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Array<B>> parMap(Array<A> as,
+                                      F<A,B> f)
        +
        Maps across an Array in parallel.
        +
        +
        Parameters:
        +
        as - An array to map across in parallel.
        +
        f - A function to map across the given Array.
        +
        Returns:
        +
        A Promise of a new Array with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>> parMapArray()
        +
        A first-class function that maps another function across an array in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an array in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Zipper<B>> parMap(Zipper<A> za,
+                                       F<A,B> f)
        +
        Maps a function across a Zipper in parallel.
        +
        +
        Parameters:
        +
        za - A Zipper to map across in parallel.
        +
        f - A function to map across the given Zipper.
        +
        Returns:
        +
        A promise of a new Zipper with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Tree<B>> parMap(Tree<A> ta,
+                                     F<A,B> f)
        +
        Maps a function across a Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A Tree to map across in parallel.
        +
        f - A function to map across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapTree

        +
        public <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>> parMapTree()
        +
        A first-class function that maps across a Tree in parallel.
        +
        +
        Returns:
        +
        A function that maps a given function across a Tree in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<TreeZipper<B>> parMap(TreeZipper<A> za,
+                                           F<A,B> f)
        +
        Maps a function across a TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to map across in parallel.
        +
        f - A function to map across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper with the given function applied to each element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<List<B>> parFlatMap(List<A> as,
+                                         F<A,List<B>> f)
        +
        Binds a list-valued function across a list in parallel, concatenating the results into a new list.
        +
        +
        Parameters:
        +
        as - A list to bind across in parallel.
        +
        f - A function to bind across the given list in parallel.
        +
        Returns:
        +
        A promise of a new List with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Stream<B>> parFlatMap(Stream<A> as,
+                                           F<A,Stream<B>> f)
        +
        Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
        +
        +
        Parameters:
        +
        as - A Stream to bind across in parallel.
        +
        f - A function to bind across the given Stream in parallel.
        +
        Returns:
        +
        A promise of a new Stream with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Array<B>> parFlatMap(Array<A> as,
+                                          F<A,Array<B>> f)
        +
        Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
        +
        +
        Parameters:
        +
        as - An Array to bind across in parallel.
        +
        f - A function to bind across the given Array in parallel.
        +
        Returns:
        +
        A promise of a new Array with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parFlatMap(java.lang.Iterable<A> as,
+                                                       F<A,java.lang.Iterable<B>> f)
        +
        Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
        +
        +
        Parameters:
        +
        as - A Iterable to bind across in parallel.
        +
        f - A function to bind across the given Iterable in parallel.
        +
        Returns:
        +
        A promise of a new Iterable with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<List<C>> parZipWith(List<A> as,
+                                           List<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips two lists together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A list to zip with another in parallel.
        +
        bs - A list to zip with another in parallel.
        +
        f - A function with which to zip two lists in parallel.
        +
        Returns:
        +
        A Promise of a new list with the results of applying the given function across the two lists in lockstep.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Stream<C>> parZipWith(Stream<A> as,
+                                             Stream<B> bs,
+                                             F<A,F<B,C>> f)
        +
        Zips two streams together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A stream to zip with another in parallel.
        +
        bs - A stream to zip with another in parallel.
        +
        f - A function with which to zip two streams in parallel.
        +
        Returns:
        +
        A Promise of a new stream with the results of applying the given function across the two streams, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Array<C>> parZipWith(Array<A> as,
+                                            Array<B> bs,
+                                            F<A,F<B,C>> f)
        +
        Zips two arrays together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An array to zip with another in parallel.
        +
        bs - An array to zip with another in parallel.
        +
        f - A function with which to zip two arrays in parallel.
        +
        Returns:
        +
        A Promise of a new array with the results of applying the given function across the two arrays, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<java.lang.Iterable<C>> parZipWith(java.lang.Iterable<A> as,
+                                                         java.lang.Iterable<B> bs,
+                                                         F<A,F<B,C>> f)
        +
        Zips two iterables together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An iterable to zip with another in parallel.
        +
        bs - An iterable to zip with another in parallel.
        +
        f - A function with which to zip two iterables in parallel.
        +
        Returns:
        +
        A Promise of a new iterable with the results of applying the given function across the two iterables, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given stream in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - A stream to map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking)
        +
        Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid. The stream is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - A stream to chunk, then map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the stream should be split into chunks. Should return the first chunk + and the rest of the stream.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking)
        +
        Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid. The Iterable is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - An Iterable to chunk, then map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the Iterable should be split into chunks. Should return the first chunk + and the rest of the Iterable.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - An Iterable to map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The Monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Zipper<B>> parExtend(Zipper<A> za,
+                                          F<Zipper<A>,B> f)
        +
        Maps the given function across all positions of the given zipper in parallel.
        +
        +
        Parameters:
        +
        za - A zipper to extend the given function across.
        +
        f - A function to extend across the given zipper.
        +
        Returns:
        +
        A promise of a new zipper of the results of applying the given function to all positions of the given + zipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Tree<B>> parExtend(Tree<A> ta,
+                                        F<Tree<A>,B> f)
        +
        Maps the given function across all subtrees of the given Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A tree to extend the given function across.
        +
        f - A function to extend across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree of the results of applying the given function to all subtrees of the given Tree.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<TreeZipper<B>> parExtend(TreeZipper<A> za,
+                                              F<TreeZipper<A>,B> f)
        +
        Maps the given function across all positions of the given TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to extend the given function across.
        +
        f - A function to extend across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper of the results of applying the given function to all positions of the + given TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<NonEmptyList<B>> parExtend(NonEmptyList<A> as,
+                                                F<NonEmptyList<A>,B> f)
        +
        Maps the given function across all sublists of the given NonEmptyList in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to extend the given function across.
        +
        f - A function to extend across the given NonEmptyList
        +
        Returns:
        +
        A promise of a new NonEmptyList of the results of applying the given function to all sublists of the + given NonEmptyList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/Promise.html b/javadoc/4.8/functionaljava/fj/control/parallel/Promise.html new file mode 100644 index 0000000..14f6efc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/Promise.html @@ -0,0 +1,864 @@ + + + + + +Promise (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Promise<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Promise<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Promise<A>
+extends java.lang.Object
    +
    Represents a non-blocking future value. Products, functions, and actors, given to the methods on this class, + are executed concurrently, and the Promise serves as a handle on the result of the computation. Provides monadic + operations so that future computations can be combined +

    + Author: Runar

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Promise<B>apply(Promise<F<A,B>> pf) +
      Performs function application within a promise (applicative functor pattern).
      +
      <B> Promise<B>bind(F<A,Promise<B>> f) +
      Binds the given function over this promise, with a final join.
      +
      <B,C> Promise<C>bind(P1<Promise<B>> p, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      <B,C> Promise<C>bind(Promise<B> pb, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      Aclaim() +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      Option<A>claim(long timeout, + java.util.concurrent.TimeUnit unit) +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      <B> Promise<B>cobind(F<Promise<A>,B> f) +
      Binds the given function across a promise of this promise (Comonad pattern).
      +
      Promise<Promise<A>>cojoin() +
      Duplicates this promise to a promise of itself (Comonad pattern).
      +
      static <A,B> F<Promise<A>,Promise<B>>fmap_(F<A,B> f) +
      Promotes any function to a transformation between promises (covariant functor pattern).
      +
      <B> Promise<B>fmap(F<A,B> f) +
      Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
      +
      static <A,B> F<List<A>,Promise<B>>foldRight(Strategy<Unit> s, + F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across a list in constant stack space.
      +
      static <A,B> F<Stream<A>,Promise<B>>foldRightS(Strategy<Unit> s, + F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across a Stream in constant stack space.
      +
      booleanisFulfilled() +
      Returns true if this promise has been fulfilled.
      +
      static <A> Promise<A>join(Promise<Promise<A>> p) +
      Turns a promise of a promise into just a promise.
      +
      static <A> Promise<A>join(Strategy<Unit> s, + P1<Promise<A>> p) +
      Turns a product of a promise into just a promise.
      +
      static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on promises.
      +
      static <A> F<P1<A>,Promise<A>>promise(Strategy<Unit> s) +
      Provides a first-class unit function for promises.
      +
      static <A> Promise<java.util.concurrent.Callable<A>>promise(Strategy<Unit> s, + java.util.concurrent.Callable<A> a) +
      Provides a promise to call the given Callable in the future.
      +
      static <A,B> F<A,Promise<B>>promise(Strategy<Unit> s, + F<A,B> f) +
      Transforms any function so that it returns a promise of a value instead of an actual value.
      +
      static <A> Promise<A>promise(Strategy<Unit> s, + P1<A> a) +
      Promises to provide the value of the given 1-product, in the future.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequence(Strategy<Unit> s) +
      First-class version of the sequence function through a List.
      +
      static <A> Promise<List<A>>sequence(Strategy<Unit> s, + List<Promise<A>> as) +
      Turns a List of promises into a single promise of a List.
      +
      static <A> Promise<P1<A>>sequence(Strategy<Unit> s, + P1<Promise<A>> p) +
      Transforms a product of a promise to a promise of a product.
      +
      static <A> Promise<Stream<A>>sequence(Strategy<Unit> s, + Stream<Promise<A>> as) +
      Turns a Stream of promises into a single promise of a Stream.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequenceS(Strategy<Unit> s) +
      First-class version of the sequence function through a Stream.
      +
      <B> Stream<B>sequenceW(Stream<F<Promise<A>,B>> fs) +
      Applies a stream of comonadic functions to this promise, returning a stream of values.
      +
      voidto(Actor<A> a) +
      Promises to send a value to the given actor in the future.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<A> promise(Strategy<Unit> s,
+                                     P1<A> a)
        +
        Promises to provide the value of the given 1-product, in the future. + Represents the unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The 1-product to evaluate concurrently.
        +
        Returns:
        +
        A promise representing the future result of evaluating the given 1-product.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> F<P1<A>,Promise<A>> promise(Strategy<Unit> s)
        +
        Provides a first-class unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil promises.
        +
        Returns:
        +
        A function that, given a 1-product, yields a promise of that product's value.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<java.util.concurrent.Callable<A>> promise(Strategy<Unit> s,
+                                                                    java.util.concurrent.Callable<A> a)
        +
        Provides a promise to call the given Callable in the future.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The Callable to evaluate concurrently.
        +
        Returns:
        +
        A promise of a new Callable that will return the result of calling the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A,B> F<A,Promise<B>> promise(Strategy<Unit> s,
+                                            F<A,B> f)
        +
        Transforms any function so that it returns a promise of a value instead of an actual value. + Represents the Kleisli arrow for the Promise monad.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        f - The function to turn into a promise-valued function.
        +
        Returns:
        +
        The given function transformed into a function that returns a promise.
        +
        +
        • +
      + + + +
        +
      • +

        to

        +
        public void to(Actor<A> a)
        +
        Promises to send a value to the given actor in the future.
        +
        +
        Parameters:
        +
        a - An actor that will receive this Promise's value in the future.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Promise<B> fmap(F<A,B> f)
        +
        Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to apply to this promise's future value.
        +
        Returns:
        +
        A promise representing the future result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<Promise<A>,Promise<B>> fmap_(F<A,B> f)
        +
        Promotes any function to a transformation between promises (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to promote to a transformation between promises.
        +
        Returns:
        +
        That function lifted to a function on Promises.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Promise<Promise<A>> p)
        +
        Turns a promise of a promise into just a promise. The join function for the Promise monad. + Promise to give it a Promise of an A, and it will promise you an A in return.
        +
        +
        Parameters:
        +
        p - A promise of a promise.
        +
        Returns:
        +
        The promised promise.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Strategy<Unit> s,
+                                  P1<Promise<A>> p)
        +
        Turns a product of a promise into just a promise. Does not block on the product by calling it, + but creates a new promise with a final join.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        p - A product-1 of a promise to turn into just a promise.
        +
        Returns:
        +
        The joined promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Promise<B> bind(F<A,Promise<B>> f)
        +
        Binds the given function over this promise, with a final join. + The bind function for the Promise monad.
        +
        +
        Parameters:
        +
        f - The function to bind over this promise.
        +
        Returns:
        +
        The result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Promise<B> apply(Promise<F<A,B>> pf)
        +
        Performs function application within a promise (applicative functor pattern).
        +
        +
        Parameters:
        +
        pf - The promised function to apply.
        +
        Returns:
        +
        A new promise after applying the given promised function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(Promise<B> pb,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        pb - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(P1<Promise<B>> p,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        p - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on promises.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<List<A>> sequence(Strategy<Unit> s,
+                                            List<Promise<A>> as)
        +
        Turns a List of promises into a single promise of a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The list of promises to transform.
        +
        Returns:
        +
        A single promise for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequence(Strategy<Unit> s)
        +
        First-class version of the sequence function through a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given list of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a list.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<Stream<A>> sequence(Strategy<Unit> s,
+                                              Stream<Promise<A>> as)
        +
        Turns a Stream of promises into a single promise of a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The Stream of promises to transform.
        +
        Returns:
        +
        A single promise for the given Stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceS

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequenceS(Strategy<Unit> s)
        +
        First-class version of the sequence function through a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given Stream of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a Stream..
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<P1<A>> sequence(Strategy<Unit> s,
+                                          P1<Promise<A>> p)
        +
        Transforms a product of a promise to a promise of a product.
        +
        +
        Parameters:
        +
        s - The strategy with which to traverse the promise.
        +
        p - A product of a promise to traverse.
        +
        Returns:
        +
        A promised product.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<List<A>,Promise<B>> foldRight(Strategy<Unit> s,
+                                                    F<A,F<B,B>> f,
+                                                    B b)
        +
        Performs a right-fold reduction across a list in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the list.
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightS

        +
        public static <A,B> F<Stream<A>,Promise<B>> foldRightS(Strategy<Unit> s,
+                                                       F<A,F<P1<B>,B>> f,
+                                                       B b)
        +
        Performs a right-fold reduction across a Stream in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the Stream.
        +
        f - The function to apply on each element of the Stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public A claim()
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Returns:
        +
        The promised value.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public Option<A> claim(long timeout,
+                       java.util.concurrent.TimeUnit unit)
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Parameters:
        +
        timeout - the maximum time to wait
        +
        unit - the time unit of the timeout argument
        +
        Returns:
        +
        The promised value, or none if the timeout was reached.
        +
        +
        • +
      + + + +
        +
      • +

        isFulfilled

        +
        public boolean isFulfilled()
        +
        Returns true if this promise has been fulfilled.
        +
        +
        Returns:
        +
        true if this promise has been fulfilled.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Promise<B> cobind(F<Promise<A>,B> f)
        +
        Binds the given function across a promise of this promise (Comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to apply within a new promise of this promise.
        +
        Returns:
        +
        A new promise of the result of applying the given function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Promise<Promise<A>> cojoin()
        +
        Duplicates this promise to a promise of itself (Comonad pattern).
        +
        +
        Returns:
        +
        a promise of this promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public <B> Stream<B> sequenceW(Stream<F<Promise<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this promise, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this promise.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this promise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/Strategy.html b/javadoc/4.8/functionaljava/fj/control/parallel/Strategy.html new file mode 100644 index 0000000..132ec16 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/Strategy.html @@ -0,0 +1,1118 @@ + + + + + +Strategy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Strategy<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Strategy<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strategy<A>
+extends java.lang.Object
    +
    Functional-style parallel evaluation strategies. + A Strategy is a method of evaluating a product-1, yielding another product-1 from which the result of its evaluation + can be retrieved at a later time. +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Strategy<java.util.concurrent.Callable<A>>callableStrategy(Strategy<java.util.concurrent.Callable<A>> s) +
      Provides a normalising strategy that fully evaluates its Callable argument.
      +
      static <A> Strategy<A>completionStrategy(java.util.concurrent.CompletionService<A> s) +
      Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
      +
      <B> F<B,P1<A>>concurry(F<B,A> f) +
      Promotes a function to a concurrent function.
      +
      <B,C> F<B,F<C,P1<A>>>concurry(F2<B,C,A> f) +
      Promotes a function of arity-2 to a concurrent function.
      +
      Strategy<A>contramap(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
      +
      static <A> Effect1<java.util.concurrent.Future<A>>discard() +
      Returns an Effect that waits for a given Future to obtain a value, discarding the value.
      +
      Strategy<A>errorStrategy(Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>errorStrategy(Strategy<A> s, + Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>executorStrategy(java.util.concurrent.ExecutorService s) +
      Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
      +
      F<P1<A>,P1<A>>f() +
      Returns the functional representation of this Strategy, a function that evaluates a product-1.
      +
      static <A> Strategy<A>idStrategy() +
      Provides a strategy that performs no evaluation of its argument.
      +
      Strategy<A>map(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's domain (Invariant Functor pattern).
      +
      static <A> List<P1<A>>mergeAll(List<java.util.concurrent.Future<A>> xs) +
      Waits for every Future in a list to obtain a value, and collects those values in a list.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<A>>obtain() +
      Returns a function which returns a product-1 which waits for the given Future to obtain a value.
      +
      static <A> P1<A>obtain(java.util.concurrent.Future<A> t) +
      Provides a product-1 that waits for the given future to obtain a value.
      +
      P1<A>par(P1<A> a) +
      Apply the strategy to the given product-1.
      +
      static <A,B> P1<Array<B>>parFlatMap(Strategy<Array<B>> s, + F<A,Array<B>> f, + Array<A> as) +
      Binds the given function in parallel across the given array, using the given strategy, with a final join.
      +
      static <A,B> P1<List<B>>parFlatMap(Strategy<List<B>> s, + F<A,List<B>> f, + List<A> as) +
      Binds the given function in parallel across the given list, using the given strategy, with a final join.
      +
      P1<List<A>>parList(List<P1<A>> ps) +
      Evaluates a list of product-1s in parallel.
      +
      static <A> P1<List<A>>parListChunk(Strategy<List<A>> s, + int chunkLength, + List<P1<A>> as) +
      Sequentially evaluates chunks (sub-sequences) of a list in parallel.
      +
      <B> P1<Array<A>>parMap(F<B,A> f, + Array<B> bs) +
      Maps the given function over the given array in parallel using this strategy.
      +
      <B> P1<List<A>>parMap(F<B,A> f, + List<B> bs) +
      Maps the given function over the given list in parallel using this strategy.
      +
      <B> Array<A>parMap1(F<B,A> f, + Array<B> bs) +
      A strict version of parMap over arrays.
      +
      <B> List<A>parMap1(F<B,A> f, + List<B> bs) +
      A strict version of parMap over lists.
      +
      <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>>parMapArray() +
      First-class version of parMap on arrays.
      +
      <B> F<Array<B>,P1<Array<A>>>parMapArray(F<B,A> f) +
      Promotes a function to a parallel function on arrays using this strategy.
      +
      <B> F<F<B,A>,F<Array<B>,Array<A>>>parMapArray1() +
      First-class version of parMap1 on arrays (parallel array functor).
      +
      <B> F<F<B,A>,F<List<B>,P1<List<A>>>>parMapList() +
      First-class version of parMap on lists.
      +
      <B> F<List<B>,P1<List<A>>>parMapList(F<B,A> f) +
      Promotes a function to a parallel function on lists using this strategy.
      +
      <B> F<F<B,A>,F<List<B>,List<A>>>parMapList1() +
      First-class version of parMap1 on lists (parallel list functor).
      +
      <B,C> F2<Array<B>,Array<C>,P1<Array<A>>>parZipArrayWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
      +
      <B,C> F2<List<B>,List<C>,P1<List<A>>>parZipListWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
      +
      <B,C> P1<Array<A>>parZipWith(F2<B,C,A> f, + Array<B> bs, + Array<C> cs) +
      Zips together two arrays in parallel using a given function, with this strategy.
      +
      <B,C> P1<List<A>>parZipWith(F2<B,C,A> f, + List<B> bs, + List<C> cs) +
      Zips together two lists in parallel using a given function, with this strategy.
      +
      static <A> Strategy<A>seqStrategy() +
      Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
      +
      static <A> Strategy<A>simpleThreadStrategy() +
      Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
      +
      static <A> Strategy<A>strategy(F<P1<A>,P1<A>> f) +
      Constructs a strategy from the given evaluation function.
      +
      <B> Strategy<B>xmap(F<P1<A>,P1<B>> f, + F<P1<B>,P1<A>> g) +
      Maps the given bijective transformation across this strategy (Exponential Functor pattern).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public F<P1<A>,P1<A>> f()
        +
        Returns the functional representation of this Strategy, a function that evaluates a product-1.
        +
        +
        Returns:
        +
        The function representing this strategy, which evaluates a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        strategy

        +
        public static <A> Strategy<A> strategy(F<P1<A>,P1<A>> f)
        +
        Constructs a strategy from the given evaluation function.
        +
        +
        Parameters:
        +
        f - The execution function for the strategy
        +
        Returns:
        +
        A strategy that uses the given function to evaluate product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        par

        +
        public P1<A> par(P1<A> a)
        +
        Apply the strategy to the given product-1.
        +
        +
        Parameters:
        +
        a - A P1 to evaluate according to this strategy.
        +
        Returns:
        +
        A P1 that yields the value from calling the given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B> F<B,P1<A>> concurry(F<B,A> f)
        +
        Promotes a function to a concurrent function.
        +
        +
        Parameters:
        +
        f - A function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a Future value.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B,C> F<B,F<C,P1<A>>> concurry(F2<B,C,A> f)
        +
        Promotes a function of arity-2 to a concurrent function.
        +
        +
        Parameters:
        +
        f - The function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a product-1 that returns the value.
        +
        +
        • +
      + + + +
        +
      • +

        mergeAll

        +
        public static <A> List<P1<A>> mergeAll(List<java.util.concurrent.Future<A>> xs)
        +
        Waits for every Future in a list to obtain a value, and collects those values in a list.
        +
        +
        Parameters:
        +
        xs - The list of Futures from which to get values.
        +
        Returns:
        +
        A list of values extracted from the Futures in the argument list.
        +
        +
        • +
      + + + +
        +
      • +

        parList

        +
        public P1<List<A>> parList(List<P1<A>> ps)
        +
        Evaluates a list of product-1s in parallel.
        +
        +
        Parameters:
        +
        ps - A list to evaluate in parallel.
        +
        Returns:
        +
        A list of the values of the product-1s in the argument.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<List<A>> parMap(F<B,A> f,
+                              List<B> bs)
        +
        Maps the given function over the given list in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<Array<A>> parMap(F<B,A> f,
+                               Array<B> bs)
        +
        Maps the given function over the given array in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> List<A> parMap1(F<B,A> f,
+                           List<B> bs)
        +
        A strict version of parMap over lists. + Maps the given function over the given list in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> Array<A> parMap1(F<B,A> f,
+                            Array<B> bs)
        +
        A strict version of parMap over arrays. + Maps the given function over the given arrays in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        An array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<List<B>,P1<List<A>>> parMapList(F<B,A> f)
        +
        Promotes a function to a parallel function on lists using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on lists.
        +
        Returns:
        +
        The function transformed into a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<F<B,A>,F<List<B>,P1<List<A>>>> parMapList()
        +
        First-class version of parMap on lists.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList1

        +
        public <B> F<F<B,A>,F<List<B>,List<A>>> parMapList1()
        +
        First-class version of parMap1 on lists (parallel list functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<Array<B>,P1<Array<A>>> parMapArray(F<B,A> f)
        +
        Promotes a function to a parallel function on arrays using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on arrays.
        +
        Returns:
        +
        The function transformed into a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>> parMapArray()
        +
        First-class version of parMap on arrays.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray1

        +
        public <B> F<F<B,A>,F<Array<B>,Array<A>>> parMapArray1()
        +
        First-class version of parMap1 on arrays (parallel array functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<List<B>> parFlatMap(Strategy<List<B>> s,
+                                           F<A,List<B>> f,
+                                           List<A> as)
        +
        Binds the given function in parallel across the given list, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given list.
        +
        as - The list across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<Array<B>> parFlatMap(Strategy<Array<B>> s,
+                                            F<A,Array<B>> f,
+                                            Array<A> as)
        +
        Binds the given function in parallel across the given array, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given array.
        +
        as - The array across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parListChunk

        +
        public static <A> P1<List<A>> parListChunk(Strategy<List<A>> s,
+                                           int chunkLength,
+                                           List<P1<A>> as)
        +
        Sequentially evaluates chunks (sub-sequences) of a list in parallel. Splits the list into chunks, + evaluating the chunks simultaneously, but each chunk as a sequence.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        chunkLength - The length of each sequence.
        +
        as - The list to evaluate in parallel chunks.
        +
        Returns:
        +
        A product-1 containing the list of results extracted from the given list of product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<List<A>> parZipWith(F2<B,C,A> f,
+                                    List<B> bs,
+                                    List<C> cs)
        +
        Zips together two lists in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the lists, position-wise, + passing elements from the first list to the first argument of the function, and elements from the second list + to the second argument of the function, yielding a list of the results. + If the lists are not of the same length, the remaining elements of the longer list are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A list to zip with the given function.
        +
        cs - A list to zip with the given function.
        +
        Returns:
        +
        The list of the results of calling the given function on corresponding elements of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<Array<A>> parZipWith(F2<B,C,A> f,
+                                     Array<B> bs,
+                                     Array<C> cs)
        +
        Zips together two arrays in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the arrays, position-wise, + passing elements from the first array to the first argument of the function, and elements from the second array + to the second argument of the function, yielding a array of the results. + If the arrays are not of the same length, the remaining elements of the longer array are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A array to zip with the given function.
        +
        cs - A array to zip with the given function.
        +
        Returns:
        +
        The array of the results of calling the given function on corresponding elements of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parZipListWith

        +
        public <B,C> F2<List<B>,List<C>,P1<List<A>>> parZipListWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two lists using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parZipArrayWith

        +
        public <B,C> F2<Array<B>,Array<C>,P1<Array<A>>> parZipArrayWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two arrays using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<A>> obtain()
        +
        Returns a function which returns a product-1 which waits for the given Future to obtain a value.
        +
        +
        Returns:
        +
        A function which, given a Future, yields a product-1 that waits for it.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> P1<A> obtain(java.util.concurrent.Future<A> t)
        +
        Provides a product-1 that waits for the given future to obtain a value.
        +
        +
        Parameters:
        +
        t - A Future for which to wait.
        +
        Returns:
        +
        A product-1 that waits for the given future to obtain a value.
        +
        +
        • +
      + + + +
        +
      • +

        discard

        +
        public static <A> Effect1<java.util.concurrent.Future<A>> discard()
        +
        Returns an Effect that waits for a given Future to obtain a value, discarding the value.
        +
        +
        Returns:
        +
        An effect, which, given a Future, waits for it to obtain a value, discarding the value.
        +
        +
        • +
      + + + +
        +
      • +

        simpleThreadStrategy

        +
        public static <A> Strategy<A> simpleThreadStrategy()
        +
        Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        Returns:
        +
        a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        • +
      + + + +
        +
      • +

        executorStrategy

        +
        public static <A> Strategy<A> executorStrategy(java.util.concurrent.ExecutorService s)
        +
        Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
        +
        +
        Parameters:
        +
        s - The ExecutorService to use for scheduling evaluations.
        +
        Returns:
        +
        A Strategy that uses the provided ExecutorService to control the method and degree + of parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        completionStrategy

        +
        public static <A> Strategy<A> completionStrategy(java.util.concurrent.CompletionService<A> s)
        +
        Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
        +
        +
        Parameters:
        +
        s - The CompletionService to use for scheduling evaluations and detect their completion.
        +
        Returns:
        +
        A Strategy that uses the provided CompletionService to control the method and degree of parallelism, + and notifies the service of task completion.
        +
        +
        • +
      + + + +
        +
      • +

        seqStrategy

        +
        public static <A> Strategy<A> seqStrategy()
        +
        Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        idStrategy

        +
        public static <A> Strategy<A> idStrategy()
        +
        Provides a strategy that performs no evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs no evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Strategy<B> xmap(F<P1<A>,P1<B>> f,
+                            F<P1<B>,P1<A>> g)
        +
        Maps the given bijective transformation across this strategy (Exponential Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        g - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that maps to this strategy and back again.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public Strategy<A> map(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's domain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        Returns:
        +
        A new strategy that applies the given transformation after each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public Strategy<A> contramap(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that applies the given transformation before each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public Strategy<A> errorStrategy(Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by this strategy and applies + the given side-effect to them.
        +
        +
        Parameters:
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public static <A> Strategy<A> errorStrategy(Strategy<A> s,
+                                            Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by the given strategy + and applies the given side-effect to them.
        +
        +
        Parameters:
        +
        s - The strategy to equip with an error-handling effect.
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        callableStrategy

        +
        public static <A> Strategy<java.util.concurrent.Callable<A>> callableStrategy(Strategy<java.util.concurrent.Callable<A>> s)
        +
        Provides a normalising strategy that fully evaluates its Callable argument.
        +
        +
        Parameters:
        +
        s - A non-normalising strategy to use for the evaluation.
        +
        Returns:
        +
        A new strategy that fully evaluates Callables, using the given strategy.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/package-frame.html b/javadoc/4.8/functionaljava/fj/control/parallel/package-frame.html new file mode 100644 index 0000000..d44c818 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/package-frame.html @@ -0,0 +1,24 @@ + + + + + +fj.control.parallel (core 4.8 API) + + + + + +

fj.control.parallel

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/package-summary.html b/javadoc/4.8/functionaljava/fj/control/parallel/package-summary.html new file mode 100644 index 0000000..ff4397f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/package-summary.html @@ -0,0 +1,175 @@ + + + + + +fj.control.parallel (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.parallel

+
+
Parallelization strategies.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Actor<A> +
    Light weight actors for Java.
    +
    Callables +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    ParModule +
    A module of higher-order concurrency features.
    +
    Promise<A> +
    Represents a non-blocking future value.
    +
    Strategy<A> +
    Functional-style parallel evaluation strategies.
    +
    +
    • +
+ + + +

Package fj.control.parallel Description

+
Parallelization strategies.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/control/parallel/package-tree.html b/javadoc/4.8/functionaljava/fj/control/parallel/package-tree.html new file mode 100644 index 0000000..7b2394e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/control/parallel/package-tree.html @@ -0,0 +1,139 @@ + + + + + +fj.control.parallel Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.parallel

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/$.html b/javadoc/4.8/functionaljava/fj/data/$.html new file mode 100644 index 0000000..eaaf7bd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/$.html @@ -0,0 +1,319 @@ + + + + + +$ (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class $<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<B>
      • +
    • +
        +
      • fj.data.$<A,B>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<B>
    +
    +
    +
    +
    public final class $<A,B>
+extends P1<B>
    +
    The constant arrow, for attaching a new name to an existing type. For every pair of types A and B, this type + is the identity morphism from B to B.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        _

        +
        @Deprecated
+public static <A,B> $<A,B> _(B b)
        +
        Deprecated. JDK 8 warns '_' may not be supported after SE 8. As of release 4.4, use constant(B) (note the synonym __(B)).
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        __

        +
        public static <A,B> $<A,B> __(B b)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> $<A,B> constant(B b)
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public B _1()
        +
        Description copied from class: P1
        +
        Access the first element of the product.
        +
        +
        Specified by:
        +
        _1 in class P1<B>
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Array.ImmutableProjection.html b/javadoc/4.8/functionaljava/fj/data/Array.ImmutableProjection.html new file mode 100644 index 0000000..5877c45 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Array.ImmutableProjection.html @@ -0,0 +1,679 @@ + + + + + +Array.ImmutableProjection (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array.ImmutableProjection<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array.ImmutableProjection<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Array<A>
    +
    +
    +
    +
    public static final class Array.ImmutableProjection<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Projects an array by providing only operations which do not mutate.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      intlength() +
      Returns the length of this array.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element + in Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Array.html b/javadoc/4.8/functionaljava/fj/data/Array.html new file mode 100644 index 0000000..732aef9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Array.html @@ -0,0 +1,1719 @@ + + + + + +Array (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Array<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an interface to arrays.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Array.ImmutableProjection<A> +
      Projects an array by providing only operations which do not mutate.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      java.lang.Object[]array() +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>array(A... as) +
      Constructs an array from the given elements.
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>arrayArray(A... as) +
      Returns a copy of the underlying primitive array.
      +
      java.util.List<A>asJavaList() +
      Projects an unmodifiable list view of this array.
      +
      <B,C> Array<C>bind(Array<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B,C> Array<C>bind(Array<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      static <T> T[]copyOf(T[] a, + int len) 
      static <T,U> T[]copyOf(U[] a, + int len, + java.lang.Class<? extends T[]> newType) 
      static char[]copyOfRange(char[] a, + int from, + int to) 
      static <A> Array<A>empty() +
      Returns an empty array.
      +
      booleanequals(java.lang.Object o) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      inthashCode() 
      Array.ImmutableProjection<A>immutable() 
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      static <A> Array<A>iterableArray(java.lang.Iterable<A> i) +
      Takes the given iterable to an array.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      static <A> Array<A>iteratorArray(java.util.Iterator<A> i) +
      Creates an Array from the iterator.
      +
      static <A> F<Array<Array<A>>,Array<A>>join() +
      A first-class version of join
      +
      static <A> Array<A>join(Array<Array<A>> o) +
      Joins the given array of arrays using a bind operation.
      +
      intlength() +
      Returns the length of this array.
      +
      static <A,B> F<F<A,B>,F<Array<A>,Array<B>>>map() +
      First-class map function for Arrays.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      static Array<java.lang.Integer>range(int from, + int to) +
      Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>scanLeft(F<B,F<A,B>> f, + B b) +
      Performs a fold left accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F<A,F<A,A>> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F2<A,A,A> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F2<A,B,B> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F<A,F<A,A>> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F2<A,A,A> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      Unitset(int index, + A a) +
      Sets the element at the given index to the given value.
      +
      static <A> Array<A>single(A a) +
      Constructs a singleton array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.ArrayList<A>toJavaList() +
      Returns a java.util.ArrayList projection of this array.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element in + Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      java.lang.StringtoString() 
      static <A,B> P2<Array<A>,Array<B>>unzip(Array<P2<A,B>> xs) +
      Transforms an array of pairs into an array of first components and an array of second components.
      +
      static <A> F<A[],Array<A>>wrap() +
      First-class wrapper function for arrays.
      +
      <B> Array<P2<A,B>>zip(Array<B> bs) +
      Zips this array with the given array to produce an array of pairs.
      +
      Array<P2<A,java.lang.Integer>>zipIndex() +
      Zips this array with the index of its element as a pair.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F<A,F<B,C>> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F2<A,B,C> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public Unit set(int index,
+                A a)
        +
        Sets the element at the given index to the given value.
        +
        +
        Parameters:
        +
        index - The index at which to set the given value.
        +
        a - The value to set at the given index.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public A[] array(java.lang.Class<A[]> c)
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Parameters:
        +
        c - A class for the returned array.
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public java.lang.Object[] array()
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Returns:
        +
        A copy of the underlying primitive array;
        +
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element in + Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F<B,F<A,B>> f,
+                             B b)
        +
        Performs a fold left accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F2<B,A,B> f,
+                             B b)
        +
        Performs a left-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F2<A,A,A> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F2<A,A,A> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F<A,F<B,C>> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F2<A,B,C> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Array<A> empty()
        +
        Returns an empty array.
        +
        +
        Returns:
        +
        An empty array.
        +
        +
        • +
      + + + + + +
        +
      • +

        array

        +
        @SafeVarargs
+public static <A> Array<A> array(A... as)
        +
        Constructs an array from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct the array with.
        +
        Returns:
        +
        A new array of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Array<A> single(A a)
        +
        Constructs a singleton array.
        +
        +
        Parameters:
        +
        a - The element to put in the array.
        +
        Returns:
        +
        An array with the given single element.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A> F<A[],Array<A>> wrap()
        +
        First-class wrapper function for arrays.
        +
        +
        Returns:
        +
        A function that wraps a given array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Array<A>,Array<B>>> map()
        +
        First-class map function for Arrays.
        +
        +
        Returns:
        +
        A function that maps a given function across a given array.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Array<A> join(Array<Array<A>> o)
        +
        Joins the given array of arrays using a bind operation.
        +
        +
        Parameters:
        +
        o - The array of arrays to join.
        +
        Returns:
        +
        A new array that is the join of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Array<Array<A>>,Array<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a array of arrays using a bind operation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this array.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this array, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on the elements of this array.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + array.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this array.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Array<java.lang.Integer> range(int from,
+                                             int to)
        +
        Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the array (inclusive).
        +
        to - The maximum value for the array (exclusive).
        +
        Returns:
        +
        An array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F<A,F<B,C>> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F2<A,B,C> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> Array<P2<A,B>> zip(Array<B> bs)
        +
        Zips this array with the given array to produce an array of pairs. If this array and the given + array have different lengths, then the longer array is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public Array<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this array with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new array with the same length as this array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        asJavaList

        +
        public java.util.List<A> asJavaList()
        +
        Projects an unmodifiable list view of this array.
        +
        +
        Returns:
        +
        An unmodifiable list view of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.ArrayList<A> toJavaList()
        +
        Returns a java.util.ArrayList projection of this array.
        +
        • +
      + + + +
        +
      • +

        iterableArray

        +
        public static <A> Array<A> iterableArray(java.lang.Iterable<A> i)
        +
        Takes the given iterable to an array.
        +
        +
        Parameters:
        +
        i - The iterable to take to an array.
        +
        Returns:
        +
        An array from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorArray

        +
        public static <A> Array<A> iteratorArray(java.util.Iterator<A> i)
        +
        Creates an Array from the iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayArray

        +
        @SafeVarargs
+public static <A> Array<A> arrayArray(A... as)
        +
        Returns a copy of the underlying primitive array. + Equivalent to array(A...)
        +
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Array<A>,Array<B>> unzip(Array<P2<A,B>> xs)
        +
        Transforms an array of pairs into an array of first components and an array of second components.
        +
        +
        Parameters:
        +
        xs - The array of pairs to transform.
        +
        Returns:
        +
        An array of first components and an array of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T,U> T[] copyOf(U[] a,
+                               int len,
+                               java.lang.Class<? extends T[]> newType)
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T> T[] copyOf(T[] a,
+                             int len)
        +
        • +
      + + + +
        +
      • +

        copyOfRange

        +
        public static char[] copyOfRange(char[] a,
+                                 int from,
+                                 int to)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Conversions.html b/javadoc/4.8/functionaljava/fj/data/Conversions.html new file mode 100644 index 0000000..4b27da1 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Conversions.html @@ -0,0 +1,1607 @@ + + + + + +Conversions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Conversions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Conversions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Conversions
+extends java.lang.Object
    +
    Functions that convert between data structure types.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        List_String

        +
        public static final F<List<java.lang.Character>,java.lang.String> List_String
        +
        A function that converts lists to strings.
        +
        • +
      + + + +
        +
      • +

        List_StringBuffer

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuffer> List_StringBuffer
        +
        A function that converts lists to string buffers.
        +
        • +
      + + + +
        +
      • +

        List_StringBuilder

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuilder> List_StringBuilder
        +
        A function that converts lists to string builders.
        +
        • +
      + + + +
        +
      • +

        Array_String

        +
        public static final F<Array<java.lang.Character>,java.lang.String> Array_String
        +
        A function that converts arrays to strings.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuffer

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuffer> Array_StringBuffer
        +
        A function that converts arrays to string buffers.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuilder

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuilder> Array_StringBuilder
        +
        A function that converts arrays to string builders.
        +
        • +
      + + + +
        +
      • +

        Stream_String

        +
        public static final F<Stream<java.lang.Character>,java.lang.String> Stream_String
        +
        A function that converts streams to strings.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuffer

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuffer> Stream_StringBuffer
        +
        A function that converts streams to string buffers.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuilder

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuilder> Stream_StringBuilder
        +
        A function that converts streams to string builders.
        +
        • +
      + + + +
        +
      • +

        Option_String

        +
        public static final F<Option<java.lang.Character>,java.lang.String> Option_String
        +
        A function that converts options to strings.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuffer

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuffer> Option_StringBuffer
        +
        A function that converts options to string buffers.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuilder

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuilder> Option_StringBuilder
        +
        A function that converts options to string builders.
        +
        • +
      + + + +
        +
      • +

        String_List

        +
        public static final F<java.lang.String,List<java.lang.Character>> String_List
        +
        A function that converts strings to lists.
        +
        • +
      + + + +
        +
      • +

        String_Array

        +
        public static final F<java.lang.String,Array<java.lang.Character>> String_Array
        +
        A function that converts strings to arrays.
        +
        • +
      + + + +
        +
      • +

        String_Option

        +
        public static final F<java.lang.String,Option<java.lang.Character>> String_Option
        +
        A function that converts strings to options.
        +
        • +
      + + + +
        +
      • +

        String_Stream

        +
        public static final F<java.lang.String,Stream<java.lang.Character>> String_Stream
        +
        A function that converts strings to streams.
        +
        • +
      + + + +
        +
      • +

        String_StringBuffer

        +
        public static final F<java.lang.String,java.lang.StringBuffer> String_StringBuffer
        +
        A function that converts strings to string buffers.
        +
        • +
      + + + +
        +
      • +

        String_StringBuilder

        +
        public static final F<java.lang.String,java.lang.StringBuilder> String_StringBuilder
        +
        A function that converts strings to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_List

        +
        public static final F<java.lang.StringBuffer,List<java.lang.Character>> StringBuffer_List
        +
        A function that converts string buffers to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Array

        +
        public static final F<java.lang.StringBuffer,Array<java.lang.Character>> StringBuffer_Array
        +
        A function that converts string buffers to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stream

        +
        public static final F<java.lang.StringBuffer,Stream<java.lang.Character>> StringBuffer_Stream
        +
        A function that converts string buffers to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Option

        +
        public static final F<java.lang.StringBuffer,Option<java.lang.Character>> StringBuffer_Option
        +
        A function that converts string buffers to options.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_String

        +
        public static final F<java.lang.StringBuffer,java.lang.String> StringBuffer_String
        +
        A function that converts string buffers to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_StringBuilder

        +
        public static final F<java.lang.StringBuffer,java.lang.StringBuilder> StringBuffer_StringBuilder
        +
        A function that converts string buffers to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_List

        +
        public static final F<java.lang.StringBuilder,List<java.lang.Character>> StringBuilder_List
        +
        A function that converts string builders to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Array

        +
        public static final F<java.lang.StringBuilder,Array<java.lang.Character>> StringBuilder_Array
        +
        A function that converts string builders to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stream

        +
        public static final F<java.lang.StringBuilder,Stream<java.lang.Character>> StringBuilder_Stream
        +
        A function that converts string builders to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Option

        +
        public static final F<java.lang.StringBuilder,Option<java.lang.Character>> StringBuilder_Option
        +
        A function that converts string builders to options.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_String

        +
        public static final F<java.lang.StringBuilder,java.lang.String> StringBuilder_String
        +
        A function that converts string builders to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_StringBuffer

        +
        public static final F<java.lang.StringBuilder,java.lang.StringBuffer> StringBuilder_StringBuffer
        +
        A function that converts string builders to string buffers.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_Array

        +
        public static <A> F<List<A>,Array<A>> List_Array()
        +
        A function that converts lists to arrays.
        +
        +
        Returns:
        +
        A function that converts lists to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stream

        +
        public static <A> F<List<A>,Stream<A>> List_Stream()
        +
        A function that converts lists to streams.
        +
        +
        Returns:
        +
        A function that converts lists to streams.
        +
        +
        • +
      + + + +
        +
      • +

        List_Option

        +
        public static <A> F<List<A>,Option<A>> List_Option()
        +
        A function that converts lists to options.
        +
        +
        Returns:
        +
        A function that converts lists to options.
        +
        +
        • +
      + + + +
        +
      • +

        List_Either

        +
        public static <A,B> F<P1<A>,F<List<B>,Either<A,B>>> List_Either()
        +
        A function that converts lists to eithers.
        +
        +
        Returns:
        +
        A function that converts lists to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Array_List

        +
        public static <A> F<Array<A>,List<A>> Array_List()
        +
        A function that converts arrays to lists.
        +
        +
        Returns:
        +
        A function that converts arrays to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stream

        +
        public static <A> F<Array<A>,Stream<A>> Array_Stream()
        +
        A function that converts arrays to streams.
        +
        +
        Returns:
        +
        A function that converts arrays to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Option

        +
        public static <A> F<Array<A>,Option<A>> Array_Option()
        +
        A function that converts arrays to options.
        +
        +
        Returns:
        +
        A function that converts arrays to options.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Either

        +
        public static <A,B> F<P1<A>,F<Array<B>,Either<A,B>>> Array_Either()
        +
        A function that converts arrays to eithers.
        +
        +
        Returns:
        +
        A function that converts arrays to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_List

        +
        public static <A> F<Stream<A>,List<A>> Stream_List()
        +
        A function that converts streams to lists.
        +
        +
        Returns:
        +
        A function that converts streams to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Array

        +
        public static <A> F<Stream<A>,Array<A>> Stream_Array()
        +
        A function that converts streams to arrays.
        +
        +
        Returns:
        +
        A function that converts streams to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Option

        +
        public static <A> F<Stream<A>,Option<A>> Stream_Option()
        +
        A function that converts streams to options.
        +
        +
        Returns:
        +
        A function that converts streams to options.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Either

        +
        public static <A,B> F<P1<A>,F<Stream<B>,Either<A,B>>> Stream_Either()
        +
        A function that converts streams to eithers.
        +
        +
        Returns:
        +
        A function that converts streams to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Option_List

        +
        public static <A> F<Option<A>,List<A>> Option_List()
        +
        A function that converts options to lists.
        +
        +
        Returns:
        +
        A function that converts options to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Array

        +
        public static <A> F<Option<A>,Array<A>> Option_Array()
        +
        A function that converts options to arrays.
        +
        +
        Returns:
        +
        A function that converts options to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stream

        +
        public static <A> F<Option<A>,Stream<A>> Option_Stream()
        +
        A function that converts options to streams.
        +
        +
        Returns:
        +
        A function that converts options to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Either

        +
        public static <A,B> F<P1<A>,F<Option<B>,Either<A,B>>> Option_Either()
        +
        A function that converts options to eithers.
        +
        +
        Returns:
        +
        A function that converts options to eithers.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        Effect0_P1

        +
        public static P1<Unit> Effect0_P1(Effect0 e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<A,Unit> Effect1_F(Effect1<A> e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<Effect1<A>,F<A,Unit>> Effect1_F()
        +
        • +
      + + + +
        +
      • +

        Effect_IO

        +
        public static IO<Unit> Effect_IO(Effect0 e)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        Either_ListA

        +
        public static <A,B> F<Either<A,B>,List<A>> Either_ListA()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ListB

        +
        public static <A,B> F<Either<A,B>,List<B>> Either_ListB()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayA

        +
        public static <A,B> F<Either<A,B>,Array<A>> Either_ArrayA()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayB

        +
        public static <A,B> F<Either<A,B>,Array<B>> Either_ArrayB()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamA

        +
        public static <A,B> F<Either<A,B>,Stream<A>> Either_StreamA()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamB

        +
        public static <A,B> F<Either<A,B>,Stream<B>> Either_StreamB()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionA

        +
        public static <A,B> F<Either<A,B>,Option<A>> Either_OptionA()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionB

        +
        public static <A,B> F<Either<A,B>,Option<B>> Either_OptionB()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.String> Either_StringA()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.String> Either_StringB()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuffer> Either_StringBufferA()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuffer> Either_StringBufferB()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuilder> Either_StringBuilderA()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuilder> Either_StringBuilderB()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> SafeIO<A> F_SafeIO(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> F<F<Unit,A>,SafeIO<A>> F_SafeIO()
        +
        • +
      + + + +
        +
      • +

        String_Either

        +
        public static <A> F<P1<A>,F<java.lang.String,Either<A,java.lang.Character>>> String_Either()
        +
        A function that converts string to eithers.
        +
        +
        Returns:
        +
        A function that converts string to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuffer,Either<A,java.lang.Character>>> StringBuffer_Either()
        +
        A function that converts string buffers to eithers.
        +
        +
        Returns:
        +
        A function that converts string buffers to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuilder,Either<A,java.lang.Character>>> StringBuilder_Either()
        +
        A function that converts string builders to eithers.
        +
        +
        Returns:
        +
        A function that converts string builders to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> SafeIO<Validation<Z,A>> Try_SafeIO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> F<Try0<A,Z>,SafeIO<Validation<Z,A>>> Try_SafeIO()
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> IO<A> Try_IO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> F<Try0<A,Z>,IO<A>> Try_IO()
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<A,Validation<Z,B>> Try_F(Try1<A,B,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<Try1<A,B,Z>,F<A,Validation<Z,B>>> Try_F()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/DList.html b/javadoc/4.8/functionaljava/fj/data/DList.html new file mode 100644 index 0000000..5153197 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/DList.html @@ -0,0 +1,474 @@ + + + + + +DList (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class DList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.DList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DList<A>
+extends java.lang.Object
    +
    Difference List. It converts left associative appends into right associative ones to improve performance.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DList<A>append(DList<A> other) +
      Appends two DLists together to produce a new DList.
      +
      static <A> DList<A>arrayDList(A... as) +
      Creates a DList from an array
      +
      DList<A>cons(A a) +
      Prepends a single element on the DList to produce a new DList.
      +
      static <A> DList<A>dlist(F<List<A>,Trampoline<List<A>>> f) +
      Creates a DList from the function + + For alternatives functions to create a DList:
      +
      static <A> DList<A>iterableDList(java.lang.Iterable<A> it) +
      Creates a DList from an Iterable
      +
      static <A> DList<A>iteratorDList(java.util.Iterator<A> it) +
      Creates a DList from an Iterator
      +
      static <A> DList<A>listDList(List<A> a) +
      Creates a DList from a List
      +
      static <A> DList<A>nil() +
      A empty DList.
      +
      List<A>run() +
      Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
      +
      static <A> DList<A>single(A a) +
      Produces a DList with one element.
      +
      DList<A>snoc(A a) +
      Appends a single element on the end of the DList to produce a new DList.
      +
      java.util.List<A>toJavaList() +
      Converts the DList to a standard java.util.List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        listDList

        +
        public static <A> DList<A> listDList(List<A> a)
        +
        Creates a DList from a List
        +
        • +
      + + + +
        +
      • +

        iterableDList

        +
        public static <A> DList<A> iterableDList(java.lang.Iterable<A> it)
        +
        Creates a DList from an Iterable
        +
        • +
      + + + +
        +
      • +

        iteratorDList

        +
        public static <A> DList<A> iteratorDList(java.util.Iterator<A> it)
        +
        Creates a DList from an Iterator
        +
        • +
      + + + + + +
        +
      • +

        arrayDList

        +
        @SafeVarargs
+public static <A> DList<A> arrayDList(A... as)
        +
        Creates a DList from an array
        +
        • +
      + + + +
        +
      • +

        run

        +
        public List<A> run()
        +
        Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List. + This is what converts the appending operation from left associative to right associative, + giving DList it's speed.
        +
        +
        Returns:
        +
        the final List
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the DList to a standard java.util.List.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> DList<A> nil()
        +
        A empty DList.
        +
        +
        Type Parameters:
        +
        A -
        +
        Returns:
        +
        a empty DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> DList<A> single(A a)
        +
        Produces a DList with one element.
        +
        +
        Type Parameters:
        +
        A -
        +
        Parameters:
        +
        a - the element in the DList.
        +
        Returns:
        +
        a DList with one element.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public DList<A> cons(A a)
        +
        Prepends a single element on the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public DList<A> snoc(A a)
        +
        Appends a single element on the end of the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public DList<A> append(DList<A> other)
        +
        Appends two DLists together to produce a new DList.
        +
        +
        Parameters:
        +
        other - the other DList to append on the end of this one.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Either.LeftProjection.html b/javadoc/4.8/functionaljava/fj/data/Either.LeftProjection.html new file mode 100644 index 0000000..0b8db1d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Either.LeftProjection.html @@ -0,0 +1,794 @@ + + + + + +Either.LeftProjection (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.LeftProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.LeftProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.LeftProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A left projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<X,B>apply(Either<F<A,X>,B> e) +
      Function application on this projection's value.
      +
      <X> Either<X,B>bind(F<A,Either<X,B>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<A,X>>filter(F<A,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<A,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<X,B>map(F<A,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Aon(F<B,A> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      AorValue(A a) +
      The value of this projection or the given argument.
      +
      AorValue(F0<A> a) +
      The value of this projection or the given argument.
      +
      <X> Either<X,B>sequence(Either<X,B> e) +
      Anonymous bind through this projection.
      +
      Array<A>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<A>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<A>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<A>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<C,B>>traverseIO(F<A,IO<C>> f) +
      Anonymous bind through this projection.
      +
      <C> List<Either<C,B>>traverseList(F<A,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<C,B>>traverseOption(F<A,Option<C>> f) 
      <C> Stream<Either<C,B>>traverseStream(F<A,Stream<C>> f) 
      Avalue() +
      The value of this projection or fails with a specialised error message.
      +
      AvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      AvalueE(java.lang.String err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(java.lang.String err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public A orValue(F0<A> a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orValue

        +
        public A orValue(A a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public A on(F<B,A> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<X,B> map(F<A,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<X,B> bind(F<A,Either<X,B>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<X,B> sequence(Either<X,B> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<C,B>> traverseList(F<A,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<C,B>> traverseIO(F<A,IO<C>> f)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<A,X>> filter(F<A,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<X,B> apply(Either<F<A,X>,B> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Either.RightProjection.html b/javadoc/4.8/functionaljava/fj/data/Either.RightProjection.html new file mode 100644 index 0000000..5c70546 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Either.RightProjection.html @@ -0,0 +1,761 @@ + + + + + +Either.RightProjection (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.RightProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.RightProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<B>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.RightProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<B>
    +
    A right projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<A,X>apply(Either<A,F<B,X>> e) +
      Function application on this projection's value.
      +
      <X> Either<A,X>bind(F<B,Either<A,X>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<B,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<X,B>>filter(F<B,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
      +
      booleanforall(F<B,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<B,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<B> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<B>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<A,X>map(F<B,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Bon(F<A,B> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      BorValue(F0<B> b) +
      The value of this projection or the given argument.
      +
      <X> Either<A,X>sequence(Either<A,X> e) +
      Anonymous bind through this projection.
      +
      Array<B>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<B>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<B>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<B>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<B>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<A,C>>traverseIO(F<B,IO<C>> f) +
      Traverse with a function that has IO effect
      +
      <C> List<Either<A,C>>traverseList(F<B,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<A,C>>traverseOption(F<B,Option<C>> f) 
      <C> P1<Either<A,C>>traverseP1(F<B,P1<C>> f) 
      <C> Stream<Either<A,C>>traverseStream(F<B,Stream<C>> f) 
      Bvalue() +
      The value of this projection or fails with a specialised error message.
      +
      BvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<B> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<B>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public B valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public B value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public B orValue(F0<B> b)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        b - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public B on(F<A,B> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<B,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<B> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<A,X> map(F<B,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<A,X> bind(F<B,Either<A,X>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<A,X> sequence(Either<A,X> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<A,C>> traverseList(F<B,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<A,C>> traverseIO(F<B,IO<C>> f)
        +
        Traverse with a function that has IO effect
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <C> P1<Either<A,C>> traverseP1(F<B,P1<C>> f)
        +
        • +
      + + + + + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<X,B>> filter(F<B,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<A,X> apply(Either<A,F<B,X>> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<B,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<B,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<B> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<B> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<B> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<B> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<B> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Either.html b/javadoc/4.8/functionaljava/fj/data/Either.html new file mode 100644 index 0000000..05fd743 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Either.html @@ -0,0 +1,944 @@ + + + + + +Either (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Either<A,B>
+extends java.lang.Object
    +
    The Either type represents a value of one of two possible types (a disjoint union). + The data constructors; Left and Right represent the two possible + values. The Either type is often used as an alternative to + scala.Option where Left represents failure (by convention) and + Right is akin to Some.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        left

        +
        public final Either.LeftProjection<A,B> left()
        +
        Projects this either as a left.
        +
        +
        Returns:
        +
        A left projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public final Either.RightProjection<A,B> right()
        +
        Projects this either as a right.
        +
        +
        Returns:
        +
        A right projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        isLeft

        +
        public abstract boolean isLeft()
        +
        Returns true if this either is a left, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a left, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isRight

        +
        public abstract boolean isRight()
        +
        Returns true if this either is a right, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a right, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public abstract <X> X either(F<A,X> left,
+                             F<B,X> right)
        +
        The catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public final <X,Y> Either<X,Y> bimap(F<A,X> left,
+                                     F<B,Y> right)
        +
        Map the given functions across the appropriate side.
        +
        +
        Parameters:
        +
        left - The function to map if this is left.
        +
        right - The function to map if this is right.
        +
        Returns:
        +
        A new either value after mapping with the appropriate function applied.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final Either<B,A> swap()
        +
        If this is a left, then return the left value in right, or vice versa.
        +
        +
        Returns:
        +
        The value of this either swapped to the opposing side.
        +
        +
        • +
      + + + + + +
        +
      • +

        left

        +
        public static <A,B> Either<A,B> left(A a)
        +
        Construct a left value of either.
        +
        +
        Parameters:
        +
        a - The value underlying the either.
        +
        Returns:
        +
        A left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A,B> F<A,Either<A,B>> left_()
        +
        A function that constructs a left value of either.
        +
        +
        Returns:
        +
        A function that constructs a left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A,B> F<B,Either<A,B>> right_()
        +
        A function that constructs a right value of either.
        +
        +
        Returns:
        +
        A function that constructs a right value of either.
        +
        +
        • +
      + + + + + +
        +
      • +

        right

        +
        public static <A,B> Either<A,B> right(B b)
        +
        Construct a right value of either.
        +
        +
        Parameters:
        +
        b - The value underlying the either.
        +
        Returns:
        +
        A right value of either.
        +
        +
        • +
      + + + +
        +
      • +

        either_

        +
        public static <A,B,X> F<Either<A,B>,X> either_(F<A,X> left,
+                                               F<B,X> right)
        +
        First class catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        leftMap_

        +
        public static <A,B,X> F<F<A,X>,F<Either<A,B>,Either<X,B>>> leftMap_()
        +
        +
        Returns:
        +
        A function that maps another function across an either's left projection.
        +
        +
        • +
      + + + +
        +
      • +

        rightMap_

        +
        public static <A,B,X> F<F<B,X>,F<Either<A,B>,Either<A,X>>> rightMap_()
        +
        +
        Returns:
        +
        A function that maps another function across an either's right projection.
        +
        +
        • +
      + + + +
        +
      • +

        joinLeft

        +
        public static <A,B> Either<A,B> joinLeft(Either<Either<A,B>,B> e)
        +
        Joins an either through left.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + +
        +
      • +

        joinRight

        +
        public static <A,B> Either<A,B> joinRight(Either<A,Either<A,B>> e)
        +
        Joins an either through right.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceLeft

        +
        public static <A,X> Either<List<A>,X> sequenceLeft(List<Either<A,X>> a)
        +
        Sequences through the left side of the either monad with a list of values.
        +
        +
        Parameters:
        +
        a - The list of values to sequence with the either monad.
        +
        Returns:
        +
        A sequenced value.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceRight

        +
        public static <B,X> Either<X,List<B>> sequenceRight(List<Either<X,B>> a)
        +
        Sequences through the right side of the either monad with a list of values.
        +
        +
        Parameters:
        +
        a - The list of values to sequence with the either monad.
        +
        Returns:
        +
        A sequenced value.
        +
        +
        • +
      + + + +
        +
      • +

        traverseListRight

        +
        public final <C> List<Either<A,C>> traverseListRight(F<B,List<C>> f)
        +
        Traversable instance of RightProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseListLeft

        +
        public final <C> List<Either<C,B>> traverseListLeft(F<A,List<C>> f)
        +
        Traversable instance of LeftProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIORight

        +
        public final <C> IO<Either<A,C>> traverseIORight(F<B,IO<C>> f)
        +
        Traversable instance of RightProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIOLeft

        +
        public final <C> IO<Either<C,B>> traverseIOLeft(F<A,IO<C>> f)
        +
        Traversable instance of LeftProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionRight

        +
        public final <C> Option<Either<A,C>> traverseOptionRight(F<B,Option<C>> f)
        +
        Traversable instance of RightProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionLeft

        +
        public final <C> Option<Either<C,B>> traverseOptionLeft(F<A,Option<C>> f)
        +
        Traversable instance of LeftProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamRight

        +
        public final <C> Stream<Either<A,C>> traverseStreamRight(F<B,Stream<C>> f)
        +
        Traversable instance of RightProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamLeft

        +
        public final <C> Stream<Either<C,B>> traverseStreamLeft(F<A,Stream<C>> f)
        +
        Traversable instance of LeftProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public static <A> A reduce(Either<A,A> e)
        +
        Takes an Either to its contained value within left or right.
        +
        +
        Parameters:
        +
        e - The either to reduce.
        +
        Returns:
        +
        An Either to its contained value within left or right.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A,B> Either<A,B> iif(boolean c,
+                                    F0<B> right,
+                                    F0<A> left)
        +
        If the condition satisfies, return the given A in left, otherwise, return the given B in right.
        +
        +
        Parameters:
        +
        c - The condition to test.
        +
        right - The right value to use if the condition satisfies.
        +
        left - The left value to use if the condition does not satisfy.
        +
        Returns:
        +
        A constructed either based on the given condition.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public static <A,B> List<A> lefts(List<Either<A,B>> es)
        +
        Returns all the left values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible left values.
        +
        Returns:
        +
        All the left values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public static <A,B> List<B> rights(List<Either<A,B>> es)
        +
        Returns all the right values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible right values.
        +
        Returns:
        +
        All the right values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Enumerator.html b/javadoc/4.8/functionaljava/fj/data/Enumerator.html new file mode 100644 index 0000000..ad53d3a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Enumerator.html @@ -0,0 +1,858 @@ + + + + + +Enumerator (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Enumerator<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Enumerator<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Enumerator<A>
+extends java.lang.Object
    +
    Abstracts over a type that may have a successor and/or predecessor value. This implies ordering for that type. A user + may construct an enumerator with an optimised version for plus, otherwise a default is implemented using + the given successor/predecessor implementations. +

    + For any enumerator e, the following laws must satisfy: +

      +
    • forall a. e.successor(a).forall(\t -> e.predecessor(t).forall(\z -> z == a))
      • +
    • forall a. e.predecessor(a).forall(\t -> e.successor(t).forall(\z -> z == a))
      • +
    • e.max().forall(\t -> e.successor(t).isNone)
      • +
    • e.min().forall(\t -> e.predecessor(t).isNone)
      • +
    • forall a n. e.plus(a, 0) == Some(a)
      • +
    • forall a n | n > 0. e.plus(a, n) == e.plus(a, n - 1)
      • +
    • forall a n | n < 0. e.plus(a, n) == e.plus(a, n + 1)
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEnumerator

        +
        public static final Enumerator<java.lang.Boolean> booleanEnumerator
        +
        An enumerator for boolean.
        +
        • +
      + + + +
        +
      • +

        byteEnumerator

        +
        public static final Enumerator<java.lang.Byte> byteEnumerator
        +
        An enumerator for byte.
        +
        • +
      + + + +
        +
      • +

        charEnumerator

        +
        public static final Enumerator<java.lang.Character> charEnumerator
        +
        An enumerator for char.
        +
        • +
      + + + +
        +
      • +

        doubleEnumerator

        +
        public static final Enumerator<java.lang.Double> doubleEnumerator
        +
        An enumerator for double.
        +
        • +
      + + + +
        +
      • +

        floatEnumerator

        +
        public static final Enumerator<java.lang.Float> floatEnumerator
        +
        An enumerator for float.
        +
        • +
      + + + +
        +
      • +

        intEnumerator

        +
        public static final Enumerator<java.lang.Integer> intEnumerator
        +
        An enumerator for int.
        +
        • +
      + + + +
        +
      • +

        bigintEnumerator

        +
        public static final Enumerator<java.math.BigInteger> bigintEnumerator
        +
        An enumerator for BigInteger.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEnumerator

        +
        public static final Enumerator<java.math.BigDecimal> bigdecimalEnumerator
        +
        An enumerator for BigDecimal.
        +
        • +
      + + + +
        +
      • +

        longEnumerator

        +
        public static final Enumerator<java.lang.Long> longEnumerator
        +
        An enumerator for long.
        +
        • +
      + + + +
        +
      • +

        shortEnumerator

        +
        public static final Enumerator<java.lang.Short> shortEnumerator
        +
        An enumerator for short.
        +
        • +
      + + + +
        +
      • +

        orderingEnumerator

        +
        public static final Enumerator<Ordering> orderingEnumerator
        +
        An enumerator for Ordering.
        +
        • +
      + + + +
        +
      • +

        naturalEnumerator

        +
        public static final Enumerator<Natural> naturalEnumerator
        +
        An enumerator for Natural
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        successor

        +
        public F<A,Option<A>> successor()
        +
        Returns the potential successor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential successor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        successor

        +
        public Option<A> successor(A a)
        +
        Returns the potential successor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the successor of.
        +
        Returns:
        +
        The potential successor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        predecessor

        +
        public F<A,Option<A>> predecessor()
        +
        Returns the potential predecessor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        predecessor

        +
        public Option<A> predecessor(A a)
        +
        Returns the potential predecessor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the predecessor of.
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<A> max()
        +
        Returns the maximum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The maximum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<A> min()
        +
        Returns the minimum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The minimum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,F<java.lang.Long,Option<A>>> plus()
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public F<java.lang.Long,Option<A>> plus(A a)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,Option<A>> plus(long l)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public Option<A> plus(A a,
+                      long l)
        +
        Moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A potential value after having moved the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        order

        +
        public Ord<A> order()
        +
        Returns the ordering for the enumerator.
        +
        +
        Returns:
        +
        The ordering for the enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Enumerator<B> xmap(F<A,B> f,
+                              F<B,A> g)
        +
        Invariant functor map over this enumerator.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        An enumerator after the given functions are applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream(A a)
        +
        Returns a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        Parameters:
        +
        a - A value at which to begin the stream.
        +
        Returns:
        +
        a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        • +
      + + + +
        +
      • +

        setMin

        +
        public Enumerator<A> setMin(Option<A> min)
        +
        Create a new enumerator with the given minimum value.
        +
        +
        Parameters:
        +
        min - A minimum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given minimum value.
        +
        +
        • +
      + + + +
        +
      • +

        setMax

        +
        public Enumerator<A> setMax(Option<A> max)
        +
        Create a new enumerator with the given maximum value.
        +
        +
        Parameters:
        +
        max - A maximum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given maximum value.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order,
+                                           F<A,F<java.lang.Long,Option<A>>> plus)
        +
        Construct an enumerator. `
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        plus - The function to move the enumeration a given number of times. This may be supplied for a performance + enhancement for certain types.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order)
        +
        Construct an enumerator. The plus function is derived from the successor and + predecessor.
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Eval.html b/javadoc/4.8/functionaljava/fj/data/Eval.html new file mode 100644 index 0000000..4fcd3bb --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Eval.html @@ -0,0 +1,450 @@ + + + + + +Eval (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Eval<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Eval<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Eval<A>
+extends java.lang.Object
    +
    Eval is an abstraction over different models of evaluation. + The data constructors: +
      +
    • Now - the value is evaluated immediately.
      • +
    • Later - the value is evaluated only once when it's requested (lazy evaluation).
      • +
    • Always - the value is evaluated every time when it's requested.
      • +
    + + Both Later and Always are lazy computations, while Now is eager.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/HashMap.html b/javadoc/4.8/functionaljava/fj/data/HashMap.html new file mode 100644 index 0000000..1d1bb7b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/HashMap.html @@ -0,0 +1,1116 @@ + + + + + +HashMap (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<K>
    +
    +
    +
    +
    public final class HashMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<K>
    +
    A mutable hash map providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashMap(Equal<K> e, + Hash<K> h) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity, + float loadFactor) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(java.util.Map<K,V> map) 
      HashMap(java.util.Map<K,V> map, + Equal<K> e, + Hash<K> h) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map,
+               Equal<K> e,
+               Hash<K> h)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<K> iterator()
        +
        Returns an iterator for this map's keys. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<K>
        +
        Returns:
        +
        A iterator for this map's keys.
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap()
        +
        Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        Returns:
        +
        A new hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap(Equal<K> e,
+                                         Hash<K> h)
        +
        Construct a hash map.
        +
        +
        Returns:
        +
        A new hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(K k1,
+                  K k2)
        +
        Compare two key values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        k1 - One key value to compare.
        +
        k2 - The other key value to compare.
        +
        Returns:
        +
        true if the two key values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(K k)
        +
        Compute the hash of the given key value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        k - The key value to computer the hash of.
        +
        Returns:
        +
        The hash of the given key value.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the hash map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all entries from this hash map.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this hash map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this hash map.
        +
        Returns:
        +
        true if this hash map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all key entries in this hash map.
        +
        +
        Returns:
        +
        All key entries in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this hash map.
        +
        +
        Returns:
        +
        All values in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash map has any entries.
        +
        +
        Returns:
        +
        true if this hash map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash map.
        +
        +
        Returns:
        +
        The number of entries in this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(K k,
+                V v)
        +
        Inserts the given key and value association into the hash map.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public void delete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        getDelete

        +
        public Option<V> getDelete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        Returns:
        +
        The value that was associated with the given key, if there was one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction,
+                              Equal<A> equal,
+                              Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction)
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<P2<K,V>,P2<A,B>> function)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> keyFunction,
+                                Equal<A> equal,
+                                Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> function)
        +
        • +
      + + + +
        +
      • +

        mapValues

        +
        public <B> HashMap<K,B> mapValues(F<V,B> function)
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<P2<K,V>> effect)
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public void foreach(F<P2<K,V>,Unit> function)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<P2<K,V>> toCollection()
        +
        Projects an immutable collection of this hash map.
        +
        +
        Returns:
        +
        An immutable collection of this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<P2<K,V>> toOption()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<P2<K,V>> toArray()
        +
        • +
      + + + +
        +
      • +

        toMap

        +
        public java.util.Map<K,V> toMap()
        +
        • +
      + + + +
        +
      • +

        from

        +
        @Deprecated
+public static <K,V> HashMap<K,V> from(java.lang.Iterable<P2<K,V>> entries)
        +
        Deprecated. As of release 4.5, use iterableHashMap(Iterable)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(Equal<K> eq,
+                                         Hash<K> h,
+                                         java.util.Map<K,V> map)
        +
        • +
      + + + + + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(Equal<K> equal,
+                                                           Hash<K> hash,
+                                                           P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/HashSet.html b/javadoc/4.8/functionaljava/fj/data/HashSet.html new file mode 100644 index 0000000..ec2f5c3 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/HashSet.html @@ -0,0 +1,805 @@ + + + + + +HashSet (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashSet<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashSet<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class HashSet<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashSet(Equal<A> e, + Hash<A> h) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity, + float loadFactor) +
      Construct a hash set with the given equality and hashing strategy.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> HashSet<A>arrayHashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>arrayHashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      voidclear() +
      Clear all elements from this hash set.
      +
      booleancontains(A a) +
      Determines if this hash set contains the given element.
      +
      booleandelete(A a) +
      Deletes the given element from this hash set.
      +
      static <A> HashSet<A>empty() +
      Creates an empty HashSet
      +
      static <A> HashSet<A>empty(Equal<A> e, + Hash<A> h) +
      Creates a new HashSet using the given Equal and Hash
      +
      booleaneq(A a1, + A a2) +
      Compare two values for equality using the underlying equality strategy.
      +
      static <A> HashSet<A>fromSet(java.util.Set<A> s) 
      inthash(A a) +
      Compute the hash of the given value using the underlying hashing strategy.
      +
      static <A> HashSet<A>hashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>hashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      booleanisEmpty() +
      Determines if this hash set contains any elements.
      +
      static <A> HashSet<A>iterableHashSet(Equal<A> e, + Hash<A> h, + java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      static <A> HashSet<A>iterableHashSet(java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this hash set.
      +
      static <A> HashSet<A>iteratorHashSet(Equal<A> e, + Hash<A> h, + java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      static <A> HashSet<A>iteratorHashSet(java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      voidset(A a) +
      Insert the given element into this hash set.
      +
      intsize() +
      Returns the number of entries in this hash set.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this hash set.
      +
      java.util.List<A>toJavaList() 
      java.util.Set<A>toJavaSet() 
      List<A>toList() +
      Returns a list projection of this hash set.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this hash set. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Compare two values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        a1 - One value to compare.
        +
        a2 - The other value to compare.
        +
        Returns:
        +
        true if the two values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        a - The value to computer the hash of.
        +
        Returns:
        +
        The hash of the given value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty(Equal<A> e,
+                                   Hash<A> h)
        +
        Creates a new HashSet using the given Equal and Hash
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty()
        +
        Creates an empty HashSet
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(Equal<A> e,
+                                                       Hash<A> h,
+                                                       A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(Equal<A> e,
+                                                  Hash<A> h,
+                                                  A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(A a)
        +
        Determines if this hash set contains the given element.
        +
        +
        Parameters:
        +
        a - The element to look for in this hash set.
        +
        Returns:
        +
        true if this hash set contains the given element, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(A a)
        +
        Insert the given element into this hash set.
        +
        +
        Parameters:
        +
        a - The element to insert.
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all elements from this hash set.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash set contains any elements.
        +
        +
        Returns:
        +
        true if this hash set contains no elements, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash set.
        +
        +
        Returns:
        +
        The number of entries in this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public boolean delete(A a)
        +
        Deletes the given element from this hash set.
        +
        +
        Parameters:
        +
        a - The element to delete from this hash set.
        +
        Returns:
        +
        true if this hash set contained the given element prior to deletion, false + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this hash set.
        +
        +
        Returns:
        +
        A list projection of this hash set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public java.util.Set<A> toJavaSet()
        +
        • +
      + + + +
        +
      • +

        fromSet

        +
        public static <A> HashSet<A> fromSet(java.util.Set<A> s)
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this hash set.
        +
        +
        Returns:
        +
        An immutable collection of this hash set.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/IO.html b/javadoc/4.8/functionaljava/fj/data/IO.html new file mode 100644 index 0000000..b0ebcd7 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/IO.html @@ -0,0 +1,237 @@ + + + + + +IO (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface IO<A>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - the type of the result produced by the IO
    +
    +
    +
    All Known Subinterfaces:
    +
    SafeIO<A>
    +
    +
    +
    All Known Implementing Classes:
    +
    IOW
    +
    +
    +
    +
    public interface IO<A>
    +
    IO monad for processing files
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
+throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/IOFunctions.html b/javadoc/4.8/functionaljava/fj/data/IOFunctions.html new file mode 100644 index 0000000..e3b4f84 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/IOFunctions.html @@ -0,0 +1,1011 @@ + + + + + +IOFunctions (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class IOFunctions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IOFunctions
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        closeReader

        +
        public static final F<java.io.Reader,IO<Unit>> closeReader
        +
        • +
      + + + +
        +
      • +

        ioUnit

        +
        public static final IO<Unit> ioUnit
        +
        • +
      + + + +
        +
      • +

        stdinBufferedReader

        +
        public static final java.io.BufferedReader stdinBufferedReader
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toTry

        +
        public static <A> Try0<A,java.io.IOException> toTry(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> P1<Validation<java.io.IOException,A>> p(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        fromF

        +
        public static <A> IO<A> fromF(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        fromTry

        +
        public static <A> IO<A> fromTry(Try0<A,? extends java.io.IOException> t)
        +
        • +
      + + + +
        +
      • +

        toSafe

        +
        public static <A> SafeIO<A> toSafe(IO<A> io)
        +
        Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        runSafe

        +
        public static <A> A runSafe(IO<A> io)
        +
        Run io, rethrowing any IOException wrapped in a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        closeReader

        +
        public static IO<Unit> closeReader(java.io.Reader r)
        +
        • +
      + + + + + + + +
        +
      • +

        enumFileCharChunks

        +
        public static <A> IO<Iteratee.IterV<char[],A>> enumFileCharChunks(java.io.File f,
+                                                                  Option<java.nio.charset.Charset> encoding,
+                                                                  Iteratee.IterV<char[],A> i)
        +
        An IO monad that reads char chunks from the given file and passes them to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with char chunks read from the file
        +
        +
        • +
      + + + +
        +
      • +

        enumFileChars

        +
        public static <A> IO<Iteratee.IterV<java.lang.Character,A>> enumFileChars(java.io.File f,
+                                                                          Option<java.nio.charset.Charset> encoding,
+                                                                          Iteratee.IterV<java.lang.Character,A> i)
        +
        An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with chars read from the file
        +
        +
        • +
      + + + +
        +
      • +

        bufferedReader

        +
        public static IO<java.io.BufferedReader> bufferedReader(java.io.File f,
+                                                        Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        fileReader

        +
        public static IO<java.io.Reader> fileReader(java.io.File f,
+                                            Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        bracket

        +
        public static <A,B,C> IO<C> bracket(IO<A> init,
+                                    F<A,IO<B>> fin,
+                                    F<A,IO<C>> body)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> IO<A> unit(A a)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F0<A> f)
        +
        • +
      + + + +
        +
      • +

        lineReader

        +
        public static <A> F<java.io.BufferedReader,F<Iteratee.IterV<java.lang.String,A>,IO<Iteratee.IterV<java.lang.String,A>>>> lineReader()
        +
        A function that feeds an iteratee with lines read from a BufferedReader.
        +
        • +
      + + + + + + + +
        +
      • +

        charChunkReader2

        +
        public static <A> F<java.io.Reader,F<Iteratee.IterV<java.lang.Character,A>,IO<Iteratee.IterV<java.lang.Character,A>>>> charChunkReader2()
        +
        A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size DEFAULT_BUFFER_SIZE).
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> IO<B> map(IO<A> io,
+                              F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        as

        +
        public static <A,B> IO<B> as(IO<A> io,
+                             B b)
        +
        • +
      + + + +
        +
      • +

        voided

        +
        public static <A> IO<Unit> voided(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> IO<B> bind(IO<A> io,
+                               F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        when

        +
        public static IO<Unit> when(java.lang.Boolean b,
+                            IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        unless

        +
        public static IO<Unit> unless(java.lang.Boolean b,
+                              IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<List<A>> sequence(List<IO<A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<Stream<A>> sequence(Stream<IO<A>> stream)
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> IO<A> join(IO<IO<A>> io1)
        +
        • +
      + + + +
        +
      • +

        toSafeValidation

        +
        public static <A> SafeIO<Validation<java.io.IOException,A>> toSafeValidation(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B> IO<B> append(IO<A> io1,
+                                 IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        left

        +
        public static <A,B> IO<A> left(IO<A> io1,
+                               IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> IO<B> flatMap(IO<A> io,
+                                  F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        interactWhile

        +
        public static IO<Unit> interactWhile(F<java.lang.String,java.lang.Boolean> condition,
+                                     F<java.lang.String,java.lang.String> transform)
        +
        Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
        +
        +
        Parameters:
        +
        condition - Read lines until a line does not satisfy condition
        +
        transform - Function to change line value
        +
        +
        • +
      + + + +
        +
      • +

        sequenceWhileEager

        +
        public static <A> IO<Stream<A>> sequenceWhileEager(Stream<IO<A>> stream,
+                                                   F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        sequenceWhile

        +
        public static <A> IO<Stream<A>> sequenceWhile(Stream<IO<A>> stream,
+                                              F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> IO<B> apply(IO<A> io,
+                                IO<F<A,B>> iof)
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> IO<C> liftM2(IO<A> ioa,
+                                   IO<B> iob,
+                                   F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        replicateM

        +
        public static <A> IO<List<A>> replicateM(IO<A> ioa,
+                                         int n)
        +
        • +
      + + + +
        +
      • +

        readerState

        +
        public static <A> IO<State<java.io.BufferedReader,Validation<java.io.IOException,java.lang.String>>> readerState()
        +
        • +
      + + + +
        +
      • +

        stdinReadLine

        +
        public static IO<java.lang.String> stdinReadLine()
        +
        • +
      + + + +
        +
      • +

        stdoutPrintln

        +
        public static IO<Unit> stdoutPrintln(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        stdoutPrint

        +
        public static IO<Unit> stdoutPrint(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public static IO<LazyString> getContents()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/IOW.html b/javadoc/4.8/functionaljava/fj/data/IOW.html new file mode 100644 index 0000000..97d0567 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/IOW.html @@ -0,0 +1,339 @@ + + + + + +IOW (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class IOW<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IOW<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IO<A>
    +
    +
    +
    +
    public final class IOW<A>
+extends java.lang.Object
+implements IO<A>
    +
    Created by MarkPerry on 9/06/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lift

        +
        public static <A> IOW<A> lift(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        run

        +
        public A run()
+      throws java.io.IOException
        +
        +
        Specified by:
        +
        run in interface IO<A>
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        public <B> IOW<B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> IOW<B> bind(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        append

        +
        public <B> IOW<B> append(IO<B> iob)
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public static IOW<LazyString> getContents()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/IterableW.html b/javadoc/4.8/functionaljava/fj/data/IterableW.html new file mode 100644 index 0000000..d81e481 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/IterableW.html @@ -0,0 +1,851 @@ + + + + + +IterableW (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class IterableW<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IterableW<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class IterableW<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A wrapper for Iterable that equips it with some useful functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> IterableW<B>apply(java.lang.Iterable<F<A,B>> f) +
      Performs function application within an iterable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,IterableW<B>>>arrow() +
      Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
      +
      static <A,B,T extends java.lang.Iterable<B>>
      F<IterableW<A>,F<F<A,T>,IterableW<B>>>      		bind() +
      The first-class bind function over Iterable.
      +
      <B,T extends java.lang.Iterable<B>>
      IterableW<B>      		bind(F<A,T> f) +
      Binds the given function across the wrapped Iterable with a final join.
      +
      static <A,B,C> IterableW<C>bind(java.lang.Iterable<A> a, + java.lang.Iterable<B> b, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given iterables with a final join.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      The catamorphism for Iterables, implemented as a left fold.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) +
      The catamorphism for Iterables, implemented as a right fold.
      +
      static <A> IterableW<A>iterable(A a) +
      Returns an Iterable that completely preserves the argument.
      +
      static <A,B> F<A,IterableW<B>>iterable(F<A,B> f) +
      Wraps a given function's return value in a Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      F<java.lang.Iterable<T>,IterableW<A>>      		join() +
      Returns a function that joins an Iterable of Iterables into a single Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<A>      		join(java.lang.Iterable<T> as) +
      Joins an Iterable of Iterables into a single Iterable.
      +
      static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on iterables.
      +
      static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>>map() +
      Returns a function that promotes any function so that it operates on Iterables.
      +
      <B> IterableW<B>map(F<A,B> f) +
      Maps a given function across the wrapped Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<IterableW<A>>      		sequence(java.lang.Iterable<T> as) +
      Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
      +
      java.util.List<A>toStandardList() +
      Returns a java.util.List implementation for this iterable.
      +
      Option<Zipper<A>>toZipper() 
      static <A,T extends java.lang.Iterable<A>>
      F<T,IterableW<A>>      		wrap() +
      Provides a function that wraps the given iterable.
      +
      static <A> IterableW<A>wrap(java.lang.Iterable<A> a) +
      Wraps the given iterable.
      +
      <B> IterableW<B>zapp(java.lang.Iterable<F<A,B>> fs) +
      Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
      +
      <B> java.lang.Iterable<P2<A,B>>zip(java.lang.Iterable<B> bs) +
      Zips this iterable with the given iterable to produce a iterable of pairs.
      +
      java.lang.Iterable<P2<A,java.lang.Integer>>zipIndex() +
      Zips this iterable with the index of its element as a pair.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F2<A,B,C> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wrap

        +
        public static <A> IterableW<A> wrap(java.lang.Iterable<A> a)
        +
        Wraps the given iterable.
        +
        +
        Parameters:
        +
        a - The iterable to wrap.
        +
        Returns:
        +
        An iterable equipped with some useful functions.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A,T extends java.lang.Iterable<A>> F<T,IterableW<A>> wrap()
        +
        Provides a function that wraps the given iterable.
        +
        +
        Returns:
        +
        A function that returns the given iterable, wrapped.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterable

        +
        public static <A> IterableW<A> iterable(A a)
        +
        Returns an Iterable that completely preserves the argument. The unit function for Iterables.
        +
        +
        Parameters:
        +
        a - A value to preserve in an Iterable.
        +
        Returns:
        +
        An Iterable that yields the argument when iterated over.
        +
        +
        • +
      + + + +
        +
      • +

        iterable

        +
        public static <A,B> F<A,IterableW<B>> iterable(F<A,B> f)
        +
        Wraps a given function's return value in a Iterable. + The Kleisli arrow for Iterables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Iterable.
        +
        Returns:
        +
        The equivalent function whose return value is iterable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,IterableW<B>>> arrow()
        +
        Provides a transformation from a function to a Iterable-valued function that is equivalent to it. + The first-class Kleisli arrow for Iterables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Iterable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,T extends java.lang.Iterable<B>> IterableW<B> bind(F<A,T> f)
        +
        Binds the given function across the wrapped Iterable with a final join.
        +
        +
        Parameters:
        +
        f - A function to bind across the Iterable.
        +
        Returns:
        +
        an iterable result of binding the given function over the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> IterableW<B> apply(java.lang.Iterable<F<A,B>> f)
        +
        Performs function application within an iterable (applicative functor pattern).
        +
        +
        Parameters:
        +
        f - The iterable function to apply.
        +
        Returns:
        +
        A new iterable after applying the given iterable function to the wrapped iterable.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> IterableW<C> bind(java.lang.Iterable<A> a,
+                                        java.lang.Iterable<B> b,
+                                        F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given iterables with a final join.
        +
        +
        Parameters:
        +
        a - A given iterable to bind the given function with.
        +
        b - A given iterable to bind the given function with.
        +
        f - The function to apply to the values in the given iterables.
        +
        Returns:
        +
        A new iterable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on iterables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over iterables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<IterableW<A>> sequence(java.lang.Iterable<T> as)
        +
        Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable. + This implementation is strict and requires O(n) stack space.
        +
        +
        Parameters:
        +
        as - The iterable of iterables to transform.
        +
        Returns:
        +
        A iterable of iterables containing the results of the bind operations across all given iterables.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,T extends java.lang.Iterable<B>> F<IterableW<A>,F<F<A,T>,IterableW<B>>> bind()
        +
        The first-class bind function over Iterable. + Returns a function that binds a given function across a given iterable.
        +
        +
        Returns:
        +
        a function that binds a given function across a given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<A> join(java.lang.Iterable<T> as)
        +
        Joins an Iterable of Iterables into a single Iterable.
        +
        +
        Parameters:
        +
        as - An Iterable of Iterables to join.
        +
        Returns:
        +
        the joined Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> F<java.lang.Iterable<T>,IterableW<A>> join()
        +
        Returns a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        Returns:
        +
        a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> IterableW<B> map(F<A,B> f)
        +
        Maps a given function across the wrapped Iterable.
        +
        +
        Parameters:
        +
        f - A function to map across the wrapped Iterable.
        +
        Returns:
        +
        An Iterable of the results of mapping the given function across the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>> map()
        +
        Returns a function that promotes any function so that it operates on Iterables.
        +
        +
        Returns:
        +
        a function that promotes any function so that it operates on Iterables.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B z)
        +
        The catamorphism for Iterables, implemented as a left fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied first (leftmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        The catamorphism for Iterables, implemented as a right fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied last (rightmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this iterable.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public <B> IterableW<B> zapp(java.lang.Iterable<F<A,B>> fs)
        +
        Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable. The iteration is normalised + so that it ends when one of the iterators is exhausted.
        +
        +
        Parameters:
        +
        fs - The iterable of functions to apply to this iterable.
        +
        Returns:
        +
        A new iterable with the results of applying the functions to this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F2<A,B,C> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> java.lang.Iterable<P2<A,B>> zip(java.lang.Iterable<B> bs)
        +
        Zips this iterable with the given iterable to produce a iterable of pairs. If this iterable and the + given iterable have different lengths, then the longer iterable is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public java.lang.Iterable<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this iterable with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new iterable with the same length as this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        toStandardList

        +
        public java.util.List<A> toStandardList()
        +
        Returns a java.util.List implementation for this iterable. + The returned list cannot be modified.
        +
        +
        Returns:
        +
        An immutable implementation of java.util.List for this iterable.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Iteratee.Input.html b/javadoc/4.8/functionaljava/fj/data/Iteratee.Input.html new file mode 100644 index 0000000..f78189f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Iteratee.Input.html @@ -0,0 +1,294 @@ + + + + + +Iteratee.Input (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.Input<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.Input<E>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.Input<E>
+extends java.lang.Object
    +
    The input to an iteratee.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public abstract <Z> Z apply(F0<Z> empty,
+                            F0<F<E,Z>> el,
+                            F0<Z> eof)
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <E> Iteratee.Input<E> empty()
        +
        Input that has no values available
        +
        • +
      + + + +
        +
      • +

        eof

        +
        public static <E> Iteratee.Input<E> eof()
        +
        Input that is exhausted
        +
        • +
      + + + + + +
        +
      • +

        el

        +
        public static <E> Iteratee.Input<E> el(E element)
        +
        Input that has a value available
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Iteratee.IterV.html b/javadoc/4.8/functionaljava/fj/data/Iteratee.IterV.html new file mode 100644 index 0000000..2430715 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Iteratee.IterV.html @@ -0,0 +1,389 @@ + + + + + +Iteratee.IterV (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.IterV<E,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.IterV<E,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.IterV<E,A>
+extends java.lang.Object
    +
    A pure iteratee computation which is either done or needs more input
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Iteratee.html b/javadoc/4.8/functionaljava/fj/data/Iteratee.html new file mode 100644 index 0000000..897aacd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Iteratee.html @@ -0,0 +1,222 @@ + + + + + +Iteratee (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Iteratee
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Iteratee.Input<E> +
      The input to an iteratee.
      +
      static class Iteratee.IterV<E,A> +
      A pure iteratee computation which is either done or needs more input
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Java.html b/javadoc/4.8/functionaljava/fj/data/Java.html new file mode 100644 index 0000000..6a1d3a4 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Java.html @@ -0,0 +1,3647 @@ + + + + + +Java (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Java

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java
+extends java.lang.Object
    +
    Functions that convert between types from the core Java API.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<Array<java.lang.Boolean>,java.util.BitSet>Array_BitSet +
      A function that converts arrays to bit sets.
      +
      static F<java.util.BitSet,List<java.lang.Boolean>>BitSet_List +
      A function that converts bit sets to lists.
      +
      static F<List<java.lang.Boolean>,java.util.BitSet>List_BitSet +
      A function that converts lists to bit sets.
      +
      static F<Option<java.lang.Boolean>,java.util.BitSet>Option_BitSet +
      A function that converts options to bit sets.
      +
      static F<Stream<java.lang.Boolean>,java.util.BitSet>Stream_BitSet +
      A function that converts streams to bit sets.
      +
      static F<java.lang.String,java.util.ArrayList<java.lang.Character>>String_ArrayList +
      A function that converts strings to array lists.
      +
      static F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>String_ConcurrentLinkedQueue +
      A function that converts strings to concurrent linked queues.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>String_CopyOnWriteArrayList +
      A function that converts strings to copy on write array lists.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>String_CopyOnWriteArraySet +
      A function that converts strings to copy on write array sets.
      +
      static F<java.lang.String,java.util.HashSet<java.lang.Character>>String_HashSet +
      A function that converts strings to hash sets.
      +
      static F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>String_LinkedBlockingQueue +
      A function that converts strings to linked blocking queues.
      +
      static F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>>String_LinkedHashSet +
      A function that converts strings to linked hash sets.
      +
      static F<java.lang.String,java.util.LinkedList<java.lang.Character>>String_LinkedList +
      A function that converts strings to linked lists.
      +
      static F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>String_PriorityBlockingQueue +
      A function that converts strings to priority blocking queues.
      +
      static F<java.lang.String,java.util.PriorityQueue<java.lang.Character>>String_PriorityQueue +
      A function that converts strings to priority queues.
      +
      static F<java.lang.String,java.util.Stack<java.lang.Character>>String_Stack +
      A function that converts strings to stacks.
      +
      static F<java.lang.String,java.util.TreeSet<java.lang.Character>>String_TreeSet +
      A function that converts strings to tree sets.
      +
      static F<java.lang.String,java.util.Vector<java.lang.Character>>String_Vector +
      A function that converts strings to vectors.
      +
      static F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>>StringBuffer_ArrayList +
      A function that converts string buffers to array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuffer_ConcurrentLinkedQueue +
      A function that converts string buffers to concurrent linked queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuffer_CopyOnWriteArrayList +
      A function that converts string buffers to copy on write array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuffer_CopyOnWriteArraySet +
      A function that converts string buffers to copy on write array sets.
      +
      static F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>>StringBuffer_HashSet +
      A function that converts string buffers to hash sets.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuffer_LinkedBlockingQueue +
      A function that converts string buffers to linked blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>>StringBuffer_LinkedHashSet +
      A function that converts string buffers to linked hash sets.
      +
      static F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>>StringBuffer_LinkedList +
      A function that converts string buffers to linked lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuffer_PriorityBlockingQueue +
      A function that converts string buffers to priority blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>>StringBuffer_PriorityQueue +
      A function that converts string buffers to priority queues.
      +
      static F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>>StringBuffer_Stack +
      A function that converts string buffers to stacks.
      +
      static F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>>StringBuffer_TreeSet +
      A function that converts string buffers to tree sets.
      +
      static F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>>StringBuffer_Vector +
      A function that converts string buffers to vectors.
      +
      static F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>>StringBuilder_ArrayList +
      A function that converts string builders to array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuilder_ConcurrentLinkedQueue +
      A function that converts string builders to concurrent linked queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuilder_CopyOnWriteArrayList +
      A function that converts string builders to copy on write array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuilder_CopyOnWriteArraySet +
      A function that converts string builders to copy on write array sets.
      +
      static F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>>StringBuilder_HashSet +
      A function that converts string builders to hash sets.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuilder_LinkedBlockingQueue +
      A function that converts string builders to linked blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>>StringBuilder_LinkedHashSet +
      A function that converts string builders to linked hash sets.
      +
      static F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>>StringBuilder_LinkedList +
      A function that converts string builders to linked lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuilder_PriorityBlockingQueue +
      A function that converts string builders to priority blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>>StringBuilder_PriorityQueue +
      A function that converts string builders to priority queues.
      +
      static F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>>StringBuilder_Stack +
      A function that converts string builders to stacks.
      +
      static F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>>StringBuilder_TreeSet +
      A function that converts string builders to tree sets.
      +
      static F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>>StringBuilder_Vector +
      A function that converts string builders to vectors.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>>Array_ArrayBlockingQueue(boolean fair) +
      A function that converts arrays to array blocking queues.
      +
      static <A> F<Array<A>,java.util.ArrayList<A>>Array_ArrayList() +
      A function that converts arrays to array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Array_ConcurrentLinkedQueue() +
      A function that converts arrays to concurrent linked queues.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Array_CopyOnWriteArrayList() +
      A function that converts arrays to copy on write array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Array_CopyOnWriteArraySet() +
      A function that converts arrays to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Array<A>,java.util.concurrent.DelayQueue<A>>      		Array_DelayQueue() +
      A function that converts arrays to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Array<A>,java.util.EnumSet<A>>      		Array_EnumSet() +
      A function that converts arrays to enum sets.
      +
      static <A> F<Array<A>,java.util.HashSet<A>>Array_HashSet() +
      A function that converts arrays to hash sets.
      +
      static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>>Array_LinkedBlockingQueue() +
      A function that converts arrays to linked blocking queues.
      +
      static <A> F<Array<A>,java.util.LinkedHashSet<A>>Array_LinkedHashSet() +
      A function that converts arrays to linked hash sets.
      +
      static <A> F<Array<A>,java.util.LinkedList<A>>Array_LinkedList() +
      A function that converts arrays to linked lists.
      +
      static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>>Array_PriorityBlockingQueue() +
      A function that converts arrays to priority blocking queues.
      +
      static <A> F<Array<A>,java.util.PriorityQueue<A>>Array_PriorityQueue() +
      A function that converts arrays to priority queues.
      +
      static <A> F<Array<A>,java.util.Stack<A>>Array_Stack() +
      A function that converts arrays to stacks.
      +
      static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>>Array_SynchronousQueue(boolean fair) +
      A function that converts arrays to synchronous queues.
      +
      static <A> F<Array<A>,java.util.TreeSet<A>>Array_TreeSet() +
      A function that converts arrays to tree sets.
      +
      static <A> F<Array<A>,java.util.Vector<A>>Array_Vector() +
      A function that converts arrays to vectors.
      +
      static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>>ArrayBlockingQueue_List() +
      A function that converts array blocking queues to lists.
      +
      static <A> F<java.util.ArrayList<A>,List<A>>ArrayList_List() +
      A function that converts array lists to lists.
      +
      static <A> F<java.util.Collection<A>,List<A>>Collection_List() 
      static <A> List<A>Collection_List(java.util.Collection<A> c) 
      static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>>ConcurrentLinkedQueue_List() +
      A function that converts concurrent linked queues to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>>CopyOnWriteArrayList_List() +
      A function that converts copy on write array lists to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>>CopyOnWriteArraySet_List() +
      A function that converts copy on write array sets to lists.
      +
      static <A extends java.util.concurrent.Delayed>
      F<java.util.concurrent.DelayQueue<A>,List<A>>      		DelayQueue_List() +
      A function that converts delay queues to lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>>Either_ArrayBlockingQueueA(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>>Either_ArrayBlockingQueueB(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<A>>Either_ArrayListA() +
      A function that converts eithers to array lists.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<B>>Either_ArrayListB() +
      A function that converts eithers to array lists.
      +
      static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet>Either_BitSetA() +
      A function that converts eithers to bit sets.
      +
      static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet>Either_BitSetB() +
      A function that converts eithers to bit sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>>Either_ConcurrentLinkedQueueA() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>>Either_ConcurrentLinkedQueueB() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>>Either_CopyOnWriteArrayListA() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>>Either_CopyOnWriteArrayListB() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>>Either_CopyOnWriteArraySetA() +
      A function that converts eithers to copy on write array sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>>Either_CopyOnWriteArraySetB() +
      A function that converts eithers to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed,B>
      F<Either<A,B>,java.util.concurrent.DelayQueue<A>>      		Either_DelayQueueA() +
      A function that converts eithers to delay queues.
      +
      static <A,B extends java.util.concurrent.Delayed>
      F<Either<A,B>,java.util.concurrent.DelayQueue<B>>      		Either_DelayQueueB() +
      A function that converts eithers to delay queues.
      +
      static <A extends java.lang.Enum<A>,B>
      F<Either<A,B>,java.util.EnumSet<A>>      		Either_EnumSetA() +
      A function that converts eithers to enum sets.
      +
      static <A,B extends java.lang.Enum<B>>
      F<Either<A,B>,java.util.EnumSet<B>>      		Either_EnumSetB() +
      A function that converts eithers to enum sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<A>>Either_HashSetA() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<B>>Either_HashSetB() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>>Either_LinkedBlockingQueueA() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>>Either_LinkedBlockingQueueB() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>>Either_LinkedHashSetA() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>>Either_LinkedHashSetB() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<A>>Either_LinkedListA() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<B>>Either_LinkedListB() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>>Either_PriorityBlockingQueueA() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>>Either_PriorityBlockingQueueB() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<A>>Either_StackA() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<B>>Either_StackB() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>>Either_SynchronousQueueA(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>>Either_SynchronousQueueB(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<A>>Either_TreeSetA() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<B>>Either_TreeSetB() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<A>>Either_VectorA() +
      A function that converts eithers to vectors.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<B>>Either_VectorB() +
      A function that converts eithers to vectors.
      +
      static <A extends java.lang.Enum<A>>
      F<java.util.EnumSet<A>,List<A>>      		EnumSet_List() +
      A function that converts enum sets to lists.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>>Future_P1() 
      static <A> F<java.util.HashSet<A>,List<A>>HashSet_List() +
      A function that converts hash sets to lists.
      +
      static <A> F<java.util.List<A>,List<A>>JavaList_List() 
      static <A> List<A>JavaList_List(java.util.List<A> list) 
      static <A> F<java.util.List<A>,List<A>>JUList_List() +
      Deprecated.  +
      As of 4.3, use JavaList_List()
      +
      +
      static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>>LinkedBlockingQueue_List() +
      A function that converts linked blocking queues to lists.
      +
      static <A> F<java.util.LinkedHashSet<A>,List<A>>LinkedHashSet_List() +
      A function that converts linked hash sets to lists.
      +
      static <A> F<java.util.LinkedList<A>,List<A>>LinkedList_List() +
      A function that converts linked lists to lists.
      +
      static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>>List_ArrayBlockingQueue(boolean fair) +
      A function that converts lists to array blocking queue.
      +
      static <A> F<List<A>,java.util.ArrayList<A>>List_ArrayList() +
      A function that converts lists to array lists.
      +
      static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>List_ConcurrentLinkedQueue() +
      A function that converts lists to concurrent linked queues.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>>List_CopyOnWriteArrayList() +
      A function that converts lists to copy on write array lists.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>>List_CopyOnWriteArraySet() +
      A function that converts lists to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<List<A>,java.util.concurrent.DelayQueue<A>>      		List_DelayQueue() +
      A function that converts lists to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<List<A>,java.util.EnumSet<A>>      		List_EnumSet() +
      A function that converts lists to array enum sets.
      +
      static <A> F<List<A>,java.util.HashSet<A>>List_HashSet() +
      A function that converts lists to hash sets.
      +
      static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>>List_LinkedBlockingQueue() +
      A function that converts lists to linked blocking queues.
      +
      static <A> F<List<A>,java.util.LinkedHashSet<A>>List_LinkedHashSet() +
      A function that converts lists to linked hash sets.
      +
      static <A> F<List<A>,java.util.LinkedList<A>>List_LinkedList() +
      A function that converts lists to linked lists.
      +
      static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>>List_PriorityBlockingQueue() +
      A function that converts lists to priority blocking queues.
      +
      static <A> F<List<A>,java.util.PriorityQueue<A>>List_PriorityQueue() +
      A function that converts lists to priority queues.
      +
      static <A> F<List<A>,java.util.Stack<A>>List_Stack() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>>List_SynchronousQueue(boolean fair) +
      A function that converts lists to synchronous queues.
      +
      static <A> F<List<A>,java.util.TreeSet<A>>List_TreeSet() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.Vector<A>>List_Vector() +
      A function that converts lists to vectors.
      +
      static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>>Option_ArrayBlockingQueue(boolean fair) +
      A function that converts options to array blocking queues.
      +
      static <A> F<Option<A>,java.util.ArrayList<A>>Option_ArrayList() +
      A function that converts options to array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Option_ConcurrentLinkedQueue() +
      A function that converts options to concurrent linked queues.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Option_CopyOnWriteArrayList() +
      A function that converts options to copy on write array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Option_CopyOnWriteArraySet() +
      A function that converts options to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Option<A>,java.util.concurrent.DelayQueue<A>>      		Option_DelayQueue() +
      A function that converts options to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Option<A>,java.util.EnumSet<A>>      		Option_EnumSet() +
      A function that converts options to enum sets.
      +
      static <A> F<Option<A>,java.util.HashSet<A>>Option_HashSet() +
      A function that converts options to hash sets.
      +
      static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>>Option_LinkedBlockingQueue() +
      A function that converts options to linked blocking queues.
      +
      static <A> F<Option<A>,java.util.LinkedHashSet<A>>Option_LinkedHashSet() +
      A function that converts options to linked hash sets.
      +
      static <A> F<Option<A>,java.util.LinkedList<A>>Option_LinkedList() +
      A function that converts options to linked lists.
      +
      static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>>Option_PriorityBlockingQueue() +
      A function that converts options to priority blocking queues.
      +
      static <A> F<Option<A>,java.util.PriorityQueue<A>>Option_PriorityQueue() +
      A function that converts options to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>>Option_PriorityQueueA() +
      A function that converts eithers to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>>Option_PriorityQueueB() +
      A function that converts eithers to priority queues.
      +
      static <A> F<Option<A>,java.util.Stack<A>>Option_Stack() +
      A function that converts options to stacks.
      +
      static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>>Option_SynchronousQueue(boolean fair) +
      A function that converts options to synchronous queues.
      +
      static <A> F<Option<A>,java.util.TreeSet<A>>Option_TreeSet() +
      A function that converts options to tree sets.
      +
      static <A> F<Option<A>,java.util.Vector<A>>Option_Vector() +
      A function that converts options to vectors.
      +
      static <A> F<P1<A>,java.util.concurrent.Callable<A>>P1_Callable() 
      static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>>PriorityBlockingQueue_List() +
      A function that converts priority blocking queues to lists.
      +
      static <A> F<java.util.PriorityQueue<A>,List<A>>PriorityQueue_List() +
      A function that converts priority queues to lists.
      +
      static <A> F<java.util.Stack<A>,List<A>>Stack_List() +
      A function that converts stacks to lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>>Stream_ArrayBlockingQueue(boolean fair) +
      A function that converts streams to array blocking queues.
      +
      static <A> F<Stream<A>,java.util.ArrayList<A>>Stream_ArrayList() +
      A function that converts streams to array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Stream_ConcurrentLinkedQueue() +
      A function that converts streams to concurrent linked queues.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Stream_CopyOnWriteArrayList() +
      A function that converts streams to copy on write array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Stream_CopyOnWriteArraySet() +
      A function that converts streams to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Stream<A>,java.util.concurrent.DelayQueue<A>>      		Stream_DelayQueue() +
      A function that converts streams to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Stream<A>,java.util.EnumSet<A>>      		Stream_EnumSet() +
      A function that converts streams to enum sets.
      +
      static <A> F<Stream<A>,java.util.HashSet<A>>Stream_HashSet() +
      A function that converts streams to hash sets.
      +
      static <A> F<Stream<A>,java.lang.Iterable<A>>Stream_Iterable() +
      A function that converts streams to iterable.
      +
      static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>>Stream_LinkedBlockingQueue() +
      A function that converts streams to linked blocking queues.
      +
      static <A> F<Stream<A>,java.util.LinkedHashSet<A>>Stream_LinkedHashSet() +
      A function that converts streams to linked hash sets.
      +
      static <A> F<Stream<A>,java.util.LinkedList<A>>Stream_LinkedList() +
      A function that converts streams to linked lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>>Stream_PriorityBlockingQueue() +
      A function that converts streams to priority blocking queues.
      +
      static <A> F<Stream<A>,java.util.PriorityQueue<A>>Stream_PriorityQueue() +
      A function that converts streams to priority queues.
      +
      static <A> F<Stream<A>,java.util.Stack<A>>Stream_Stack() +
      A function that converts streams to stacks.
      +
      static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>>Stream_SynchronousQueue(boolean fair) +
      A function that converts streams to synchronous queues.
      +
      static <A> F<Stream<A>,java.util.TreeSet<A>>Stream_TreeSet() +
      A function that converts streams to tree sets.
      +
      static <A> F<Stream<A>,java.util.Vector<A>>Stream_Vector() +
      A function that converts streams to vectors.
      +
      static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>String_ArrayBlockingQueue(boolean fair) +
      A function that converts strings to array blocking queues.
      +
      static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>>String_SynchronousQueue(boolean fair) +
      A function that converts strings to synchronous queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuffer_ArrayBlockingQueue(boolean fair) +
      A function that converts string buffers to array blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuffer_SynchronousQueue(boolean fair) +
      A function that converts string buffers to synchronous queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuilder_ArrayBlockingQueue(boolean fair) +
      A function that converts string builders to array blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuilder_SynchronousQueue(boolean fair) +
      A function that converts string builders to synchronous queues.
      +
      static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>>SynchronousQueue_List() +
      A function that converts synchronous queues to lists.
      +
      static <A> F<java.util.TreeSet<A>,List<A>>TreeSet_List() +
      A function that converts tree sets to lists.
      +
      static <A> F<java.util.Vector<A>,List<A>>Vector_List() +
      A function that converts vectors to lists.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        List_BitSet

        +
        public static final F<List<java.lang.Boolean>,java.util.BitSet> List_BitSet
        +
        A function that converts lists to bit sets.
        +
        • +
      + + + +
        +
      • +

        Array_BitSet

        +
        public static final F<Array<java.lang.Boolean>,java.util.BitSet> Array_BitSet
        +
        A function that converts arrays to bit sets.
        +
        • +
      + + + +
        +
      • +

        Stream_BitSet

        +
        public static final F<Stream<java.lang.Boolean>,java.util.BitSet> Stream_BitSet
        +
        A function that converts streams to bit sets.
        +
        • +
      + + + +
        +
      • +

        Option_BitSet

        +
        public static final F<Option<java.lang.Boolean>,java.util.BitSet> Option_BitSet
        +
        A function that converts options to bit sets.
        +
        • +
      + + + +
        +
      • +

        String_ArrayList

        +
        public static final F<java.lang.String,java.util.ArrayList<java.lang.Character>> String_ArrayList
        +
        A function that converts strings to array lists.
        +
        • +
      + + + +
        +
      • +

        String_HashSet

        +
        public static final F<java.lang.String,java.util.HashSet<java.lang.Character>> String_HashSet
        +
        A function that converts strings to hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedHashSet

        +
        public static final F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>> String_LinkedHashSet
        +
        A function that converts strings to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedList

        +
        public static final F<java.lang.String,java.util.LinkedList<java.lang.Character>> String_LinkedList
        +
        A function that converts strings to linked lists.
        +
        • +
      + + + +
        +
      • +

        String_PriorityQueue

        +
        public static final F<java.lang.String,java.util.PriorityQueue<java.lang.Character>> String_PriorityQueue
        +
        A function that converts strings to priority queues.
        +
        • +
      + + + +
        +
      • +

        String_Stack

        +
        public static final F<java.lang.String,java.util.Stack<java.lang.Character>> String_Stack
        +
        A function that converts strings to stacks.
        +
        • +
      + + + +
        +
      • +

        String_TreeSet

        +
        public static final F<java.lang.String,java.util.TreeSet<java.lang.Character>> String_TreeSet
        +
        A function that converts strings to tree sets.
        +
        • +
      + + + +
        +
      • +

        String_Vector

        +
        public static final F<java.lang.String,java.util.Vector<java.lang.Character>> String_Vector
        +
        A function that converts strings to vectors.
        +
        • +
      + + + +
        +
      • +

        String_ConcurrentLinkedQueue

        +
        public static final F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> String_ConcurrentLinkedQueue
        +
        A function that converts strings to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArrayList

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> String_CopyOnWriteArrayList
        +
        A function that converts strings to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArraySet

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> String_CopyOnWriteArraySet
        +
        A function that converts strings to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> String_LinkedBlockingQueue
        +
        A function that converts strings to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        String_PriorityBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> String_PriorityBlockingQueue
        +
        A function that converts strings to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>> StringBuffer_ArrayList
        +
        A function that converts string buffers to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_HashSet

        +
        public static final F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>> StringBuffer_HashSet
        +
        A function that converts string buffers to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedHashSet

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>> StringBuffer_LinkedHashSet
        +
        A function that converts string buffers to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedList

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>> StringBuffer_LinkedList
        +
        A function that converts string buffers to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityQueue

        +
        public static final F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>> StringBuffer_PriorityQueue
        +
        A function that converts string buffers to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stack

        +
        public static final F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>> StringBuffer_Stack
        +
        A function that converts string buffers to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_TreeSet

        +
        public static final F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>> StringBuffer_TreeSet
        +
        A function that converts string buffers to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Vector

        +
        public static final F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>> StringBuffer_Vector
        +
        A function that converts string buffers to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuffer_ConcurrentLinkedQueue
        +
        A function that converts string buffers to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuffer_CopyOnWriteArrayList
        +
        A function that converts string buffers to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuffer_CopyOnWriteArraySet
        +
        A function that converts string buffers to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuffer_LinkedBlockingQueue
        +
        A function that converts string buffers to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuffer_PriorityBlockingQueue
        +
        A function that converts string buffers to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>> StringBuilder_ArrayList
        +
        A function that converts string builders to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_HashSet

        +
        public static final F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>> StringBuilder_HashSet
        +
        A function that converts string builders to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedHashSet

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>> StringBuilder_LinkedHashSet
        +
        A function that converts string builders to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedList

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>> StringBuilder_LinkedList
        +
        A function that converts string builders to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityQueue

        +
        public static final F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>> StringBuilder_PriorityQueue
        +
        A function that converts string builders to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stack

        +
        public static final F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>> StringBuilder_Stack
        +
        A function that converts string builders to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_TreeSet

        +
        public static final F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>> StringBuilder_TreeSet
        +
        A function that converts string builders to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Vector

        +
        public static final F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>> StringBuilder_Vector
        +
        A function that converts string builders to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuilder_ConcurrentLinkedQueue
        +
        A function that converts string builders to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuilder_CopyOnWriteArrayList
        +
        A function that converts string builders to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuilder_CopyOnWriteArraySet
        +
        A function that converts string builders to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuilder_LinkedBlockingQueue
        +
        A function that converts string builders to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuilder_PriorityBlockingQueue
        +
        A function that converts string builders to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        BitSet_List

        +
        public static final F<java.util.BitSet,List<java.lang.Boolean>> BitSet_List
        +
        A function that converts bit sets to lists.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_ArrayList

        +
        public static <A> F<List<A>,java.util.ArrayList<A>> List_ArrayList()
        +
        A function that converts lists to array lists.
        +
        +
        Returns:
        +
        A function that converts lists to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<List<A>,java.util.EnumSet<A>> List_EnumSet()
        +
        A function that converts lists to array enum sets.
        +
        +
        Returns:
        +
        A function that converts lists to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_HashSet

        +
        public static <A> F<List<A>,java.util.HashSet<A>> List_HashSet()
        +
        A function that converts lists to hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedHashSet

        +
        public static <A> F<List<A>,java.util.LinkedHashSet<A>> List_LinkedHashSet()
        +
        A function that converts lists to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedList

        +
        public static <A> F<List<A>,java.util.LinkedList<A>> List_LinkedList()
        +
        A function that converts lists to linked lists.
        +
        +
        Returns:
        +
        A function that converts lists to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityQueue

        +
        public static <A> F<List<A>,java.util.PriorityQueue<A>> List_PriorityQueue()
        +
        A function that converts lists to priority queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stack

        +
        public static <A> F<List<A>,java.util.Stack<A>> List_Stack()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_TreeSet

        +
        public static <A> F<List<A>,java.util.TreeSet<A>> List_TreeSet()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_Vector

        +
        public static <A> F<List<A>,java.util.Vector<A>> List_Vector()
        +
        A function that converts lists to vectors.
        +
        +
        Returns:
        +
        A function that converts lists to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        List_ArrayBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>> List_ArrayBlockingQueue(boolean fair)
        +
        A function that converts lists to array blocking queue.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts lists to array blocking queue.
        +
        +
        • +
      + + + +
        +
      • +

        List_ConcurrentLinkedQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> List_ConcurrentLinkedQueue()
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArrayList

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>> List_CopyOnWriteArrayList()
        +
        A function that converts lists to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArraySet

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>> List_CopyOnWriteArraySet()
        +
        A function that converts lists to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<List<A>,java.util.concurrent.DelayQueue<A>> List_DelayQueue()
        +
        A function that converts lists to delay queues.
        +
        +
        Returns:
        +
        A function that converts lists to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>> List_LinkedBlockingQueue()
        +
        A function that converts lists to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>> List_PriorityBlockingQueue()
        +
        A function that converts lists to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_SynchronousQueue

        +
        public static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>> List_SynchronousQueue(boolean fair)
        +
        A function that converts lists to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts lists to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayList

        +
        public static <A> F<Array<A>,java.util.ArrayList<A>> Array_ArrayList()
        +
        A function that converts arrays to array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Array<A>,java.util.EnumSet<A>> Array_EnumSet()
        +
        A function that converts arrays to enum sets.
        +
        +
        Returns:
        +
        A function that converts arrays to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_HashSet

        +
        public static <A> F<Array<A>,java.util.HashSet<A>> Array_HashSet()
        +
        A function that converts arrays to hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedHashSet

        +
        public static <A> F<Array<A>,java.util.LinkedHashSet<A>> Array_LinkedHashSet()
        +
        A function that converts arrays to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedList

        +
        public static <A> F<Array<A>,java.util.LinkedList<A>> Array_LinkedList()
        +
        A function that converts arrays to linked lists.
        +
        +
        Returns:
        +
        A function that converts arrays to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityQueue

        +
        public static <A> F<Array<A>,java.util.PriorityQueue<A>> Array_PriorityQueue()
        +
        A function that converts arrays to priority queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stack

        +
        public static <A> F<Array<A>,java.util.Stack<A>> Array_Stack()
        +
        A function that converts arrays to stacks.
        +
        +
        Returns:
        +
        A function that converts arrays to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Array_TreeSet

        +
        public static <A> F<Array<A>,java.util.TreeSet<A>> Array_TreeSet()
        +
        A function that converts arrays to tree sets.
        +
        +
        Returns:
        +
        A function that converts arrays to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Vector

        +
        public static <A> F<Array<A>,java.util.Vector<A>> Array_Vector()
        +
        A function that converts arrays to vectors.
        +
        +
        Returns:
        +
        A function that converts arrays to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>> Array_ArrayBlockingQueue(boolean fair)
        +
        A function that converts arrays to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts arrays to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ConcurrentLinkedQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Array_ConcurrentLinkedQueue()
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArrayList

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Array_CopyOnWriteArrayList()
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArraySet

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Array_CopyOnWriteArraySet()
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Array<A>,java.util.concurrent.DelayQueue<A>> Array_DelayQueue()
        +
        A function that converts arrays to delay queues.
        +
        +
        Returns:
        +
        A function that converts arrays to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>> Array_LinkedBlockingQueue()
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>> Array_PriorityBlockingQueue()
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_SynchronousQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>> Array_SynchronousQueue(boolean fair)
        +
        A function that converts arrays to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts arrays to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Iterable

        +
        public static <A> F<Stream<A>,java.lang.Iterable<A>> Stream_Iterable()
        +
        A function that converts streams to iterable.
        +
        +
        Returns:
        +
        A function that converts streams to iterable.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayList

        +
        public static <A> F<Stream<A>,java.util.ArrayList<A>> Stream_ArrayList()
        +
        A function that converts streams to array lists.
        +
        +
        Returns:
        +
        A function that converts streams to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Stream<A>,java.util.EnumSet<A>> Stream_EnumSet()
        +
        A function that converts streams to enum sets.
        +
        +
        Returns:
        +
        A function that converts streams to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_HashSet

        +
        public static <A> F<Stream<A>,java.util.HashSet<A>> Stream_HashSet()
        +
        A function that converts streams to hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedHashSet

        +
        public static <A> F<Stream<A>,java.util.LinkedHashSet<A>> Stream_LinkedHashSet()
        +
        A function that converts streams to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedList

        +
        public static <A> F<Stream<A>,java.util.LinkedList<A>> Stream_LinkedList()
        +
        A function that converts streams to linked lists.
        +
        +
        Returns:
        +
        A function that converts streams to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityQueue

        +
        public static <A> F<Stream<A>,java.util.PriorityQueue<A>> Stream_PriorityQueue()
        +
        A function that converts streams to priority queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Stack

        +
        public static <A> F<Stream<A>,java.util.Stack<A>> Stream_Stack()
        +
        A function that converts streams to stacks.
        +
        +
        Returns:
        +
        A function that converts streams to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_TreeSet

        +
        public static <A> F<Stream<A>,java.util.TreeSet<A>> Stream_TreeSet()
        +
        A function that converts streams to tree sets.
        +
        +
        Returns:
        +
        A function that converts streams to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Vector

        +
        public static <A> F<Stream<A>,java.util.Vector<A>> Stream_Vector()
        +
        A function that converts streams to vectors.
        +
        +
        Returns:
        +
        A function that converts streams to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>> Stream_ArrayBlockingQueue(boolean fair)
        +
        A function that converts streams to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts streams to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ConcurrentLinkedQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Stream_ConcurrentLinkedQueue()
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArrayList

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Stream_CopyOnWriteArrayList()
        +
        A function that converts streams to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArraySet

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Stream_CopyOnWriteArraySet()
        +
        A function that converts streams to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Stream<A>,java.util.concurrent.DelayQueue<A>> Stream_DelayQueue()
        +
        A function that converts streams to delay queues.
        +
        +
        Returns:
        +
        A function that converts streams to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>> Stream_LinkedBlockingQueue()
        +
        A function that converts streams to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>> Stream_PriorityBlockingQueue()
        +
        A function that converts streams to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_SynchronousQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>> Stream_SynchronousQueue(boolean fair)
        +
        A function that converts streams to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts streams to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayList

        +
        public static <A> F<Option<A>,java.util.ArrayList<A>> Option_ArrayList()
        +
        A function that converts options to array lists.
        +
        +
        Returns:
        +
        A function that converts options to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Option<A>,java.util.EnumSet<A>> Option_EnumSet()
        +
        A function that converts options to enum sets.
        +
        +
        Returns:
        +
        A function that converts options to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_HashSet

        +
        public static <A> F<Option<A>,java.util.HashSet<A>> Option_HashSet()
        +
        A function that converts options to hash sets.
        +
        +
        Returns:
        +
        A function that converts options to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedHashSet

        +
        public static <A> F<Option<A>,java.util.LinkedHashSet<A>> Option_LinkedHashSet()
        +
        A function that converts options to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts options to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedList

        +
        public static <A> F<Option<A>,java.util.LinkedList<A>> Option_LinkedList()
        +
        A function that converts options to linked lists.
        +
        +
        Returns:
        +
        A function that converts options to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueue

        +
        public static <A> F<Option<A>,java.util.PriorityQueue<A>> Option_PriorityQueue()
        +
        A function that converts options to priority queues.
        +
        +
        Returns:
        +
        A function that converts options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stack

        +
        public static <A> F<Option<A>,java.util.Stack<A>> Option_Stack()
        +
        A function that converts options to stacks.
        +
        +
        Returns:
        +
        A function that converts options to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Option_TreeSet

        +
        public static <A> F<Option<A>,java.util.TreeSet<A>> Option_TreeSet()
        +
        A function that converts options to tree sets.
        +
        +
        Returns:
        +
        A function that converts options to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Vector

        +
        public static <A> F<Option<A>,java.util.Vector<A>> Option_Vector()
        +
        A function that converts options to vectors.
        +
        +
        Returns:
        +
        A function that converts options to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>> Option_ArrayBlockingQueue(boolean fair)
        +
        A function that converts options to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts options to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ConcurrentLinkedQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Option_ConcurrentLinkedQueue()
        +
        A function that converts options to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts options to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArrayList

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Option_CopyOnWriteArrayList()
        +
        A function that converts options to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArraySet

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Option_CopyOnWriteArraySet()
        +
        A function that converts options to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Option<A>,java.util.concurrent.DelayQueue<A>> Option_DelayQueue()
        +
        A function that converts options to delay queues.
        +
        +
        Returns:
        +
        A function that converts options to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>> Option_LinkedBlockingQueue()
        +
        A function that converts options to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>> Option_PriorityBlockingQueue()
        +
        A function that converts options to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_SynchronousQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>> Option_SynchronousQueue(boolean fair)
        +
        A function that converts options to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts options to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<A>> Either_ArrayListA()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<B>> Either_ArrayListB()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetA

        +
        public static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet> Either_BitSetA()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetB

        +
        public static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet> Either_BitSetB()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetA

        +
        public static <A extends java.lang.Enum<A>,B> F<Either<A,B>,java.util.EnumSet<A>> Either_EnumSetA()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetB

        +
        public static <A,B extends java.lang.Enum<B>> F<Either<A,B>,java.util.EnumSet<B>> Either_EnumSetB()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<A>> Either_HashSetA()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<B>> Either_HashSetB()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>> Either_LinkedHashSetA()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>> Either_LinkedHashSetB()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<A>> Either_LinkedListA()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>> Option_PriorityQueueA()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>> Option_PriorityQueueB()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<B>> Either_LinkedListB()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackA

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<A>> Either_StackA()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackB

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<B>> Either_StackB()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetA

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<A>> Either_TreeSetA()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetB

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<B>> Either_TreeSetB()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorA

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<A>> Either_VectorA()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorB

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<B>> Either_VectorB()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>> Either_ArrayBlockingQueueA(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>> Either_ArrayBlockingQueueB(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>> Either_ConcurrentLinkedQueueA()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>> Either_ConcurrentLinkedQueueB()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>> Either_CopyOnWriteArrayListA()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>> Either_CopyOnWriteArrayListB()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>> Either_CopyOnWriteArraySetA()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>> Either_CopyOnWriteArraySetB()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueA

        +
        public static <A extends java.util.concurrent.Delayed,B> F<Either<A,B>,java.util.concurrent.DelayQueue<A>> Either_DelayQueueA()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueB

        +
        public static <A,B extends java.util.concurrent.Delayed> F<Either<A,B>,java.util.concurrent.DelayQueue<B>> Either_DelayQueueB()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>> Either_LinkedBlockingQueueA()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>> Either_LinkedBlockingQueueB()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>> Either_PriorityBlockingQueueA()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>> Either_PriorityBlockingQueueB()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>> Either_SynchronousQueueA(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>> Either_SynchronousQueueB(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_ArrayBlockingQueue

        +
        public static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> String_ArrayBlockingQueue(boolean fair)
        +
        A function that converts strings to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts strings to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_SynchronousQueue

        +
        public static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>> String_SynchronousQueue(boolean fair)
        +
        A function that converts strings to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts strings to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuffer_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_SynchronousQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuffer_SynchronousQueue(boolean fair)
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuilder_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string builders to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string builders to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_SynchronousQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuilder_SynchronousQueue(boolean fair)
        +
        A function that converts string builders to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string builders to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayList_List

        +
        public static <A> F<java.util.ArrayList<A>,List<A>> ArrayList_List()
        +
        A function that converts array lists to lists.
        +
        +
        Returns:
        +
        A function that converts array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        JUList_List

        +
        public static <A> F<java.util.List<A>,List<A>> JUList_List()
        +
        Deprecated. As of 4.3, use JavaList_List()
        +
        A function that converts Java lists to lists.
        +
        +
        Returns:
        +
        A function that converts Java lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> F<java.util.List<A>,List<A>> JavaList_List()
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> List<A> JavaList_List(java.util.List<A> list)
        +
        • +
      + + + +
        +
      • +

        EnumSet_List

        +
        public static <A extends java.lang.Enum<A>> F<java.util.EnumSet<A>,List<A>> EnumSet_List()
        +
        A function that converts enum sets to lists.
        +
        +
        Returns:
        +
        A function that converts enum sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> List<A> Collection_List(java.util.Collection<A> c)
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> F<java.util.Collection<A>,List<A>> Collection_List()
        +
        • +
      + + + +
        +
      • +

        HashSet_List

        +
        public static <A> F<java.util.HashSet<A>,List<A>> HashSet_List()
        +
        A function that converts hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedHashSet_List

        +
        public static <A> F<java.util.LinkedHashSet<A>,List<A>> LinkedHashSet_List()
        +
        A function that converts linked hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts linked hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedList_List

        +
        public static <A> F<java.util.LinkedList<A>,List<A>> LinkedList_List()
        +
        A function that converts linked lists to lists.
        +
        +
        Returns:
        +
        A function that converts linked lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityQueue_List

        +
        public static <A> F<java.util.PriorityQueue<A>,List<A>> PriorityQueue_List()
        +
        A function that converts priority queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stack_List

        +
        public static <A> F<java.util.Stack<A>,List<A>> Stack_List()
        +
        A function that converts stacks to lists.
        +
        +
        Returns:
        +
        A function that converts stacks to lists.
        +
        +
        • +
      + + + +
        +
      • +

        TreeSet_List

        +
        public static <A> F<java.util.TreeSet<A>,List<A>> TreeSet_List()
        +
        A function that converts tree sets to lists.
        +
        +
        Returns:
        +
        A function that converts tree sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Vector_List

        +
        public static <A> F<java.util.Vector<A>,List<A>> Vector_List()
        +
        A function that converts vectors to lists.
        +
        +
        Returns:
        +
        A function that converts vectors to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>> ArrayBlockingQueue_List()
        +
        A function that converts array blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts array blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ConcurrentLinkedQueue_List

        +
        public static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>> ConcurrentLinkedQueue_List()
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        Returns:
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArrayList_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>> CopyOnWriteArrayList_List()
        +
        A function that converts copy on write array lists to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArraySet_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>> CopyOnWriteArraySet_List()
        +
        A function that converts copy on write array sets to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        DelayQueue_List

        +
        public static <A extends java.util.concurrent.Delayed> F<java.util.concurrent.DelayQueue<A>,List<A>> DelayQueue_List()
        +
        A function that converts delay queues to lists.
        +
        +
        Returns:
        +
        A function that converts delay queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>> LinkedBlockingQueue_List()
        +
        A function that converts linked blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts linked blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>> PriorityBlockingQueue_List()
        +
        A function that converts priority blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        SynchronousQueue_List

        +
        public static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>> SynchronousQueue_List()
        +
        A function that converts synchronous queues to lists.
        +
        +
        Returns:
        +
        A function that converts synchronous queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        P1_Callable

        +
        public static <A> F<P1<A>,java.util.concurrent.Callable<A>> P1_Callable()
        +
        • +
      + + + +
        +
      • +

        Future_P1

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>> Future_P1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/LazyString.html b/javadoc/4.8/functionaljava/fj/data/LazyString.html new file mode 100644 index 0000000..bcbe7a3 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/LazyString.html @@ -0,0 +1,983 @@ + + + + + +LazyString (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class LazyString

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.LazyString
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.CharSequence
    +
    +
    +
    +
    public final class LazyString
+extends java.lang.Object
+implements java.lang.CharSequence
    +
    A lazy (non-evaluated) immutable character string.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static LazyStringempty +
      The empty string.
      +
      static F<Stream<java.lang.Character>,LazyString>fromStream +
      First-class conversion from character streams to lazy strings.
      +
      static F<LazyString,Stream<java.lang.Character>>toStream +
      First-class conversion from lazy strings to streams.
      +
      static F<LazyString,java.lang.String>toString +
      First-class conversion from lazy strings to String.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      LazyStringappend(LazyString cs) +
      Appends the given lazy string to the end of this lazy string.
      +
      LazyStringappend(java.lang.String s) +
      Appends the given String to the end of this lazy string.
      +
      LazyStringbind(F<java.lang.Character,LazyString> f) 
      charcharAt(int index) +
      Returns the caracter at the specified index.
      +
      booleancontains(LazyString cs) +
      Returns true if the given lazy string is a substring of this lazy string.
      +
      booleanendsWith(LazyString cs) +
      Returns true if the given lazy string is a suffix of this lazy string.
      +
      java.lang.Stringeval() 
      static LazyStringfromStream(Stream<java.lang.Character> s) +
      Constructs a lazy string from a stream of characters.
      +
      charhead() +
      Returns the first character of this string.
      +
      Option<java.lang.Integer>indexOf(char c) +
      Returns the first index of the given character in this lazy string, if present.
      +
      Option<java.lang.Integer>indexOf(LazyString cs) +
      Returns the first index of the given substring in this lazy string, if present.
      +
      booleanisEmpty() +
      Checks if this string is empty.
      +
      intlength() +
      The length of the lazy string.
      +
      static F<LazyString,Stream<LazyString>>lines_() 
      Stream<LazyString>lines() +
      Splits this lazy string into lines.
      +
      LazyStringmap(F<java.lang.Character,java.lang.Character> f) 
      booleanmatches(java.lang.String regex) +
      Regular expression pattern matching.
      +
      LazyStringreverse() +
      Returns the reverse of this string.
      +
      Stream<LazyString>split(char c) +
      Splits this lazy string by the given delimiter character.
      +
      Stream<LazyString>split(F<java.lang.Character,java.lang.Boolean> p) +
      Splits this lazy string by characters matching the given predicate.
      +
      static F<LazyString,F<LazyString,java.lang.Boolean>>startsWith() +
      First-class prefix check.
      +
      booleanstartsWith(LazyString cs) +
      Returns true if the given lazy string is a prefix of this lazy string.
      +
      static LazyStringstr(java.lang.String s) +
      Constructs a lazy string from a String.
      +
      java.lang.CharSequencesubSequence(int start, + int end) +
      Gets the specified subsequence of this lazy string.
      +
      LazyStringtail() +
      Returns all but the first character of this string.
      +
      Stream<java.lang.Character>toStream() +
      Gives a stream representation of this lazy string.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() +
      Returns the String representation of this lazy string.
      +
      java.lang.StringtoStringLazy() 
      static F<Stream<LazyString>,LazyString>unlines_() 
      static LazyStringunlines(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by newlines.
      +
      static LazyStringunwords(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by spaces.
      +
      Stream<LazyString>words() +
      Splits this lazy string into words by spaces.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.CharSequence

        +chars, codePoints
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        empty

        +
        public static final LazyString empty
        +
        The empty string.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static final F<LazyString,Stream<java.lang.Character>> toStream
        +
        First-class conversion from lazy strings to streams.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public static final F<LazyString,java.lang.String> toString
        +
        First-class conversion from lazy strings to String.
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static final F<Stream<java.lang.Character>,LazyString> fromStream
        +
        First-class conversion from character streams to lazy strings.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        str

        +
        public static LazyString str(java.lang.String s)
        +
        Constructs a lazy string from a String.
        +
        +
        Parameters:
        +
        s - A string from which to construct a lazy string.
        +
        Returns:
        +
        A lazy string with the characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static LazyString fromStream(Stream<java.lang.Character> s)
        +
        Constructs a lazy string from a stream of characters.
        +
        +
        Parameters:
        +
        s - A stream of characters.
        +
        Returns:
        +
        A lazy string with the characters from the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Character> toStream()
        +
        Gives a stream representation of this lazy string.
        +
        +
        Returns:
        +
        A stream representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of the lazy string. Note that this operation is O(n).
        +
        +
        Specified by:
        +
        length in interface java.lang.CharSequence
        +
        Returns:
        +
        The length of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        charAt

        +
        public char charAt(int index)
        +
        Returns the caracter at the specified index.
        +
        +
        Specified by:
        +
        charAt in interface java.lang.CharSequence
        +
        Parameters:
        +
        index - The index for the character to be returned.
        +
        Returns:
        +
        The character at the specified index.
        +
        +
        • +
      + + + +
        +
      • +

        subSequence

        +
        public java.lang.CharSequence subSequence(int start,
+                                          int end)
        +
        Gets the specified subsequence of this lazy string. + This operation does not fail for indexes that are out of bounds. If the start index is past the end + of this lazy string, then the resulting character sequence will be empty. If the end index is past the + end of this lazy string, then the resulting character sequence will be truncated.
        +
        +
        Specified by:
        +
        subSequence in interface java.lang.CharSequence
        +
        Parameters:
        +
        start - The character index of this lazy string at which to start the subsequence.
        +
        end - The character index of this lazy string at which to end the subsequence.
        +
        Returns:
        +
        A character sequence containing the specified character subsequence.
        +
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public java.lang.String toStringEager()
        +
        Returns the String representation of this lazy string.
        +
        +
        Returns:
        +
        The String representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Specified by:
        +
        toString in interface java.lang.CharSequence
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eval

        +
        public java.lang.String eval()
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(LazyString cs)
        +
        Appends the given lazy string to the end of this lazy string.
        +
        +
        Parameters:
        +
        cs - A lazy string to append to this one.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(java.lang.String s)
        +
        Appends the given String to the end of this lazy string.
        +
        +
        Parameters:
        +
        s - A String to append to this lazy string.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this lazy string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(LazyString cs)
        +
        Returns true if the given lazy string is a substring of this lazy string.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        True if the given string is a substring of this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        endsWith

        +
        public boolean endsWith(LazyString cs)
        +
        Returns true if the given lazy string is a suffix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the end of this lazy string.
        +
        Returns:
        +
        True if the given string is a suffix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public boolean startsWith(LazyString cs)
        +
        Returns true if the given lazy string is a prefix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the start of this lazy string.
        +
        Returns:
        +
        True if the given string is a prefix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public static F<LazyString,F<LazyString,java.lang.Boolean>> startsWith()
        +
        First-class prefix check.
        +
        +
        Returns:
        +
        A function that yields true if the first argument is a prefix of the second.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public char head()
        +
        Returns the first character of this string.
        +
        +
        Returns:
        +
        The first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public LazyString tail()
        +
        Returns all but the first character of this string.
        +
        +
        Returns:
        +
        All but the first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this string is empty.
        +
        +
        Returns:
        +
        True if there are no characters in this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public LazyString reverse()
        +
        Returns the reverse of this string.
        +
        +
        Returns:
        +
        the reverse of this string.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(char c)
        +
        Returns the first index of the given character in this lazy string, if present.
        +
        +
        Parameters:
        +
        c - A character to find in this lazy string.
        +
        Returns:
        +
        The first index of the given character in this lazy string, or None if the character is not present.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(LazyString cs)
        +
        Returns the first index of the given substring in this lazy string, if present.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        The first index of the given substring in this lazy string, or None if there is no such substring.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.String regex)
        +
        Regular expression pattern matching.
        +
        +
        Parameters:
        +
        regex - A regular expression to match this lazy string.
        +
        Returns:
        +
        True if this string mathches the given regular expression, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(F<java.lang.Character,java.lang.Boolean> p)
        +
        Splits this lazy string by characters matching the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate that matches characters to be considered delimiters.
        +
        Returns:
        +
        A stream of the substrings in this lazy string, when separated by the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public LazyString map(F<java.lang.Character,java.lang.Character> f)
        +
        • +
      + + + + + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(char c)
        +
        Splits this lazy string by the given delimiter character.
        +
        +
        Parameters:
        +
        c - A delimiter character at which to split.
        +
        Returns:
        +
        A stream of substrings of this lazy string, when separated by the given delimiter.
        +
        +
        • +
      + + + +
        +
      • +

        words

        +
        public Stream<LazyString> words()
        +
        Splits this lazy string into words by spaces.
        +
        +
        Returns:
        +
        A stream of the words in this lazy string, when split by spaces.
        +
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public Stream<LazyString> lines()
        +
        Splits this lazy string into lines.
        +
        +
        Returns:
        +
        A stream of the lines in this lazy string, when split by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unlines

        +
        public static LazyString unlines(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by newlines.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by newlines.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings separated by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unwords

        +
        public static LazyString unwords(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by spaces.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by spaces.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings with spaces in between.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/List.Buffer.html b/javadoc/4.8/functionaljava/fj/data/List.Buffer.html new file mode 100644 index 0000000..de5c462 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/List.Buffer.html @@ -0,0 +1,483 @@ + + + + + +List.Buffer (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class List.Buffer<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Buffer<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Buffer<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable, singly linked list. This structure should be used very sparingly, in favour + of the immutable singly linked list structure.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Buffer() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      List.Buffer<A>append(List<A> as) +
      Appends the given list to this buffer.
      +
      static <A> List.Buffer<A>empty() +
      An empty buffer.
      +
      static <A> List.Buffer<A>fromList(List<A> as) +
      Constructs a buffer from the given list.
      +
      booleanisEmpty() +
      Returns true if this buffer is empty, false otherwise.
      +
      static <A> List.Buffer<A>iterableBuffer(java.lang.Iterable<A> i) +
      Takes the given iterable to a buffer.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this buffer.
      +
      List<A>prependToList(List<A> as) +
      Prepends the elements of this buffer to the given list.
      +
      List.Buffer<A>snoc(A a) +
      Appends (snoc) the given element to this buffer to produce a new buffer.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this buffer.
      +
      List<A>toList() +
      Returns an immutable list projection of this buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Buffer

        +
        public Buffer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this buffer. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this buffer.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public List.Buffer<A> snoc(A a)
        +
        Appends (snoc) the given element to this buffer to produce a new buffer.
        +
        +
        Parameters:
        +
        a - The element to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public List.Buffer<A> append(List<A> as)
        +
        Appends the given list to this buffer.
        +
        +
        Parameters:
        +
        as - The list to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        prependToList

        +
        public List<A> prependToList(List<A> as)
        +
        Prepends the elements of this buffer to the given list.
        +
        +
        Parameters:
        +
        as - the list to which elements are prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true if this buffer is empty, false otherwise.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns an immutable list projection of this buffer. Modifications to the underlying buffer + will not be reflected in returned lists.
        +
        +
        Returns:
        +
        An immutable list projection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this buffer.
        +
        +
        Returns:
        +
        An immutable collection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> List.Buffer<A> empty()
        +
        An empty buffer.
        +
        +
        Returns:
        +
        An empty buffer.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> List.Buffer<A> fromList(List<A> as)
        +
        Constructs a buffer from the given list.
        +
        +
        Parameters:
        +
        as - The list to construct a buffer with.
        +
        Returns:
        +
        A buffer from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableBuffer

        +
        public static <A> List.Buffer<A> iterableBuffer(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a buffer.
        +
        +
        Parameters:
        +
        i - The iterable to take to a buffer.
        +
        Returns:
        +
        A buffer from the given iterable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/List.Optic.html b/javadoc/4.8/functionaljava/fj/data/List.Optic.html new file mode 100644 index 0000000..72a7347 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/List.Optic.html @@ -0,0 +1,323 @@ + + + + + +List.Optic (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Optic
+extends java.lang.Object
    +
    Optic factory methods for a List
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pTraversal

        +
        public static <A,B> PTraversal<List<A>,List<B>,A,B> pTraversal()
        +
        Polymorphic traversal
        +
        • +
      + + + +
        +
      • +

        traversal

        +
        public static <A> Traversal<List<A>,A> traversal()
        +
        Monomorphic traversal
        +
        • +
      + + + +
        +
      • +

        head

        +
        public static <A> Optional<List<A>,A> head()
        +
        Optional targeted on Cons head.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public static <A> Optional<List<A>,List<A>> tail()
        +
        Optional targeted on Cons tail.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Prism<List<A>,Unit> nil()
        +
        Nil prism
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> Prism<List<A>,P2<A,List<A>>> cons()
        +
        Cons prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/List.Unsafe.html b/javadoc/4.8/functionaljava/fj/data/List.Unsafe.html new file mode 100644 index 0000000..3eb4cea --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/List.Unsafe.html @@ -0,0 +1,239 @@ + + + + + +List.Unsafe (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Unsafe

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Unsafe
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Unsafe
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Unsafe() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Unsafe

        +
        public Unsafe()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/List.html b/javadoc/4.8/functionaljava/fj/data/List.html new file mode 100644 index 0000000..9267181 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/List.html @@ -0,0 +1,3771 @@ + + + + + +List (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class List<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class List.Buffer<A> +
      A mutable, singly linked list.
      +
      static class List.Optic +
      Optic factory methods for a List
      +
      static class List.Unsafe 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      booleanallEqual(Equal<A> eq) +
      Returns whether or not all elements in the list are equal according to the given equality test.
      +
      List<A>append(List<A> as) +
      Appends the given list to this list.
      +
      <B> List<B>apply(List<F<A,B>> lf) +
      Performs function application within a list (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this list.
      +
      static <A> List<A>arrayList(A... as) +
      Constructs a list from the given elements.
      +
      static F<List<java.lang.Character>,java.lang.String>asString() +
      A first-class asString.
      +
      static java.lang.StringasString(List<java.lang.Character> cs) +
      Returns a string from the given list of characters.
      +
      static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>>bind_() +
      Provides a first-class version of bind()
      +
      <B> List<B>bind(F<A,List<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      <B,C> List<C>bind(List<B> lb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C> List<C>bind(List<B> lb, + F2<A,B,C> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C,D> List<D>bind(List<B> lb, + List<C> lc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E> List<E>bind(List<B> lb, + List<C> lc, + List<D> ld, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$>
      List<F$>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G>
      List<G>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H>
      List<H>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      List<I>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + List<H> lh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      P2<List<A>,List<A>>breakk(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
      +
      static <A> F2<A,List<A>,List<A>>cons_() 
      static <A> F<List<A>,List<A>>cons_(A a) +
      Returns a function that prepends the given value to a list.
      +
      static <A> F<A,F<List<A>,List<A>>>cons() +
      Returns a function that prepends (cons) an element to a list to produce a new list.
      +
      List<A>cons(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      static <A> List<A>cons(A head, + List<A> tail) +
      Prepends the given head element to the given tail element to produce a new list.
      +
      static <A> F<A,List<A>>cons(List<A> tail) +
      Returns a function that prepends a value to the given list.
      +
      List<A>conss(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      List<A>delete(A a, + Equal<A> e) +
      Removes the first element that equals the given object.
      +
      List<A>drop(int i) +
      Drops the given number of elements from the head of this list if they are available.
      +
      List<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
      +
      Option<java.lang.Integer>elementIndex(Equal<A> e, + A a) +
      Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
      +
      List<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>>foldLeft() +
      Provides a first-class version of foldLeft.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> Trampoline<B>foldRightC(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list in O(1) stack space.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this list.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this list.
      +
      static <A> List<A>fromIterator(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static F<java.lang.String,List<java.lang.Character>>fromString() +
      A first-class fromString.
      +
      static List<java.lang.Character>fromString(java.lang.String s) +
      Returns a list of characters from the given string.
      +
      List<List<A>>group(Equal<A> e) +
      Groups elements according to the given equality implementation by longest + sequence of equal elements.
      +
      <B> TreeMap<B,List<A>>groupBy(F<A,B> keyFunction) +
      Deprecated.  +
      As of release 4.7, use groupBy(F, Ord)
      +
      +
      <B,C> TreeMap<B,List<C>>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction) +
      Deprecated.  +
      As of release 4.7, use groupBy(F, F, Ord)
      +
      +
      <B,C,D> TreeMap<B,D>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + D groupingIdentity, + F2<C,D,D> groupingAcc, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
      +
      <B,C> TreeMap<B,C>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Monoid<C> monoid, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B,C> TreeMap<B,List<C>>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B> TreeMap<B,List<A>>groupBy(F<A,B> keyFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap.
      +
      inthashCode() +
      Compute the hash code from this list as a function of the hash codes of its members.
      +
      static <A> F<List<A>,A>head_() +
      First-class head function.
      +
      abstract Ahead() +
      The first element of the linked list or fails for the empty list.
      +
      Option<A>headOption() +
      Returns the head of the list, if any.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      List<A>init() +
      Returns all but the last element of this list.
      +
      List<List<A>>inits() +
      Returns the list of initial segments of this list, shortest first.
      +
      List<A>insertBy(F<A,F<A,Ordering>> f, + A x) +
      Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
      +
      List<A>intercalate(List<List<A>> as) +
      Intersperses this list through the given list then joins the results.
      +
      List<A>intersperse(A a) +
      Intersperses the given argument between each element of this list.
      +
      static <A> F<List<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given list is empty.
      +
      booleanisEmpty() +
      Returns true if this list is empty, false otherwise.
      +
      static <A> F<List<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given list is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this list is empty, true otherwise.
      +
      booleanisPrefixOf(Equal<A> eq, + List<A> xs) 
      booleanisSingle() +
      True if and only if the list has one element.
      +
      booleanisSuffixOf(Equal<A> eq, + List<A> xs) 
      static <A> List<A>iterableList(java.lang.Iterable<A> i) +
      Takes the given iterable to a list.
      +
      static <A> List<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this list.
      +
      static <A> List<A>iteratorList(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static <A> F<List<List<A>>,List<A>>join() +
      A first-class version of join
      +
      static <A> List<A>join(List<List<A>> o) +
      Joins the given list of lists using a bind operation.
      +
      Alast() +
      Returns the last element of this list.
      +
      static <A> F<List<A>,java.lang.Integer>length_() +
      First-class length.
      +
      intlength() +
      The length of this list.
      +
      static <A,B,C> F<List<A>,F<List<B>,List<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes the given function of arity-2 to a function on lists.
      +
      static <A> List<A>list(A... as) +
      Constructs a list from the given elements.
      +
      <B> Blist(B nil, + F<A,F<List<A>,B>> cons) +
      Deprecated.  +
      As of release 4.5, use uncons(fj.F2<A, fj.data.List<A>, B>, B)
      +
      +
      static <A> List<A>list(java.lang.Iterable<A> i) +
      Deprecated.  +
      As of release 4.5, use iterableList(Iterable)
      +
      +
      static <A> List<A>list(java.util.Iterator<A> it) +
      Deprecated.  +
      As of release 4.5, use iteratorList(Iterator)
      +
      +
      static <A,B> F2<List<P2<A,B>>,A,Option<B>>lookup(Equal<A> e) +
      Returns a partially applied version of lookup(Equal, List, Object).
      +
      static <A,B> Option<B>lookup(Equal<A> e, + List<P2<A,B>> x, + A a) +
      Returns an associated value with the given key in the list of pairs.
      +
      static <A,B> F<F<A,B>,F<List<A>,List<B>>>map_() +
      Provides a first-class version of map()
      +
      <B> List<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B,C> F<B,List<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
      +
      <B> Option<List<B>>mapMOption(F<A,Option<B>> f) +
      Maps the given function across this list by binding through the Option monad.
      +
      <B> Trampoline<List<B>>mapMTrampoline(F<A,Trampoline<B>> f) +
      Maps the given function across this list by binding through the Trampoline monad.
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Option<A>maximumOption(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      Option<A>minimumOption(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      List<A>minus(Equal<A> eq, + List<A> xs) +
      Returns a new list of all the items in this list that do not appear in the given list.
      +
      Amode(Ord<A> o) +
      Returns the most common element in this list.
      +
      static <A> List<A>nil() +
      Returns an empty list.
      +
      List<A>nub() +
      Removes duplicates according to object equality.
      +
      List<A>nub(Equal<A> eq) +
      Removes duplicates according to the given equality.
      +
      List<A>nub(Ord<A> o) +
      Removes duplicates according to the given ordering.
      +
      AorHead(F0<A> a) +
      Returns the head of this list if there is one or the given argument if this list is empty.
      +
      List<A>orTail(F0<List<A>> as) +
      Returns the tail of this list if there is one or the given argument if this list is empty.
      +
      P2<List<A>,List<A>>partition(F<A,java.lang.Boolean> f) +
      Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
      +
      List<List<A>>partition(int n) +
      Splits this list into lists of the given size.
      +
      static List<java.lang.Integer>range(int from, + int to) +
      Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      List<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> List<A>replicate(int n, + A a) +
      Returns a list of the given value replicated the given number of times.
      +
      List<A>reverse() +
      Reverse this list in constant stack space.
      +
      static <A,B> F<B,List<A>>sequence_(List<F<B,A>> fs) +
      Turn a list of functions into a function returning a list.
      +
      <B> List<B>sequence(List<B> bs) +
      Performs a bind across each list element, but ignores the element value each time.
      +
      static <A> List<A>single(A a) +
      Returns a list of one element containing the given value.
      +
      List<A>snoc(A a) +
      Appends (snoc) the given element to this list to produce a new list.
      +
      List<A>sort(Ord<A> o) +
      Sorts this list using the given order over elements using a merge sort algorithm.
      +
      P2<List<A>,List<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
      +
      P2<List<A>,List<A>>splitAt(int i) +
      Splits this list into two lists at the given index.
      +
      static <A> F<List<A>,List<A>>tail_() +
      First-class tail function.
      +
      abstract List<A>tail() +
      The list without the first element or fails for the empty list.
      +
      Option<List<A>>tailOption() +
      Reutrns the tail of the list, if any.
      +
      List<List<A>>tails() +
      Returns the list of final segments of this list, longest first.
      +
      static <A> F<java.lang.Integer,F<List<A>,List<A>>>take() +
      Provides a first-class version of take.
      +
      List<A>take(int i) +
      Takes the given number of elements from the head of this list if they are available.
      +
      List<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this list that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this list.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this list.
      +
      java.lang.Object[]toArrayObject() 
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this list.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.List<A>toJavaList() 
      Option<A>toOption() +
      Deprecated.  +
      As of release 4.5, use headOption()
      +
      +
      Stream<A>toStream() +
      Returns a stream projection of this list.
      +
      java.lang.StringtoString() +
      Obtain a string representation of this list using the toString implementations of the members.
      +
      <B,E> Either<E,List<B>>traverseEither(F<A,Either<E,B>> f) +
      Traverse through the List with given function.
      +
      <C,B> F<C,List<B>>traverseF(F<A,F<C,B>> f) 
      <B> IO<List<B>>traverseIO(F<A,IO<B>> f) 
      <B> List<List<B>>traverseList(F<A,List<B>> f) 
      <B> Option<List<B>>traverseOption(F<A,Option<B>> f) +
      Traverses through the List with the given function
      +
      <B> P1<List<B>>traverseP1(F<A,P1<B>> f) 
      <B> Promise<List<B>>traversePromise(F<A,Promise<B>> f) 
      <B> Stream<List<B>>traverseStream(F<A,Stream<B>> f) 
      <B> Trampoline<List<B>>traverseTrampoline(F<A,Trampoline<B>> f) 
      <B> V2<List<B>>traverseV2(F<A,V2<B>> f) 
      <E,B> Validation<E,List<B>>traverseValidation(Semigroup<E> s, + F<A,Validation<E,B>> f) 
      <B> Buncons(F2<A,List<A>,B> cons, + B nil) 
      static <A,B> List<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a list.
      +
      static <A,B> P2<List<A>,List<B>>unzip(List<P2<A,B>> xs) +
      Transforms a list of pairs into a list of first components and a list of second components.
      +
      static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>>zip() +
      The first-class version of the zip function.
      +
      <B> List<P2<A,B>>zip(List<B> bs) +
      Zips this list with the given list to produce a list of pairs.
      +
      List<P2<A,java.lang.Integer>>zipIndex() +
      Zips this list with the index of its element as a pair.
      +
      static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>>zipWith() +
      Provides a first-class version of zipWith
      +
      <B,C> List<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      <B,C> List<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        Returns:
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract List<A> tail()
        +
        The list without the first element or fails for the empty list.
        +
        +
        Returns:
        +
        The list without the first element or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this list is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this list is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this list is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this list is empty, true otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        list

        +
        @Deprecated
+public final <B> B list(B nil,
+                                    F<A,F<List<A>,B>> cons)
        +
        Deprecated. As of release 4.5, use uncons(fj.F2<A, fj.data.List<A>, B>, B)
        +
        Performs a reduction on this list using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this list is empty.
        +
        cons - The function to apply to the head and tail of this list if it is not empty.
        +
        Returns:
        +
        A reduction on this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(F2<A,List<A>,B> cons,
+                          B nil)
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this list is empty.
        +
        Returns:
        +
        The head of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final List<A> orTail(F0<List<A>> as)
        +
        Returns the tail of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this list is empty.
        +
        Returns:
        +
        The tail of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        @Deprecated
+public final Option<A> toOption()
        +
        Deprecated. As of release 4.5, use headOption()
        +
        Returns an option projection of this list; None if empty, or the first element in + Some. Equivalent to headOption().
        +
        +
        Returns:
        +
        An option projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        Returns the head of the list, if any. Equivalent to toOption() .
        +
        +
        Returns:
        +
        The optional head of the list.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this list is empty.
        +
        Returns:
        +
        An either projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this list.
        +
        +
        Returns:
        +
        A stream projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this list.
        +
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArrayObject

        +
        public final java.lang.Object[] toArrayObject()
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public final A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final List<A> cons(A a)
        +
        Prepends (cons) the given element to this list to product a new list.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + + + +
        +
      • +

        conss

        +
        public final List<A> conss(A a)
        +
        Prepends (cons) the given element to this list to product a new list. This method is added to prevent conflict with + overloads.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> List<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final List<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final List<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final List<A> delete(A a,
+                            Equal<A> e)
        +
        Removes the first element that equals the given object. + To remove all matches, use removeAll(e.eq(a))
        +
        +
        Parameters:
        +
        a - The element to remove
        +
        e - An Equals instance for the element's type.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final List<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this list that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this list until it finds an element that does not + hold, or the list is exhausted.
        +
        Returns:
        +
        The first elements of the head of this list that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final List<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this list.
        +
        Returns:
        +
        The list whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<List<A>,List<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        breakk

        +
        public final P2<List<A>,List<A>> breakk(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate for an element to not satisfy by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        group

        +
        public final List<List<A>> group(Equal<A> e)
        +
        Groups elements according to the given equality implementation by longest + sequence of equal elements.
        +
        +
        Parameters:
        +
        e - The equality implementation for the elements.
        +
        Returns:
        +
        A list of grouped elements.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> List<B> bind(F<A,List<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F2<A,B,C> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<List<A>,F<List<B>,List<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on lists.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on lists.
        +
        Returns:
        +
        The given function, promoted to operate on lists.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> List<D> bind(List<B> lb,
+                                  List<C> lc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> List<E> bind(List<B> lb,
+                                    List<C> lc,
+                                    List<D> ld,
+                                    F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> List<F$> bind(List<B> lb,
+                                        List<C> lc,
+                                        List<D> ld,
+                                        List<E> le,
+                                        F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> List<G> bind(List<B> lb,
+                                         List<C> lc,
+                                         List<D> ld,
+                                         List<E> le,
+                                         List<F$> lf,
+                                         F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> List<H> bind(List<B> lb,
+                                           List<C> lc,
+                                           List<D> ld,
+                                           List<E> le,
+                                           List<F$> lf,
+                                           List<G> lg,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> List<I> bind(List<B> lb,
+                                             List<C> lc,
+                                             List<D> ld,
+                                             List<E> le,
+                                             List<F$> lf,
+                                             List<G> lg,
+                                             List<H> lh,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        lh - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> List<B> sequence(List<B> bs)
        +
        Performs a bind across each list element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The list to apply in the final join.
        +
        Returns:
        +
        A new list after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<List<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverses through the List with the given function
        +
        +
        Parameters:
        +
        f - The function that produces Option value
        +
        Returns:
        +
        none if applying f returns none to any element of the list or f mapped list in some .
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,E> Either<E,List<B>> traverseEither(F<A,Either<E,B>> f)
        +
        Traverse through the List with given function.
        +
        +
        Parameters:
        +
        f - The function that produces Either value.
        +
        Returns:
        +
        error in left or f mapped list in right.
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<List<B>> traverseStream(F<A,Stream<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<List<B>> traverseP1(F<A,P1<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<List<B>> traverseIO(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public final <C,B> F<C,List<B>> traverseF(F<A,F<C,B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        traverseList

        +
        public final <B> List<List<B>> traverseList(F<A,List<B>> f)
        +
        • +
      + + + + + + + +
        +
      • +

        traverseV2

        +
        public final <B> V2<List<B>> traverseV2(F<A,V2<B>> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> List<B> apply(List<F<A,B>> lf)
        +
        Performs function application within a list (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The list of functions to apply.
        +
        Returns:
        +
        A new list after applying the given list of functions through this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final List<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append to this one.
        +
        Returns:
        +
        A new list that has appended the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<B,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this list.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightC

        +
        public final <B> Trampoline<B> foldRightC(F2<A,B,B> f,
+                                          B b)
        +
        Performs a right-fold reduction across this list in O(1) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        A Trampoline containing the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final List<A> reverse()
        +
        Reverse this list in constant stack space.
        +
        +
        Returns:
        +
        A new list that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final List<A> take(int i)
        +
        Takes the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The maximum number of elements to take from this list.
        +
        Returns:
        +
        A new list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final List<A> drop(int i)
        +
        Drops the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this list.
        +
        Returns:
        +
        A list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        splitAt

        +
        public final P2<List<A>,List<A>> splitAt(int i)
        +
        Splits this list into two lists at the given index. If the index goes out of bounds, then it is + normalised so that this function never fails.
        +
        +
        Parameters:
        +
        i - The index at which to split this list in two parts.
        +
        Returns:
        +
        A pair of lists split at the given index of this list.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final List<List<A>> partition(int n)
        +
        Splits this list into lists of the given size. If the size of this list is not evenly divisible by + the given number, the last partition will contain the remainder.
        +
        +
        Parameters:
        +
        n - The size of the partitions into which to split this list.
        +
        Returns:
        +
        A list of sublists of this list, of at most the given size.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final P2<List<A>,List<A>> partition(F<A,java.lang.Boolean> f)
        +
        Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not. The relative order of the elements in the returned tuple + is the same as the original list.
        +
        +
        Parameters:
        +
        f - Predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final List<List<A>> inits()
        +
        Returns the list of initial segments of this list, shortest first.
        +
        +
        Returns:
        +
        The list of initial segments of this list, shortest first.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final List<List<A>> tails()
        +
        Returns the list of final segments of this list, longest first.
        +
        +
        Returns:
        +
        The list of final segments of this list, longest first.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final List<A> sort(Ord<A> o)
        +
        Sorts this list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this list.
        +
        Returns:
        +
        A sorted list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>> zipWith()
        +
        Provides a first-class version of zipWith
        +
        +
        Returns:
        +
        The first-class version of zipWith
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> List<P2<A,B>> zip(List<B> bs)
        +
        Zips this list with the given list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>> zip()
        +
        The first-class version of the zip function.
        +
        +
        Returns:
        +
        A function that zips the given lists to produce a list of pairs.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final List<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new list with the same length as this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final List<A> snoc(A a)
        +
        Appends (snoc) the given element to this list to produce a new list.
        +
        +
        Parameters:
        +
        a - The element to append to this list.
        +
        Returns:
        +
        A new list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on each element of this list.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this list, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this list.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + list.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this list.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final List<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this list.
        +
        Returns:
        +
        A list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        intercalate

        +
        public final List<A> intercalate(List<List<A>> as)
        +
        Intersperses this list through the given list then joins the results.
        +
        +
        Parameters:
        +
        as - The list to intersperse through.
        +
        Returns:
        +
        This list through the given list then joins the results.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub()
        +
        Removes duplicates according to object equality.
        +
        +
        Returns:
        +
        A list without duplicates according to object equality.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Equal<A> eq)
        +
        Removes duplicates according to the given equality. Warning: O(n^2).
        +
        +
        Parameters:
        +
        eq - Equality over the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Ord<A> o)
        +
        Removes duplicates according to the given ordering. This function is O(n).
        +
        +
        Parameters:
        +
        o - An ordering for the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        head_

        +
        public static <A> F<List<A>,A> head_()
        +
        First-class head function.
        +
        +
        Returns:
        +
        A function that gets the head of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        tailOption

        +
        public final Option<List<A>> tailOption()
        +
        Reutrns the tail of the list, if any.
        +
        +
        Returns:
        +
        The optional tail of the list.
        +
        +
        • +
      + + + +
        +
      • +

        tail_

        +
        public static <A> F<List<A>,List<A>> tail_()
        +
        First-class tail function.
        +
        +
        Returns:
        +
        A function that gets the tail of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final List<A> minus(Equal<A> eq,
+                           List<A> xs)
        +
        Returns a new list of all the items in this list that do not appear in the given list.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the lists.
        +
        xs - a list to subtract from this list.
        +
        Returns:
        +
        a list of all the items in this list that do not appear in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,List<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapMOption

        +
        public final <B> Option<List<B>> mapMOption(F<A,Option<B>> f)
        +
        Maps the given function across this list by binding through the Option monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A possible list of values after binding through the Option monad.
        +
        +
        • +
      + + + +
        +
      • +

        mapMTrampoline

        +
        public final <B> Trampoline<List<B>> mapMTrampoline(F<A,Trampoline<B>> f)
        +
        Maps the given function across this list by binding through the Trampoline monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A list of values in the Trampoline monad.
        +
        +
        • +
      + + + + + +
        +
      • +

        elementIndex

        +
        public final Option<java.lang.Integer> elementIndex(Equal<A> e,
+                                                    A a)
        +
        Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        Parameters:
        +
        e - An equality for this list's elements.
        +
        a - A query element.
        +
        Returns:
        +
        The index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Returns the last element of this list. Undefined for the empty list.
        +
        +
        Returns:
        +
        The last element of this list or throws an error if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public final List<A> init()
        +
        Returns all but the last element of this list. Undefiend for the empty list.
        +
        +
        Returns:
        +
        All but the last element of this list. Undefiend for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertBy

        +
        public final List<A> insertBy(F<A,F<A,Ordering>> f,
+                              A x)
        +
        Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
        +
        +
        Parameters:
        +
        f - An ordering function to compare elements.
        +
        x - The element to insert.
        +
        Returns:
        +
        A new list with the given element inserted before the first element that is greater than or equal to + it according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        mode

        +
        public final A mode(Ord<A> o)
        +
        Returns the most common element in this list.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The most common element in this list.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        @Deprecated
+public final <B> TreeMap<B,List<A>> groupBy(F<A,B> keyFunction)
        +
        Deprecated. As of release 4.7, use groupBy(F, Ord)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap. + The ordering of the keys is determined by Ord.hashOrd() (ie. Object#hasCode). + This is not safe and therefore this method is deprecated.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B> TreeMap<B,List<A>> groupBy(F<A,B> keyFunction,
+                                            Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        @Deprecated
+public final <B,C> TreeMap<B,List<C>> groupBy(F<A,B> keyFunction,
+                                                          F<A,C> valueFunction)
        +
        Deprecated. As of release 4.7, use groupBy(F, F, Ord)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + Ord.hashOrd() (ie. Object#hasCode). + This is not safe and therefore this method is deprecated.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,List<C>> groupBy(F<A,B> keyFunction,
+                                              F<A,C> valueFunction,
+                                              Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,C> groupBy(F<A,B> keyFunction,
+                                        F<A,C> valueFunction,
+                                        Monoid<C> monoid,
+                                        Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        monoid - A monoid, which defines the accumulator for the values and the zero value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        groupBy

        +
        public final <B,C,D> TreeMap<B,D> groupBy(F<A,B> keyFunction,
+                                          F<A,C> valueFunction,
+                                          D groupingIdentity,
+                                          F2<C,D,D> groupingAcc,
+                                          Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys.
        +
        valueFunction - The function to apply on each element.
        +
        groupingIdentity - The identity, or start value, for the grouping.
        +
        groupingAcc - The accumulator to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated result of matched and mapped + elements.
        +
        +
        • +
      + + + +
        +
      • +

        allEqual

        +
        public final boolean allEqual(Equal<A> eq)
        +
        Returns whether or not all elements in the list are equal according to the given equality test.
        +
        +
        Parameters:
        +
        eq - The equality test.
        +
        Returns:
        +
        Whether or not all elements in the list are equal according to the given equality test.
        +
        +
        • +
      + + + +
        +
      • +

        isPrefixOf

        +
        public final boolean isPrefixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        isSuffixOf

        +
        public final boolean isSuffixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        length_

        +
        public static <A> F<List<A>,java.lang.Integer> length_()
        +
        First-class length.
        +
        +
        Returns:
        +
        A function that gets the length of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximumOption

        +
        public final Option<A> maximumOption(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimumOption

        +
        public final Option<A> minimumOption(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this list.
        +
        +
        Returns:
        +
        An immutable collection of this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        list

        +
        @SafeVarargs
+public static <A> List<A> list(A... as)
        +
        Constructs a list from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct a list with.
        +
        Returns:
        +
        A list with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayList

        +
        @SafeVarargs
+public static <A> List<A> arrayList(A... as)
        +
        Constructs a list from the given elements.
        +
        • +
      + + + +
        +
      • +

        list

        +
        @Deprecated
+public static <A> List<A> list(java.lang.Iterable<A> i)
        +
        Deprecated. As of release 4.5, use iterableList(Iterable)
        +
        Constructs a list from the given Iterable.
        +
        • +
      + + + +
        +
      • +

        list

        +
        @Deprecated
+public static <A> List<A> list(java.util.Iterator<A> it)
        +
        Deprecated. As of release 4.5, use iteratorList(Iterator)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        fromIterator

        +
        public static <A> List<A> fromIterator(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> List<A> nil()
        +
        Returns an empty list.
        +
        +
        Returns:
        +
        An empty list.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<List<A>,List<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a list to produce a new list.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a list to produce a new list.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F2<A,List<A>,List<A>> cons_()
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,List<A>> cons(List<A> tail)
        +
        Returns a function that prepends a value to the given list.
        +
        +
        Parameters:
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        A function that prepends a value to the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons_

        +
        public static <A> F<List<A>,List<A>> cons_(A a)
        +
        Returns a function that prepends the given value to a list.
        +
        +
        Parameters:
        +
        a - The value to prepend to a list.
        +
        Returns:
        +
        A function that prepends the given value to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> List<A> cons(A head,
+                               List<A> tail)
        +
        Prepends the given head element to the given tail element to produce a new list.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        The list with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given list is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given list is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is not empty.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> List<A> join(List<List<A>> o)
        +
        Joins the given list of lists using a bind operation.
        +
        +
        Parameters:
        +
        o - The list of lists to join.
        +
        Returns:
        +
        A new list that is the join of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<List<List<A>>,List<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a list of lists using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> List<A> unfold(F<B,Option<P2<A,B>>> f,
+                                   B b)
        +
        Unfolds across the given function starting at the given value to produce a list.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new list that is a result of unfolding until the function does not produce a value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<List<A>,List<B>> unzip(List<P2<A,B>> xs)
        +
        Transforms a list of pairs into a list of first components and a list of second components.
        +
        +
        Parameters:
        +
        xs - The list of pairs to transform.sp
        +
        Returns:
        +
        A list of first components and a list of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        replicate

        +
        public static <A> List<A> replicate(int n,
+                                    A a)
        +
        Returns a list of the given value replicated the given number of times.
        +
        +
        Parameters:
        +
        n - The number of times to replicate the given value.
        +
        a - The value to replicate.
        +
        Returns:
        +
        A list of the given value replicated the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static List<java.lang.Integer> range(int from,
+                                            int to)
        +
        Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the list (inclusive).
        +
        to - The maximum value for the list (exclusive).
        +
        Returns:
        +
        A list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static List<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a list of characters from the given string. The inverse of this function is asString(List).
        +
        +
        Parameters:
        +
        s - The string to produce the list of characters from.
        +
        Returns:
        +
        A list of characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,List<java.lang.Character>> fromString()
        +
        A first-class fromString.
        +
        +
        Returns:
        +
        A first-class fromString.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(List<java.lang.Character> cs)
        +
        Returns a string from the given list of characters. The invers of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The list of characters to produce the string from.
        +
        Returns:
        +
        A string from the given list of characters.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static F<List<java.lang.Character>,java.lang.String> asString()
        +
        A first-class asString.
        +
        +
        Returns:
        +
        A first-class asString.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> List<A> single(A a)
        +
        Returns a list of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned list.
        +
        Returns:
        +
        A list of one element containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> List<A> iterateWhile(F<A,A> f,
+                                       F<A,java.lang.Boolean> p,
+                                       A a)
        +
        Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public static <A,B> Option<B> lookup(Equal<A> e,
+                                     List<P2<A,B>> x,
+                                     A a)
        +
        Returns an associated value with the given key in the list of pairs.
        +
        +
        Parameters:
        +
        e - The test for equality on keys.
        +
        x - The list of pairs to search.
        +
        a - The key value to find the associated value of.
        +
        Returns:
        +
        An associated value with the given key in the list of pairs.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>> bind_()
        +
        Provides a first-class version of bind()
        +
        +
        Returns:
        +
        The bind function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<List<A>,List<B>>> map_()
        +
        Provides a first-class version of map()
        +
        +
        Returns:
        +
        The map function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,List<A>> sequence_(List<F<B,A>> fs)
        +
        Turn a list of functions into a function returning a list.
        +
        +
        Parameters:
        +
        fs - The list of functions to sequence into a single function that returns a list.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given list to it + and returns a list of the results.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft

        +
        public static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>> foldLeft()
        +
        Provides a first-class version of foldLeft.
        +
        +
        Returns:
        +
        The left fold function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public static <A> F<java.lang.Integer,F<List<A>,List<A>>> take()
        +
        Provides a first-class version of take.
        +
        +
        Returns:
        +
        First-class version of take.
        +
        +
        • +
      + + + +
        +
      • +

        iterableList

        +
        public static <A> List<A> iterableList(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a list.
        +
        +
        Parameters:
        +
        i - The iterable to take to a list.
        +
        Returns:
        +
        A list from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorList

        +
        public static <A> List<A> iteratorList(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.listEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        Compute the hash code from this list as a function of the hash codes of its members. + Delegates to Hash.listHash, using the anyHash() rule, which uses the hash codes of the contents.
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        Returns:
        +
        the hash code for this list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        Obtain a string representation of this list using the toString implementations of the members. Uses Show.listShow with F2 argument and may + not be very performant.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        a String representation of the list
        +
        +
        • +
      + + + +
        +
      • +

        isSingle

        +
        public final boolean isSingle()
        +
        True if and only if the list has one element. Runs in constant time.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Natural.html b/javadoc/4.8/functionaljava/fj/data/Natural.html new file mode 100644 index 0000000..44609da --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Natural.html @@ -0,0 +1,930 @@ + + + + + +Natural (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Natural

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Number
      • +
    • +
        +
      • fj.data.Natural
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public final class Natural
+extends java.lang.Number
    +
    Represents a natural number (zero, one, two, etc.)
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fromBigInt

        +
        public static final F<java.math.BigInteger,Option<Natural>> fromBigInt
        +
        A function that returns the natural number equal to a given BigInteger
        +
        • +
      + + + +
        +
      • +

        ZERO

        +
        public static final Natural ZERO
        +
        The natural number zero
        +
        • +
      + + + +
        +
      • +

        ONE

        +
        public static final Natural ONE
        +
        The natural number one
        +
        • +
      + + + + + + + +
        +
      • +

        subtract

        +
        public static final F<Natural,F<Natural,Option<Natural>>> subtract
        +
        A function that subtracts its first argument from its second.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<Natural,F<Natural,Natural>> multiply
        +
        A function that multiplies a natural number by another.
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public static final F<Natural,F<Natural,Natural>> divide
        +
        A function that divides its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public static final F<Natural,F<Natural,Natural>> mod
        +
        A function that yields the remainder of division of its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public static final F<Natural,F<Natural,V2<Natural>>> divmod
        +
        A function that divides its second argument by its first, yielding both the quotient and the remainder.
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public static final F<Natural,java.math.BigInteger> bigIntegerValue
        +
        A function that returns the BigInteger value of a given Natural.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(java.math.BigInteger i)
        +
        Returns the natural number equal to the given BigInteger
        +
        +
        Parameters:
        +
        i - A given BigInteger
        +
        Returns:
        +
        An optional natural number, or none if the given BigInteger is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(long i)
        +
        Returns the natural number equal to the given long
        +
        +
        Parameters:
        +
        i - A given long
        +
        Returns:
        +
        An optional natural number, or none if the given long is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        succ

        +
        public Natural succ()
        +
        Return the successor of this natural number
        +
        +
        Returns:
        +
        the successor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        succ_

        +
        public static F<Natural,Natural> succ_()
        +
        First-class successor function.
        +
        +
        Returns:
        +
        A function that returns the successor of a given natural number.
        +
        +
        • +
      + + + +
        +
      • +

        pred

        +
        public Option<Natural> pred()
        +
        Return the predecessor of this natural number
        +
        +
        Returns:
        +
        the predecessor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        pred_

        +
        public static F<Natural,Option<Natural>> pred_()
        +
        First-class predecessor function.
        +
        +
        Returns:
        +
        A function that returns the predecessor of a given natural number, or None if it's zero.
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public Natural add(Natural n)
        +
        Add two natural numbers together.
        +
        +
        Parameters:
        +
        n - A natural number to add to this one.
        +
        Returns:
        +
        the sum of the two natural numbers.
        +
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public Option<Natural> subtract(Natural n)
        +
        Subtract a natural number from another.
        +
        +
        Parameters:
        +
        n - A natural number to subtract from this one.
        +
        Returns:
        +
        The difference between the two numbers, if this number is larger than the given one. Otherwise none.
        +
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public Natural multiply(Natural n)
        +
        Multiply a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to multiply by this one.
        +
        Returns:
        +
        The product of the two numbers.
        +
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public Natural divide(Natural n)
        +
        Divide a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient of this number and the highest number, less than or equal to the given number, + that divides this number.
        +
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public Natural mod(Natural n)
        +
        Take the remainder of a natural number division.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The remainder of division of this number by the given number.
        +
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public V2<Natural> divmod(Natural n)
        +
        Divide a natural number by another yielding both the quotient and the remainder.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient and the remainder, in that order.
        +
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public java.math.BigInteger bigIntegerValue()
        +
        Return the BigInteger value of this natural number.
        +
        +
        Returns:
        +
        the BigInteger value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        Return the long value of this natural number.
        +
        +
        Specified by:
        +
        longValue in class java.lang.Number
        +
        Returns:
        +
        the long value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        floatValue

        +
        public float floatValue()
        +
        Return the float value of this natural number.
        +
        +
        Specified by:
        +
        floatValue in class java.lang.Number
        +
        Returns:
        +
        the float value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        doubleValue

        +
        public double doubleValue()
        +
        Return the double value of this natural number.
        +
        +
        Specified by:
        +
        doubleValue in class java.lang.Number
        +
        Returns:
        +
        the double value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        intValue

        +
        public int intValue()
        +
        Return the int value of this natural number.
        +
        +
        Specified by:
        +
        intValue in class java.lang.Number
        +
        Returns:
        +
        the int value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(Stream<Natural> ns)
        +
        Sums a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(Stream<Natural> ns)
        +
        Takes the product of a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(List<Natural> ns)
        +
        Sums a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(List<Natural> ns)
        +
        Takes the product of a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object that)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/NonEmptyList.html b/javadoc/4.8/functionaljava/fj/data/NonEmptyList.html new file mode 100644 index 0000000..33baa26 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/NonEmptyList.html @@ -0,0 +1,1041 @@ + + + + + +NonEmptyList (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class NonEmptyList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.NonEmptyList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class NonEmptyList<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list with total head and tail.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      NonEmptyList<A>append(List<A> as) +
      Appends the given list to this list.
      +
      NonEmptyList<A>append(NonEmptyList<A> as) +
      Appends the given list to this list.
      +
      <B> NonEmptyList<B>bind(F<A,NonEmptyList<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      NonEmptyList<A>cons(A a) +
      Prepend the given value to this list.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldRight1(F<A,F<A,A>> f) +
      Performs a right-fold reduction across this list.
      +
      AfoldRight1(F2<A,A,A> f) +
      Performs a right-fold reduction across this list.
      +
      static <A> Option<NonEmptyList<A>>fromList(List<A> as) +
      Returns a potential non-empty list from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this linked list.
      +
      NonEmptyList<A>intersperse(A a) +
      Intersperses the given argument between each element of this non empty list.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this non-empty list.
      +
      static <A> NonEmptyList<A>join(NonEmptyList<NonEmptyList<A>> o) +
      Concatenate (join) a non empty list of non empty lists.
      +
      intlength() +
      The length of this list.
      +
      <B> NonEmptyList<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B> NonEmptyList<B>mapTails(F<NonEmptyList<A>,B> f) +
      Maps the given function across the tails of this list (comonad pattern).
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this non empty list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this non empty list according to the given ordering.
      +
      static <A> F<A,NonEmptyList<A>>nel() +
      Returns a function that puts an element into a non-empty list.
      +
      static <A> NonEmptyList<A>nel(A head, + A... tail) +
      Constructs a non empty list from the given elements.
      +
      static <A> NonEmptyList<A>nel(A head, + List<A> tail) +
      Return a non-empty list with the given head and tail.
      +
      NonEmptyList<A>reverse() +
      Reverse this non empty list in constant stack space.
      +
      NonEmptyList<A>snoc(A a) +
      Appends (snoc) the given element to this non empty list to produce a new non empty list.
      +
      NonEmptyList<A>sort(Ord<A> o) +
      Sorts this non empty list using the given order over elements using a merge sort algorithm.
      +
      NonEmptyList<NonEmptyList<A>>sublists() +
      Returns a NonEmptyList of the sublists of this list.
      +
      List<A>tail() +
      This list without the first element.
      +
      NonEmptyList<NonEmptyList<A>>tails() +
      Returns a NonEmptyList of the tails of this list.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this non-empty list.
      +
      static <A> F<NonEmptyList<A>,List<A>>toList_() +
      Returns a function that takes a non-empty list to a list.
      +
      List<A>toList() +
      Returns a List projection of this list.
      +
      java.lang.StringtoString() 
      static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>>unzip(NonEmptyList<P2<A,B>> xs) +
      Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
      +
      <B> NonEmptyList<P2<A,B>>zip(NonEmptyList<B> bs) +
      Zips this non empty list with the given non empty list to produce a list of pairs.
      +
      NonEmptyList<P2<A,java.lang.Integer>>zipIndex() +
      Zips this non empty list with the index of its element as a pair.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this non-empty list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this linked list.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public List<A> tail()
        +
        This list without the first element.
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public NonEmptyList<A> cons(A a)
        +
        Prepend the given value to this list.
        +
        +
        Parameters:
        +
        a - The value to prepend.
        +
        Returns:
        +
        A non-empty list with an extra element.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public NonEmptyList<A> snoc(A a)
        +
        Appends (snoc) the given element to this non empty list to produce a new non empty list. O(n).
        +
        +
        Parameters:
        +
        a - The element to append to this non empty list.
        +
        Returns:
        +
        A new non empty list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(NonEmptyList<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F2<A,A,A> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> NonEmptyList<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> NonEmptyList<B> bind(F<A,NonEmptyList<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sublists

        +
        public NonEmptyList<NonEmptyList<A>> sublists()
        +
        Returns a NonEmptyList of the sublists of this list.
        +
        +
        Returns:
        +
        a NonEmptyList of the sublists of this list.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public NonEmptyList<NonEmptyList<A>> tails()
        +
        Returns a NonEmptyList of the tails of this list. A list is considered a tail of itself for the purpose of this + function (Comonad pattern).
        +
        +
        Returns:
        +
        A NonEmptyList of the tails of this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapTails

        +
        public <B> NonEmptyList<B> mapTails(F<NonEmptyList<A>,B> f)
        +
        Maps the given function across the tails of this list (comonad pattern).
        +
        +
        Parameters:
        +
        f - The function to map across the tails of this list.
        +
        Returns:
        +
        The results of applying the given function to the tails of this list, as a NonEmptyList.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public NonEmptyList<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this non empty list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this non empty list.
        +
        Returns:
        +
        A non empty list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public NonEmptyList<A> reverse()
        +
        Reverse this non empty list in constant stack space.
        +
        +
        Returns:
        +
        A new non empty list with the elements in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public NonEmptyList<A> sort(Ord<A> o)
        +
        Sorts this non empty list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this non empty list.
        +
        Returns:
        +
        A sorted non empty list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> NonEmptyList<P2<A,B>> zip(NonEmptyList<B> bs)
        +
        Zips this non empty list with the given non empty list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public NonEmptyList<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this non empty list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new non empty list with the same length as this list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>> unzip(NonEmptyList<P2<A,B>> xs)
        +
        Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
        +
        +
        Parameters:
        +
        xs - The non empty list of pairs to transform.
        +
        Returns:
        +
        A non empty list of first components and a non empty list of second components.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a List projection of this list.
        +
        +
        Returns:
        +
        A List projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this non-empty list.
        +
        +
        Returns:
        +
        An immutable collection of this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toList_

        +
        public static <A> F<NonEmptyList<A>,List<A>> toList_()
        +
        Returns a function that takes a non-empty list to a list.
        +
        +
        Returns:
        +
        A function that takes a non-empty list to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        public static <A> NonEmptyList<A> nel(A head,
+                                      List<A> tail)
        +
        Return a non-empty list with the given head and tail.
        +
        +
        Parameters:
        +
        head - The first element of the new list.
        +
        tail - The remaining elements of the new list.
        +
        Returns:
        +
        A non-empty list with the given head and tail.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        @SafeVarargs
+public static <A> NonEmptyList<A> nel(A head,
+                                                   A... tail)
        +
        Constructs a non empty list from the given elements.
        +
        +
        Parameters:
        +
        head - The first in the non-empty list.
        +
        tail - The elements to construct a list's tail with.
        +
        Returns:
        +
        A non-empty list with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        nel

        +
        public static <A> F<A,NonEmptyList<A>> nel()
        +
        Returns a function that puts an element into a non-empty list.
        +
        +
        Returns:
        +
        A function that puts an element into a non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> Option<NonEmptyList<A>> fromList(List<A> as)
        +
        Returns a potential non-empty list from the given list. A non-value is returned if the given list is empty.
        +
        +
        Parameters:
        +
        as - The list to construct a potential non-empty list with.
        +
        Returns:
        +
        A potential non-empty list from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> NonEmptyList<A> join(NonEmptyList<NonEmptyList<A>> o)
        +
        Concatenate (join) a non empty list of non empty lists.
        +
        +
        Parameters:
        +
        o - The non empty list of non empty lists to join.
        +
        Returns:
        +
        A new non empty list that is the concatenation of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.nonEmptyListEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Option.Optic.html b/javadoc/4.8/functionaljava/fj/data/Option.Optic.html new file mode 100644 index 0000000..65966de --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Option.Optic.html @@ -0,0 +1,274 @@ + + + + + +Option.Optic (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Option.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Option<A>
    +
    +
    +
    +
    public static final class Option.Optic
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Prism<Option<A>,Unit>none() +
      None prism
      +
      static <A,B> PPrism<Option<A>,Option<B>,A,B>pSome() +
      Polymorphic Some prism
      +
      static <A> Prism<Option<A>,A>some() +
      Monomorphic Some prism
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        none

        +
        public static <A> Prism<Option<A>,Unit> none()
        +
        None prism
        +
        • +
      + + + +
        +
      • +

        pSome

        +
        public static <A,B> PPrism<Option<A>,Option<B>,A,B> pSome()
        +
        Polymorphic Some prism
        +
        • +
      + + + +
        +
      • +

        some

        +
        public static <A> Prism<Option<A>,A> some()
        +
        Monomorphic Some prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Option.html b/javadoc/4.8/functionaljava/fj/data/Option.html new file mode 100644 index 0000000..3b2aeaf --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Option.html @@ -0,0 +1,2227 @@ + + + + + +Option (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Option<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Option<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    An optional value that may be none (no value) or some (a value). This type is a replacement for + the use of null with better type checks.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Option.Optic 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,Option<java.lang.Byte>>parseByte +
      A function that parses a string to a byte.
      +
      static F<java.lang.String,Option<java.lang.Double>>parseDouble +
      A function that parses a string to a double.
      +
      static F<java.lang.String,Option<java.lang.Float>>parseFloat +
      A function that parses a string to a float.
      +
      static F<java.lang.String,Option<java.lang.Integer>>parseInt +
      A function that parses a string to an integer.
      +
      static F<java.lang.String,Option<java.lang.Long>>parseLong +
      A function that parses a string to a long.
      +
      static F<java.lang.String,Option<java.lang.Short>>parseShort +
      A function that parses a string to a short.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Option<B>apply(Option<F<A,B>> of) +
      Performs function application within an optional value (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this optional value.
      +
      static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>>bind() +
      First-class bind function.
      +
      <B> Option<B>bind(F<A,Option<B>> f) +
      Binds the given function across the element of this optional value with a final join.
      +
      <B,C> Option<C>bind(Option<B> ob, + F<A,F<B,C>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D> Option<D>bind(Option<B> ob, + Option<C> oc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E> Option<E>bind(Option<B> ob, + Option<C> oc, + Option<D> od, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$>
      Option<F$>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G>
      Option<G>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H>
      Option<H>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H,I>
      Option<I>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B> Option<P2<A,B>>bindProduct(Option<B> ob) 
      <B,C> Option<P3<A,B,C>>bindProduct(Option<B> ob, + Option<C> oc) 
      <B,C,D> Option<P4<A,B,C,D>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od) 
      <B,C,D,E> Option<P5<A,B,C,D,E>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe) 
      <B,C,D,E,F$>
      Option<P6<A,B,C,D,E,F$>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of) 
      <B,C,D,E,F$,G>
      Option<P7<A,B,C,D,E,F$,G>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og) 
      <B,C,D,E,F$,G,H>
      Option<P8<A,B,C,D,E,F$,G,H>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
      +
      Option<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for the value of this optional value.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for the value of this optional value.
      +
      static <T> F<T,Option<T>>fromNull() +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <T> Option<T>fromNull(T t) +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <A> F<Option<A>,A>fromSome() +
      Returns a function that takes an optional value to a value or errors if there is no value.
      +
      static F<java.lang.String,Option<java.lang.String>>fromString() +
      Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
      +
      static Option<java.lang.String>fromString(java.lang.String s) +
      Returns an optional non-empty string, or no value if the given string is empty.
      +
      inthashCode() 
      static <A> F2<F<A,java.lang.Boolean>,A,Option<A>>iif() +
      First-class version of the iif function.
      +
      static <A> Option<A>iif(boolean p, + A a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(boolean p, + F0<A> a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(F<A,java.lang.Boolean> f, + A a) +
      Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
      +
      static <A> F<Option<A>,java.lang.Boolean>isNone_() +
      A first-class version of the isNone method.
      +
      booleanisNone() +
      Returns false if this optional value has a value, true otherwise.
      +
      static <A> F<Option<A>,java.lang.Boolean>isSome_() +
      A first-class version of the isSome method.
      +
      booleanisSome() +
      Returns true if this optional value has a value, false otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this optional value.
      +
      static <A> F<Option<Option<A>>,Option<A>>join() +
      First-class join function.
      +
      static <A> Option<A>join(Option<Option<A>> o) +
      Joins the given optional value of optional value using a bind operation.
      +
      intlength() +
      Returns the length of this optional value; 1 if there is a value, 0 otherwise.
      +
      static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 so that it operates over options.
      +
      <B,C> Option<C>liftM2(Option<B> ob, + F2<A,B,C> f) +
      Lift the function of arity-2 through options.
      +
      static <A,B> F<F<A,B>,F<Option<A>,Option<B>>>map() +
      A first-class map function.
      +
      <B> Option<B>map(F<A,B> f) +
      Maps the given function across this optional value.
      +
      static <T> F<T,Option<T>>none_() 
      static <T> Option<T>none() +
      Constructs an optional value that has no value.
      +
      static <A,B> F<Option<A>,B>option_(B none, + F<A,B> some) +
      First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
      +
      <B> Boption(B b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      <B> Boption(F0<B> b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      Option<A>orElse(F0<Option<A>> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      Option<A>orElse(Option<A> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      AorSome(A a) +
      Returns the value of this optional value or the given argument.
      +
      AorSome(F0<A> a) +
      Returns the value of this optional value or the given argument.
      +
      static <A> Option<List<A>>sequence(List<Option<A>> a) +
      Sequence through the option monad.
      +
      <B> Option<B>sequence(Option<B> o) +
      Performs a bind across the optional value, but ignores the element value in the function.
      +
      static <T> F<T,Option<T>>some_() 
      abstract Asome() +
      Returns the value from this optional value, or fails if there is no value.
      +
      static <T> Option<T>some(T t) +
      Constructs an optional value that has a value of the given argument.
      +
      static <A> List<A>somes(List<Option<A>> as) +
      Returns all the values in the given list.
      +
      static <A> Stream<A>somes(Stream<Option<A>> as) +
      Returns all the values in the given stream.
      +
      Array<A>toArray() +
      Returns an array projection of this optional value.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns an array projection of this optional value.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this optional value.
      +
      static <A,X> F<Option<A>,F<X,Either<X,A>>>toEither() +
      A first-class version of the toEither method.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      <X> Either<X,A>toEither(X x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      List<A>toList() +
      Returns a list projection of this optional value.
      +
      AtoNull() +
      Returns the value from this optional value, or if there is no value, returns null.
      +
      Stream<A>toStream() +
      Returns a stream projection of this optional value.
      +
      java.lang.StringtoString() 
      <X> Validation<X,A>toValidation(X x) 
      <L,B> Either<L,Option<B>>traverseEither(F<A,Either<L,B>> f) 
      <B> IO<Option<B>>traverseIO(F<A,IO<B>> f) 
      <B> List<Option<B>>traverseList(F<A,List<B>> f) 
      <B> Option<Option<B>>traverseOption(F<A,Option<B>> f) 
      <B> P1<Option<B>>traverseP1(F<A,P1<B>> f) 
      <B> Seq<Option<B>>traverseSeq(F<A,Seq<B>> f) 
      <B> F2<Ord<B>,F<A,Set<B>>,Set<Option<B>>>traverseSet() 
      <B> Set<Option<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) 
      <B> Stream<Option<B>>traverseStream(F<A,Stream<B>> f) 
      <E,B> Validation<E,Option<B>>traverseValidation(F<A,Validation<E,B>> f) 
      AvalueE(F0<java.lang.String> message) +
      Returns the value of this optional value or fails with the given message.
      +
      AvalueE(java.lang.String message) +
      Returns the value of this optional value or fails with the given message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Option<java.lang.Byte>> parseByte
        +
        A function that parses a string to a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Option<java.lang.Double>> parseDouble
        +
        A function that parses a string to a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Option<java.lang.Float>> parseFloat
        +
        A function that parses a string to a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Option<java.lang.Integer>> parseInt
        +
        A function that parses a string to an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Option<java.lang.Long>> parseLong
        +
        A function that parses a string to a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Option<java.lang.Short>> parseShort
        +
        A function that parses a string to a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this optional value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some

        +
        public abstract A some()
        +
        Returns the value from this optional value, or fails if there is no value.
        +
        +
        Returns:
        +
        The value from this optional value, or fails if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        isSome

        +
        public final boolean isSome()
        +
        Returns true if this optional value has a value, false otherwise.
        +
        +
        Returns:
        +
        true if this optional value has a value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNone

        +
        public final boolean isNone()
        +
        Returns false if this optional value has a value, true otherwise.
        +
        +
        Returns:
        +
        false if this optional value has a value, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSome_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isSome_()
        +
        A first-class version of the isSome method.
        +
        +
        Returns:
        +
        A function that returns true if a given optional value has a value, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isNone_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isNone_()
        +
        A first-class version of the isNone method.
        +
        +
        Returns:
        +
        A function that returns false if a given optional value has a value, otherwise true.
        +
        +
        • +
      + + + + + +
        +
      • +

        option

        +
        public final <B> B option(B b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public final <B> B option(F0<B> b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        Returns the length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        Returns:
        +
        The length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        orSome

        +
        public final A orSome(F0<A> a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSome

        +
        public final A orSome(A a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(F0<java.lang.String> message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(java.lang.String message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Option<B> map(F<A,B> f)
        +
        Maps the given function across this optional value.
        +
        +
        Parameters:
        +
        f - The function to map across this optional value.
        +
        Returns:
        +
        A new optional value after the given function has been applied to its element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Option<A>,Option<B>>> map()
        +
        A first-class map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Option<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new optional value whose value matches the given predicate if it has one.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Option<B> bind(F<A,Option<B>> f)
        +
        Binds the given function across the element of this optional value with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this optional value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Option<C> bind(Option<B> ob,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Option<D> bind(Option<B> ob,
+                                    Option<C> oc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Option<E> bind(Option<B> ob,
+                                      Option<C> oc,
+                                      Option<D> od,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Option<F$> bind(Option<B> ob,
+                                          Option<C> oc,
+                                          Option<D> od,
+                                          Option<E> oe,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Option<G> bind(Option<B> ob,
+                                           Option<C> oc,
+                                           Option<D> od,
+                                           Option<E> oe,
+                                           Option<F$> of,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Option<H> bind(Option<B> ob,
+                                             Option<C> oc,
+                                             Option<D> od,
+                                             Option<E> oe,
+                                             Option<F$> of,
+                                             Option<G> og,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Option<I> bind(Option<B> ob,
+                                               Option<C> oc,
+                                               Option<D> od,
+                                               Option<E> oe,
+                                               Option<F$> of,
+                                               Option<G> og,
+                                               Option<H> oh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        oh - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bindProduct

        +
        public final <B> Option<P2<A,B>> bindProduct(Option<B> ob)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequence

        +
        public final <B> Option<B> sequence(Option<B> o)
        +
        Performs a bind across the optional value, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        o - The optional value to apply in the final join.
        +
        Returns:
        +
        A new optional value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <L,B> Either<L,Option<B>> traverseEither(F<A,Either<L,B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<Option<B>> traverseIO(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<Option<B>> traverseList(F<A,List<B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<Option<B>> traverseP1(F<A,P1<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public final <B> Seq<Option<B>> traverseSeq(F<A,Seq<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public final <B> Set<Option<B>> traverseSet(Ord<B> ord,
+                                            F<A,Set<B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        apply

        +
        public final <B> Option<B> apply(Option<F<A,B>> of)
        +
        Performs function application within an optional value (applicative functor pattern).
        +
        +
        Parameters:
        +
        of - The optional value of functions to apply.
        +
        Returns:
        +
        A new optional value after applying the given optional value of functions through this + optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(F0<Option<A>> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(Option<A> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(X x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toValidation

        +
        public final <X> Validation<X,A> toValidation(X x)
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public static <A,X> F<Option<A>,F<X,Either<X,A>>> toEither()
        +
        A first-class version of the toEither method.
        +
        +
        Returns:
        +
        A function that returns an either projection of a given optional value, given a value to + return in left.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this optional value.
        +
        +
        Returns:
        +
        A list projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this optional value.
        +
        +
        Returns:
        +
        A stream projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns an array projection of this optional value.
        +
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns an array projection of this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toNull

        +
        public final A toNull()
        +
        Returns the value from this optional value, or if there is no value, returns null. + This is intended for interfacing with APIs that expect a null for non-existence.
        +
        +
        Returns:
        +
        This optional value or null if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this optional value.
        +
        +
        Returns:
        +
        An immutable collection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some_

        +
        public static <T> F<T,Option<T>> some_()
        +
        • +
      + + + + + +
        +
      • +

        some

        +
        public static <T> Option<T> some(T t)
        +
        Constructs an optional value that has a value of the given argument.
        +
        +
        Parameters:
        +
        t - The value for the returned optional value.
        +
        Returns:
        +
        An optional value that has a value of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        none_

        +
        public static <T> F<T,Option<T>> none_()
        +
        • +
      + + + +
        +
      • +

        none

        +
        public static <T> Option<T> none()
        +
        Constructs an optional value that has no value.
        +
        +
        Returns:
        +
        An optional value that has no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromNull

        +
        public static <T> Option<T> fromNull(T t)
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Parameters:
        +
        t - The unsafe nullable value.
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + +
        +
      • +

        fromNull

        +
        public static <T> F<T,Option<T>> fromNull()
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + + + +
        +
      • +

        option_

        +
        public static final <A,B> F<Option<A>,B> option_(B none,
+                                                 F<A,B> some)
        +
        First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
        +
        +
        Parameters:
        +
        none - The value to return if this optional value has no value.
        +
        some - The function to apply to the value of this optional value.
        +
        Returns:
        +
        the reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Option<A> join(Option<Option<A>> o)
        +
        Joins the given optional value of optional value using a bind operation.
        +
        +
        Parameters:
        +
        o - The optional value of optional value to join.
        +
        Returns:
        +
        A new optional value that is the join of the given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Option<List<A>> sequence(List<Option<A>> a)
        +
        Sequence through the option monad.
        +
        +
        Parameters:
        +
        a - The list of option to sequence.
        +
        Returns:
        +
        The option of list after sequencing.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(F<A,java.lang.Boolean> f,
+                                A a)
        +
        Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        Parameters:
        +
        f - The predicate to test on the given argument.
        +
        a - The argument to test the predicate on and potentially use as the value of the returned + optional value.
        +
        Returns:
        +
        an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                F0<A> a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                A a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> F2<F<A,java.lang.Boolean>,A,Option<A>> iif()
        +
        First-class version of the iif function.
        +
        +
        Returns:
        +
        a function that returns an optional value that has a value of the given argument, if the given predicate + holds on that argument, or no value otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> List<A> somes(List<Option<A>> as)
        +
        Returns all the values in the given list.
        +
        +
        Parameters:
        +
        as - The list of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> Stream<A> somes(Stream<Option<A>> as)
        +
        Returns all the values in the given stream.
        +
        +
        Parameters:
        +
        as - The stream of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Option<java.lang.String> fromString(java.lang.String s)
        +
        Returns an optional non-empty string, or no value if the given string is empty.
        +
        +
        Parameters:
        +
        s - A string to turn into an optional non-empty string.
        +
        Returns:
        +
        an optional non-empty string, or no value if the given string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.String>> fromString()
        +
        Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        Returns:
        +
        a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        fromSome

        +
        public static <A> F<Option<A>,A> fromSome()
        +
        Returns a function that takes an optional value to a value or errors if there is no value.
        +
        +
        Returns:
        +
        A function that takes an optional value to a value or errors if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 so that it operates over options.
        +
        +
        Parameters:
        +
        f - A function to promote.
        +
        Returns:
        +
        The given function promoted to operate on options.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> Option<C> liftM2(Option<B> ob,
+                                    F2<A,B,C> f)
        +
        Lift the function of arity-2 through options.
        +
        +
        Parameters:
        +
        f - A function to lift.
        +
        Returns:
        +
        An optional result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>> bind()
        +
        First-class bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across an option with a final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Option<Option<A>>,Option<A>> join()
        +
        First-class join function.
        +
        +
        Returns:
        +
        A function that joins an Option of an Option to make a single Option.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/PriorityQueue.html b/javadoc/4.8/functionaljava/fj/data/PriorityQueue.html new file mode 100644 index 0000000..0c6a47e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/PriorityQueue.html @@ -0,0 +1,646 @@ + + + + + +PriorityQueue (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class PriorityQueue<K,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.PriorityQueue<K,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PriorityQueue<K,A>
+extends java.lang.Object
    +
    A priority queue implementation backed by a + FingerTree. The finger tree nodes are + annotated with type K, are combined using a monoid of K and both the + key and value are stored in the leaf. Priorities of the same value + are returned FIFO (first in, first out). + + Created by MarkPerry on 31 May 16.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        priorityQueue

        +
        public static <K,A> PriorityQueue<K,A> priorityQueue(Equal<K> e,
+                                                     FingerTree<K,P2<K,A>> ft)
        +
        Creates a priority queue from a finger tree.
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <K,A> PriorityQueue<K,A> empty(Monoid<K> m,
+                                             Equal<K> e)
        +
        Creates an empty priority queue.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations.
        +
        e - A value to compare key equality.
        +
        +
        • +
      + + + +
        +
      • +

        emptyInt

        +
        public static <A> PriorityQueue<java.lang.Integer,A> emptyInt()
        +
        An empty priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> PriorityQueue<K,B> map(F<A,B> f)
        +
        Maps the values in each node with function f.
        +
        • +
      + + + +
        +
      • +

        filterValues

        +
        public PriorityQueue<K,A> filterValues(F<A,java.lang.Boolean> f)
        +
        Filters nodes based on the value inside each node.
        +
        • +
      + + + +
        +
      • +

        filterKeys

        +
        public PriorityQueue<K,A> filterKeys(F<K,java.lang.Boolean> f)
        +
        Filters the nodes based on the annotation of each node.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Is the tree empty?
        +
        • +
      + + + +
        +
      • +

        top

        +
        public Option<P2<K,A>> top()
        +
        If the tree is not empty, returns the node with highest priority otherwise returns nothing.
        +
        • +
      + + + +
        +
      • +

        topN

        +
        public List<P2<K,A>> topN()
        +
        Returns all the elements of the queue with the highest (same) priority.
        +
        • +
      + + + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(K k,
+                                  A a)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(List<P2<K,A>> list)
        +
        Adds nodes using the list of products with priority k and value a. This operation takes O(list.length()).
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Does the priority k exist already?
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(java.lang.Iterable<P2<K,A>> it)
        +
        Adds nodes using the iterable of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(P2<K,A> p)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue()
        +
        Removes the node with the highest priority.
        +
        • +
      + + + +
        +
      • +

        topDequeue

        +
        public P2<Option<P2<K,A>>,PriorityQueue<K,A>> topDequeue()
        +
        Returns a tuple of the node with the highest priority and the rest of the priority queue.
        +
        • +
      + + + + + +
        +
      • +

        unqueue

        +
        public <B> B unqueue(B empty,
+                     F2<P2<K,A>,PriorityQueue<K,A>,B> topDequeue)
        +
        Performs a reduction on this priority queue using the given arguments.
        +
        +
        Parameters:
        +
        empty - The value to return if this queue is empty.
        +
        topDequeue - The function to apply to the top priority element and the tail of the queue (without its top element).
        +
        Returns:
        +
        A reduction on this queue.
        +
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue(int n)
        +
        Removes the top n elements with the highest priority.
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(Ord<K> ok,
+                          K k)
        +
        Does the top of the queue have lower priority than k?
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(Ord<K> ok,
+                             K k)
        +
        • +
      + + + + + +
        +
      • +

        isEqual

        +
        public boolean isEqual(Ord<K> ok,
+                       K k)
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,A>> toStream()
        +
        Returns a stream of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,A>> toList()
        +
        Returns a list of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Reader.html b/javadoc/4.8/functionaljava/fj/data/Reader.html new file mode 100644 index 0000000..12a3155 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Reader.html @@ -0,0 +1,366 @@ + + + + + +Reader (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Reader<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Reader<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Reader<A,B>
+extends java.lang.Object
    +
    The Reader monad (also called the function monad, so equivalent to the idea of F). + Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Reader

        +
        public Reader(F<A,B> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFunction

        +
        public final F<A,B> getFunction()
        +
        • +
      + + + +
        +
      • +

        unit

        +
        public static <A,B> Reader<A,B> unit(F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> Reader<A,B> constant(B b)
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        public final B f(A a)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <C> Reader<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> Reader<A,C> andThen(F<B,C> f)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/SafeIO.html b/javadoc/4.8/functionaljava/fj/data/SafeIO.html new file mode 100644 index 0000000..14d8255 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/SafeIO.html @@ -0,0 +1,229 @@ + + + + + +SafeIO (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface SafeIO<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IO<A>
    +
    +
    +
    +
    public interface SafeIO<A>
+extends IO<A>
    +
    Created by MarkPerry on 3/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
        +
        +
        Specified by:
        +
        run in interface IO<A>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Seq.html b/javadoc/4.8/functionaljava/fj/data/Seq.html new file mode 100644 index 0000000..bbf0096 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Seq.html @@ -0,0 +1,1011 @@ + + + + + +Seq (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Seq<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Seq<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Seq<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an immutable finite sequence, implemented as a finger tree. This structure gives O(1) access to + the head and tail, as well as O(log n) random access and concatenation of sequences.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Seq<A>append(Seq<A> as) +
      Appends the given sequence to this sequence.
      +
      static <A> Seq<A>arraySeq(A... as) +
      Constructs a sequence from the array.
      +
      Seq<A>cons(A a) +
      Inserts the given element at the front of this sequence.
      +
      Seq<A>delete(int i) +
      Delete the element at the given index.
      +
      Seq<A>drop(int n) +
      Drops the given number of elements from the head of this sequence if they are available.
      +
      static <A> Seq<A>empty() +
      The empty sequence.
      +
      booleanequals(java.lang.Object other) 
      Seq<A>filter(F<A,java.lang.Boolean> f) 
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      static <A> Seq<A>fromJavaList(java.util.List<A> list) +
      Constructs a sequence from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this sequence.
      +
      Option<A>headOption() 
      Aindex(int i) +
      Returns the element at the given index.
      +
      Seq<A>init() +
      The sequence without the last element.
      +
      Seq<A>insert(int index, + A a) +
      Inserts the element at the given index.
      +
      booleanisEmpty() +
      Checks if this is the empty sequence.
      +
      booleanisNotEmpty() +
      Checks if this sequence is not empty.
      +
      static <A> Seq<A>iterableSeq(java.lang.Iterable<A> i) +
      Constructs a sequence from the iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this seq.
      +
      static <A> Seq<A>iteratorSeq(java.util.Iterator<A> i) +
      Constructs a sequence from the iterator.
      +
      Alast() +
      The last element of this sequence.
      +
      intlength() +
      Returns the number of elements in this sequence.
      +
      static <A> Seq<A>listSeq(List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSeq(java.lang.Iterable<A>)
      +
      +
      <B> Seq<B>map(F<A,B> f) 
      static <A> Seq<A>seq(A... as) +
      Constructs a sequence from the given elements.
      +
      static <A> Seq<A>seq(List<A> list) +
      Deprecated.  +
      As of release 4.5, use listSeq(List)
      +
      +
      static <A> Seq<A>single(A a) +
      A singleton sequence.
      +
      Seq<A>snoc(A a) +
      Inserts the given element at the end of this sequence.
      +
      P2<Seq<A>,Seq<A>>split(int i) +
      Splits this sequence into a pair of sequences at the given position.
      +
      Seq<A>tail() +
      The sequence without the first element.
      +
      Seq<A>take(int n) +
      Takes the given number of elements from the head of this sequence if they are available.
      +
      java.util.List<A>toJavaList() +
      Converts the sequence to a java.util.List
      +
      List<A>toList() +
      Converts this sequence to a List
      +
      Stream<A>toStream() +
      Converts this sequence to a Stream
      +
      java.lang.StringtoString() 
      Seq<A>update(int i, + A a) +
      Replace the element at the given index with the supplied value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <A> Seq<A> empty()
        +
        The empty sequence.
        +
        +
        Returns:
        +
        A sequence with no elements.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Seq<A> single(A a)
        +
        A singleton sequence.
        +
        +
        Parameters:
        +
        a - The single element in the sequence.
        +
        Returns:
        +
        A new sequence with the given element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        seq

        +
        @SafeVarargs
+public static <A> Seq<A> seq(A... as)
        +
        Constructs a sequence from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to create the sequence from.
        +
        Returns:
        +
        A sequence with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        seq

        +
        @Deprecated
+public static <A> Seq<A> seq(List<A> list)
        +
        Deprecated. As of release 4.5, use listSeq(List)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the given elements in the list.
        +
        +
        • +
      + + + +
        +
      • +

        listSeq

        +
        @Deprecated
+public static <A> Seq<A> listSeq(List<A> list)
        +
        Deprecated. As of release 4.5, use iterableSeq(java.lang.Iterable<A>)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSeq

        +
        public static <A> Seq<A> iterableSeq(java.lang.Iterable<A> i)
        +
        Constructs a sequence from the iterable.
        +
        +
        Parameters:
        +
        i - The iterable to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSeq

        +
        public static <A> Seq<A> iteratorSeq(java.util.Iterator<A> i)
        +
        Constructs a sequence from the iterator.
        +
        +
        Parameters:
        +
        i - The iterator to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySeq

        +
        @SafeVarargs
+public static <A> Seq<A> arraySeq(A... as)
        +
        Constructs a sequence from the array.
        +
        • +
      + + + +
        +
      • +

        fromJavaList

        +
        public static <A> Seq<A> fromJavaList(java.util.List<A> list)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public Seq<A> cons(A a)
        +
        Inserts the given element at the front of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the front of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public Seq<A> snoc(A a)
        +
        Inserts the given element at the end of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the end of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public Option<A> headOption()
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        The last element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public Seq<A> tail()
        +
        The sequence without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public Seq<A> init()
        +
        The sequence without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Converts this sequence to a Stream
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Converts this sequence to a List
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the sequence to a java.util.List
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this seq. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this seq.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Seq<A> append(Seq<A> as)
        +
        Appends the given sequence to this sequence.
        +
        +
        Parameters:
        +
        as - A sequence to append to this one.
        +
        Returns:
        +
        A new sequence with the given sequence appended to this one.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this is the empty sequence.
        +
        +
        Returns:
        +
        True if this sequence is empty, otherwise false.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public Seq<A> insert(int index,
+                     A a)
        +
        Inserts the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        index - The index of the element to return.
        +
        Returns:
        +
        The sequence with the element inserted at the given index, + or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Checks if this sequence is not empty.
        +
        +
        Returns:
        +
        True if this sequence is not empty, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in this sequence.
        +
        +
        Returns:
        +
        the number of elements in this sequence.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public P2<Seq<A>,Seq<A>> split(int i)
        +
        Splits this sequence into a pair of sequences at the given position. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subsequence containing elements with indices less than i + and the subsequence containing elements with indices greater than or equal to i.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public A index(int i)
        +
        Returns the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to return.
        +
        Returns:
        +
        The element at the given index, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public Seq<A> update(int i,
+                     A a)
        +
        Replace the element at the given index with the supplied value. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        a - The new value.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Seq<A> delete(int i)
        +
        Delete the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public Seq<A> take(int n)
        +
        Takes the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The maximum number of elements to take from this sequence.
        +
        Returns:
        +
        A sequence consisting only of the first n elements of this sequence, or else the whole sequence, + if it has less than n elements.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public Seq<A> drop(int n)
        +
        Drops the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The number of elements to drop from this sequence.
        +
        Returns:
        +
        A sequence consisting of all elements of this sequence except the first n ones, or else the empty sequence, + if this sequence has less than n elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B z)
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Seq<A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Seq<B> map(F<A,B> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Set.html b/javadoc/4.8/functionaljava/fj/data/Set.html new file mode 100644 index 0000000..7f07376 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Set.html @@ -0,0 +1,1370 @@ + + + + + +Set (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Set<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Set<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Set<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable set, implemented as a red/black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> Set<A>arraySet(Ord<A> o, + A... as) +
      Return the elements of the given iterator as a set.
      +
      <B> Set<B>bind(Ord<B> o, + F<A,Set<B>> f) +
      Binds the given function across this set.
      +
      F<A,F<Set<A>,Set<A>>>delete() +
      First-class deletion function.
      +
      Set<A>delete(A a) +
      Deletes the given element from this set.
      +
      static <A> Set<A>empty(Ord<A> ord) +
      The empty set.
      +
      booleanequals(java.lang.Object other) 
      Set<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this Set using the given monoid.
      +
      <B> BfoldMapRight(F<A,B> f, + Monoid<B> m) +
      Folds this Set from the right using the given monoid.
      +
      static <A> Set<A>fromList(Ord<A> o, + List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
      +
      +
      inthashCode() 
      static <A> F<A,F<Set<A>,Set<A>>>insert() +
      First-class insertion function.
      +
      Set<A>insert(A x) +
      Inserts the given element into this set.
      +
      static <A> F<Set<A>,F<Set<A>,Set<A>>>intersect() +
      A first class function for intersect(Set).
      +
      Set<A>intersect(Set<A> s) +
      Remove all elements from this set that do not occur in the given set.
      +
      booleanisEmpty() 
      static <A> Set<A>iterableSet(Ord<A> o, + java.lang.Iterable<A> as) +
      Return the elements of the given iterable as a set.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator over this set.
      +
      static <A> Set<A>iteratorSet(Ord<A> o, + java.util.Iterator<A> as) +
      Return the elements of the given iterator as a set.
      +
      static <A> Set<A>join(Ord<A> o, + Set<Set<A>> s) +
      Join a set of sets into a single set.
      +
      Option<A>lookup(A a) +
      Find element equal to the given one.
      +
      Option<A>lookupGE(A a) +
      Find smallest element greater or equal to the given one.
      +
      Option<A>lookupGT(A a) +
      Find smallest element greater than the given one.
      +
      Option<A>lookupLE(A a) +
      Find largest element smaller or equal to the given one.
      +
      Option<A>lookupLT(A a) +
      Find largest element smaller than the given one.
      +
      <B> Set<B>map(Ord<B> o, + F<A,B> f) +
      Maps the given function across this set.
      +
      Option<A>max() 
      static <A> F<Set<A>,F<A,java.lang.Boolean>>member() +
      First-class membership check.
      +
      booleanmember(A x) +
      Checks if the given element is a member of this set.
      +
      Option<A>min() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>minus() +
      A first class function for minus(Set).
      +
      Set<A>minus(Set<A> s) +
      Remove all elements from this set that occur in the given set.
      +
      Ord<A>ord() +
      Returns the order of this Set.
      +
      static <A> Set<A>set(Ord<A> o, + A... as) +
      Constructs a set from the given elements.
      +
      static <A> Set<A>set(Ord<A> o, + List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
      +
      +
      static <A> Set<A>single(Ord<A> o, + A a) +
      Returns a set with a single element.
      +
      intsize() +
      Returns the size of this set.
      +
      P3<Set<A>,Option<A>,Set<A>>split(A a) +
      Splits this set at the given element.
      +
      booleansubsetOf(Set<A> s) +
      Returns true if this set is a subset of the given set.
      +
      java.util.HashSet<A>toJavaHashSet() +
      Returns a java.util.HashSet representation of this set.
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List representation of this set.
      +
      java.util.Set<A>toJavaSet() +
      Returns a java.util.Set representation of this set.
      +
      java.util.TreeSet<A>toJavaTreeSet() +
      Returns a java.util.TreeSet representation of this set.
      +
      List<A>toList() +
      Returns a list representation of this set.
      +
      List<A>toListReverse() +
      Returns a list representation of this set in reverse order.
      +
      Stream<A>toStream() +
      Returns a stream representation of this set.
      +
      Stream<A>toStreamReverse() +
      Returns a stream representation of this set in reverse order.
      +
      java.lang.StringtoString() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>union() +
      A first class function for union(Set).
      +
      Set<A>union(Set<A> s) +
      Add all the elements of the given set to this set.
      +
      P2<java.lang.Boolean,Set<A>>update(A a, + F<A,A> f) +
      Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public final Ord<A> ord()
        +
        Returns the order of this Set.
        +
        +
        Returns:
        +
        the order of this Set.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public final P2<java.lang.Boolean,Set<A>> update(A a,
+                                                 F<A,A> f)
        +
        Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
        +
        +
        Parameters:
        +
        a - An element to replace.
        +
        f - A function to transforms the found element.
        +
        Returns:
        +
        A pair of: (1) True if an element was found that matches the given element, otherwise false. + (2) A new set with the given function applied to the first set element + that was equal to the given element.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Set<A> empty(Ord<A> ord)
        +
        The empty set.
        +
        +
        Parameters:
        +
        ord - An order for the type of elements.
        +
        Returns:
        +
        the empty set.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        member

        +
        public final boolean member(A x)
        +
        Checks if the given element is a member of this set.
        +
        +
        Parameters:
        +
        x - An element to check for membership in this set.
        +
        Returns:
        +
        true if the given element is a member of this set.
        +
        +
        • +
      + + + +
        +
      • +

        member

        +
        public static <A> F<Set<A>,F<A,java.lang.Boolean>> member()
        +
        First-class membership check.
        +
        +
        Returns:
        +
        A function that returns true if the given element if a member of the given set.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public final Set<A> insert(A x)
        +
        Inserts the given element into this set.
        +
        +
        Parameters:
        +
        x - An element to insert into this set.
        +
        Returns:
        +
        A new set with the given element inserted.
        +
        +
        • +
      + + + +
        +
      • +

        insert

        +
        public static <A> F<A,F<Set<A>,Set<A>>> insert()
        +
        First-class insertion function.
        +
        +
        Returns:
        +
        A function that inserts a given element into a given set.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator over this set.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator over this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Set<A> single(Ord<A> o,
+                                A a)
        +
        Returns a set with a single element.
        +
        +
        Parameters:
        +
        o - An order for the type of element.
        +
        a - An element to put in a set.
        +
        Returns:
        +
        A new set with the given element in it.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Set<B> map(Ord<B> o,
+                            F<A,B> f)
        +
        Maps the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        f - A function to map across this set.
        +
        Returns:
        +
        The set of the results of applying the given function to the elements of this set.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public final <B> B foldMap(F<A,B> f,
+                           Monoid<B> m)
        +
        Folds this Set using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapRight

        +
        public final <B> B foldMapRight(F<A,B> f,
+                                Monoid<B> m)
        +
        Folds this Set from the right using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set from the right with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list representation of this set.
        +
        +
        Returns:
        +
        a list representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public final java.util.Set<A> toJavaSet()
        +
        Returns a java.util.Set representation of this set.
        +
        +
        Returns:
        +
        a java.util.Set representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaHashSet

        +
        public final java.util.HashSet<A> toJavaHashSet()
        +
        Returns a java.util.HashSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.HashSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaTreeSet

        +
        public final java.util.TreeSet<A> toJavaTreeSet()
        +
        Returns a java.util.TreeSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.TreeSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List representation of this set.
        +
        +
        Returns:
        +
        a java.util.List representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public final List<A> toListReverse()
        +
        Returns a list representation of this set in reverse order.
        +
        +
        Returns:
        +
        a list representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream representation of this set.
        +
        +
        Returns:
        +
        a stream representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public final Stream<A> toStreamReverse()
        +
        Returns a stream representation of this set in reverse order.
        +
        +
        Returns:
        +
        a stream representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Set<B> bind(Ord<B> o,
+                             F<A,Set<B>> f)
        +
        Binds the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the target set.
        +
        f - A function to bind across this set.
        +
        Returns:
        +
        A new set after applying the given function and joining the resulting sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public final Set<A> union(Set<A> s)
        +
        Add all the elements of the given set to this set.
        +
        +
        Parameters:
        +
        s - A set to add to this set.
        +
        Returns:
        +
        A new set containing all elements of both sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> union()
        +
        A first class function for union(Set).
        +
        +
        Returns:
        +
        A function that adds all the elements of one set to another set.
        +
        See Also:
        +
        union(Set)
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Set<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new set whose elements all match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final Set<A> delete(A a)
        +
        Deletes the given element from this set.
        +
        +
        Parameters:
        +
        a - an element to remove.
        +
        Returns:
        +
        A new set containing all the elements of this set, except the given element.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public final F<A,F<Set<A>,Set<A>>> delete()
        +
        First-class deletion function.
        +
        +
        Returns:
        +
        A function that deletes a given element from a given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public final Set<A> intersect(Set<A> s)
        +
        Remove all elements from this set that do not occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to retain.
        +
        Returns:
        +
        A new set which is the intersection of this set and the given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> intersect()
        +
        A first class function for intersect(Set).
        +
        +
        Returns:
        +
        A function that intersects two given sets.
        +
        See Also:
        +
        intersect(Set)
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Set<A> minus(Set<A> s)
        +
        Remove all elements from this set that occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to delete.
        +
        Returns:
        +
        A new set which contains only the elements of this set that do not occur in the given set.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> minus()
        +
        A first class function for minus(Set).
        +
        +
        Returns:
        +
        A function that removes all elements of one set from another set.
        +
        See Also:
        +
        minus(Set)
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final Option<A> min()
        +
        • +
      + + + +
        +
      • +

        max

        +
        public final Option<A> max()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public final int size()
        +
        Returns the size of this set.
        +
        +
        Returns:
        +
        The number of elements in this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public final P3<Set<A>,Option<A>,Set<A>> split(A a)
        +
        Splits this set at the given element. Returns a product-3 of: +
          +
        • A set containing all the elements of this set which are less than the given value.
          • +
        • An option of a value equal to the given value, if one was found in this set, otherwise None. +
        • A set containing all the elements of this set which are greater than the given value.
          • +
        +
        +
        Parameters:
        +
        a - A value at which to split this set.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are less than the given value + and all the elements in the second set are greater than the given value, and the optional value is the + given value if found, otherwise None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public final Option<A> lookup(A a)
        +
        Find element equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some element in this set equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLT

        +
        public final Option<A> lookupLT(A a)
        +
        Find largest element smaller than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGT

        +
        public final Option<A> lookupGT(A a)
        +
        Find smallest element greater than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLE

        +
        public final Option<A> lookupLE(A a)
        +
        Find largest element smaller or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller or equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGE

        +
        public final Option<A> lookupGE(A a)
        +
        Find smallest element greater or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater or equal to the given one, or None.
        +
        +
        • +
      + + + +
        +
      • +

        subsetOf

        +
        public final boolean subsetOf(Set<A> s)
        +
        Returns true if this set is a subset of the given set.
        +
        +
        Parameters:
        +
        s - A set which is a superset of this set if this method returns true.
        +
        Returns:
        +
        true if this set is a subset of the given set.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Set<A> join(Ord<A> o,
+                              Set<Set<A>> s)
        +
        Join a set of sets into a single set.
        +
        +
        Parameters:
        +
        s - A set of sets.
        +
        o - An order for the elements of the new set.
        +
        Returns:
        +
        A new set which is the join of the given set of sets.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSet

        +
        public static <A> Set<A> iterableSet(Ord<A> o,
+                                     java.lang.Iterable<A> as)
        +
        Return the elements of the given iterable as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterable of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSet

        +
        public static <A> Set<A> iteratorSet(Ord<A> o,
+                                     java.util.Iterator<A> as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySet

        +
        @SafeVarargs
+public static <A> Set<A> arraySet(Ord<A> o,
+                                               A... as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        @SafeVarargs
+public static <A> Set<A> set(Ord<A> o,
+                                          A... as)
        +
        Constructs a set from the given elements.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - The elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        @Deprecated
+public static <A> Set<A> set(Ord<A> o,
+                                         List<A> list)
        +
        Deprecated. As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
        +
        Constructs a set from the list.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        list - The elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given list.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/State.html b/javadoc/4.8/functionaljava/fj/data/State.html new file mode 100644 index 0000000..dec6e15 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/State.html @@ -0,0 +1,479 @@ + + + + + +State (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class State<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.State<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class State<S,A>
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static <S,A> State<S,A> unit(F<S,P2<S,A>> runF)
        +
        • +
      + + + +
        +
      • +

        init

        +
        public static <S> State<S,S> init()
        +
        • +
      + + + +
        +
      • +

        units

        +
        public static <S> State<S,S> units(F<S,S> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <S,A> State<S,A> constant(A a)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public static <S,A> State<S,A> gets(F<S,A> f)
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public static <S> State<S,Unit> put(S s)
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public static <S> State<S,Unit> modify(F<S,S> f)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <S,A,B> State<S,B> flatMap(State<S,A> ts,
+                                         F<A,State<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <S,A> State<S,List<A>> sequence(List<State<S,A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        traverse

        +
        public static <S,A,B> State<S,List<B>> traverse(List<A> list,
+                                                F<A,State<S,B>> f)
        +
        Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
        +
        • +
      + + + + + +
        +
      • +

        run

        +
        public P2<S,A> run(S s)
        +
        • +
      + + + + + +
        +
      • +

        eval

        +
        public A eval(S s)
        +
        • +
      + + + + + +
        +
      • +

        exec

        +
        public S exec(S s)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public State<S,S> gets()
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> State<S,B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        mapState

        +
        public <B> State<S,B> mapState(F<P2<S,A>,P2<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        withs

        +
        public State<S,A> withs(F<S,S> f)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Stream.html b/javadoc/4.8/functionaljava/fj/data/Stream.html new file mode 100644 index 0000000..70fdc36 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Stream.html @@ -0,0 +1,3302 @@ + + + + + +Stream (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Stream<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Stream<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Stream<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A lazy (not yet evaluated), immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Stream<A>append(F0<Stream<A>> as) +
      Appends the given stream to this stream.
      +
      Stream<A>append(Stream<A> as) +
      Appends the given stream to this stream.
      +
      <B> Stream<B>apply(Stream<F<A,B>> sf) +
      Performs function application within a stream (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this stream.
      +
      static <A> Stream<A>arrayStream(A... as) 
      static java.lang.StringasString(Stream<java.lang.Character> cs) +
      Returns a string from the given stream of characters.
      +
      static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>>bind_() +
      A first-class version of the bind function.
      +
      <B> Stream<B>bind(F<A,Stream<B>> f) +
      Binds the given function across each element of this stream with a final join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C,D> Stream<D>bind(Stream<B> sb, + Stream<C> sc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E> Stream<E>bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$>
      Stream<F$>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G>
      Stream<G>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H>
      Stream<H>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      Stream<I>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + Stream<H> sh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B> Stream<B>cobind(F<Stream<A>,B> k) +
      Binds the given function across the stream of substreams of this stream.
      +
      static <A> F<A,F<Stream<A>,Stream<A>>>cons_() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      static <A> F<A,F<P1<Stream<A>>,Stream<A>>>cons() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      Stream<A>cons(A a) +
      Prepends (cons) the given element to this stream to product a new stream.
      +
      static <A> Stream<A>cons(A head, + F0<Stream<A>> tail) +
      Prepends the given head element to the given tail element to produce a new stream.
      +
      static <A> Stream<A>cycle(Stream<A> as) +
      Returns an infinite-length stream of the given elements cycling.
      +
      Stream<A>drop(int i) +
      Drops the given number of elements from the head of this stream if they are available.
      +
      Stream<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
      +
      static <A> Stream<A>enumerationStream(java.util.Enumeration<A> e) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
      +
      static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>>filter() +
      Returns a first-class version of the filter function.
      +
      Stream<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>>foldRight() +
      A first-class version of the foldRight function.
      +
      <B> BfoldRight(F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight(F2<A,P1<B>,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this stream.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this stream.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from, + long step) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
      +
      static <A,B> Stream<A>fromFunction(Enumerator<B> e, + F<B,A> f, + B i) +
      Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
      +
      static <A> Stream<A>fromFunction(F<Natural,A> f) +
      Converts a function of natural numbers to a stream.
      +
      static Stream<java.lang.Character>fromString(java.lang.String s) +
      Returns a stream of characters from the given string.
      +
      inthashCode() 
      abstract Ahead() +
      The first element of the stream or fails for the empty stream.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      Option<java.lang.Integer>indexOf(F<A,java.lang.Boolean> p) +
      Returns the position of the first element matching the given predicate, if any.
      +
      Stream<Stream<A>>inits() +
      Returns a stream of all prefixes of this stream.
      +
      Stream<A>interleave(Stream<A> as) +
      Interleaves the given stream with this stream to produce a new stream.
      +
      Stream<A>intersperse(A a) +
      Intersperses the given value between each two elements of the stream.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given stream is empty.
      +
      booleanisEmpty() +
      Returns true if this stream is empty, false otherwise.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given stream is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this stream is empty, true otherwise.
      +
      static <A> Stream<A>iterableStream(java.lang.Iterable<A> i) +
      Takes the given iterable to a stream.
      +
      static <A> F<F<A,A>,F<A,Stream<A>>>iterate() +
      A first-class version of the iterate function.
      +
      static <A> Stream<A>iterate(F<A,A> f, + A a) +
      Returns a stream constructed by applying the given iteration function starting at the given value.
      +
      static <A> Stream<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this stream.
      +
      static <A> Stream<A>iteratorStream(java.util.Iterator<A> it) +
      Constructs a stream with the given elements in the Iterator.
      +
      static <A> F<Stream<Stream<A>>,Stream<A>>join() +
      A first-class version of join
      +
      static <A> Stream<A>join(Stream<Stream<A>> o) +
      Joins the given stream of streams by concatenation.
      +
      Alast() +
      Get the last element of this stream.
      +
      intlength() +
      The length of this stream.
      +
      static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>>map_() +
      Provides a first-class version of the map function.
      +
      <B> Stream<B>map(F<A,B> f) +
      Maps the given function across this stream.
      +
      <B,C> F<B,Stream<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
      +
      Stream<A>minus(Equal<A> eq, + Stream<A> xs) +
      Returns a new stream of all the items in this stream that do not appear in the given stream.
      +
      static <A> P1<Stream<A>>nil_() +
      Returns an empty stream.
      +
      static <A> Stream<A>nil() +
      Returns an empty stream.
      +
      AorHead(F0<A> a) +
      Returns the head of this stream if there is one or the given argument if this stream is empty.
      +
      P1<Stream<A>>orTail(F0<Stream<A>> as) +
      Returns the tail of this stream if there is one or the given argument if this stream is empty.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to, + long step) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
      +
      static Stream<java.lang.Integer>range(int from) +
      Returns an infinite stream of integers from the given from value (inclusive).
      +
      static Stream<java.lang.Integer>range(int from, + long to) +
      Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Stream<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> Stream<A>repeat(A a) +
      Returns an infinite-length stream of the given element.
      +
      Stream<A>replace(F<A,java.lang.Boolean> p, + A a) +
      Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
      +
      Stream<A>reverse() +
      Reverse this stream in constant stack space.
      +
      static <A,B> F<B,Stream<A>>sequence_(Stream<F<B,A>> fs) +
      Turn a stream of functions into a function returning a stream.
      +
      static <A> Stream<P1<A>>sequence(F0<Stream<A>> p) +
      Sequence through the Stream monad.
      +
      static <A> Stream<IO<A>>sequence(IO<Stream<A>> io) +
      Sequence through the Stream monad.
      +
      static <A> Stream<Option<A>>sequence(Option<Stream<A>> o) +
      Sequence through the Stream monad.
      +
      <B> Stream<B>sequence(Stream<B> bs) +
      Performs a bind across each stream element, but ignores the element value each time.
      +
      <B> Stream<B>sequenceW(Stream<F<Stream<A>,B>> fs) +
      Applies a stream of comonadic functions to this stream, returning a stream of values.
      +
      static <A> F<A,Stream<A>>single() +
      Returns a function that yields a stream containing its argument.
      +
      static <A> Stream<A>single(A a) +
      Returns a stream of one element containing the given value.
      +
      Stream<A>snoc(A a) +
      Append the given element to this stream to product a new stream.
      +
      Stream<A>snoc(F0<A> a) +
      Append the given element to this stream to produce a new stream.
      +
      Stream<A>sort(Ord<A> o) +
      Sort this stream according to the given ordering.
      +
      Stream<A>sort(Ord<A> o, + Strategy<Unit> s) +
      Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
      +
      P2<Stream<A>,Stream<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
      +
      P2<Stream<A>,Stream<A>>split(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
      +
      static <A> Stream<A>stream(A... as) +
      Constructs a stream with the given elements.
      +
      <B> Bstream(B nil, + F<A,F<P1<Stream<A>>,B>> cons) +
      Deprecated.  +
      As of release 4.5, use uncons(B, fj.F<A, fj.F<fj.P1<fj.data.Stream<A>>, B>>)
      +
      +
      static <A> Stream<A>stream(java.lang.Iterable<A> it) +
      Deprecated.  +
      As of release 4.5, use iterableStream(Iterable)
      +
      +
      static <A> Stream<A>stream(java.util.Iterator<A> it) +
      Deprecated.  +
      As of release 4.5, use iteratorStream(Iterator)
      +
      +
      Stream<Stream<A>>substreams() +
      Returns a stream of all infixes of this stream.
      +
      abstract P1<Stream<A>>tail() +
      The stream without the first element or fails for the empty stream.
      +
      Stream<Stream<A>>tails() +
      Returns a stream of the suffixes of this stream.
      +
      Stream<A>take(int n) +
      Returns the first n elements from the head of this stream.
      +
      Stream<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this stream that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this stream.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this stream.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this stream.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
      +
      F<java.lang.Integer,A>toFunction() +
      Converts this stream to a function of natural numbers.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List projection of this stream.
      +
      List<A>toList() +
      Returns a list projection of this stream.
      +
      Option<A>toOption() +
      Returns an option projection of this stream; None if empty, or the first element + in Some.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() 
      java.lang.StringtoStringLazy() 
      <B> IO<Stream<B>>traverseIO(F<A,IO<B>> f) +
      Traversable instance of Stream for IO.
      +
      <B> Option<Stream<B>>traverseOption(F<A,Option<B>> f) +
      Traversable instance of Stream for Option.
      +
      <B> Buncons(B nil, + F<A,F<P1<Stream<A>>,B>> cons) +
      Performs a reduction on this stream using the given arguments.
      +
      static <A,B> Stream<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a stream.
      +
      static <A,B> P2<Stream<A>,Stream<B>>unzip(Stream<P2<A,B>> xs) +
      Transforms a stream of pairs into a stream of first components and a stream of second components.
      +
      <B> Stream<B>zapp(Stream<F<A,B>> fs) +
      Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
      +
      <B> Stream<P2<A,B>>zip(Stream<B> bs) +
      Zips this stream with the given stream to produce a stream of pairs.
      +
      Stream<P2<A,java.lang.Integer>>zipIndex() +
      Zips this stream with the index of its element as a pair.
      +
      static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>>zipWith() +
      A first-class version of the zipWith function.
      +
      <B,C> F<Stream<B>,Stream<C>>zipWith(F<A,F<B,C>> f) +
      Partially-applied version of zipWith.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F<A,F<B,C>> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F2<A,B,C> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this stream. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this stream.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        Returns:
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract P1<Stream<A>> tail()
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        Returns:
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this stream is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this stream is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this stream is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this stream is empty, true otherwise.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F<A,F<P1<Stream<A>>,B>> cons)
        +
        Performs a reduction on this stream using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this stream is empty.
        +
        cons - The function to apply to the head and tail of this stream if it is not empty.
        +
        Returns:
        +
        A reduction on this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<P1<B>,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,P1<B>,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this stream is empty.
        +
        Returns:
        +
        The head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final P1<Stream<A>> orTail(F0<Stream<A>> as)
        +
        Returns the tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this stream is empty.
        +
        Returns:
        +
        The tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final Stream<A> intersperse(A a)
        +
        Intersperses the given value between each two elements of the stream.
        +
        +
        Parameters:
        +
        a - The value to intersperse between values of the stream.
        +
        Returns:
        +
        A new stream with the given value between each two elements of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Stream<B> map(F<A,B> f)
        +
        Maps the given function across this stream.
        +
        +
        Parameters:
        +
        f - The function to map across this stream.
        +
        Returns:
        +
        A new stream after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>> map_()
        +
        Provides a first-class version of the map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given stream.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Stream<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(Stream<A> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(F0<Stream<A>> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Stream<A> minus(Equal<A> eq,
+                             Stream<A> xs)
        +
        Returns a new stream of all the items in this stream that do not appear in the given stream.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the streams.
        +
        xs - a list to subtract from this stream.
        +
        Returns:
        +
        a stream of all the items in this stream that do not appear in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final Stream<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,Stream<A>> sequence_(Stream<F<B,A>> fs)
        +
        Turn a stream of functions into a function returning a stream.
        +
        +
        Parameters:
        +
        fs - The stream of functions to sequence into a single function that returns a stream.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given stream to it + and returns a stream of the results.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,Stream<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Stream<B> bind(F<A,Stream<B>> f)
        +
        Binds the given function across each element of this stream with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F2<A,B,C> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Stream<D> bind(Stream<B> sb,
+                                    Stream<C> sc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Stream<E> bind(Stream<B> sb,
+                                      Stream<C> sc,
+                                      Stream<D> sd,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Stream<F$> bind(Stream<B> sb,
+                                          Stream<C> sc,
+                                          Stream<D> sd,
+                                          Stream<E> se,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Stream<G> bind(Stream<B> sb,
+                                           Stream<C> sc,
+                                           Stream<D> sd,
+                                           Stream<E> se,
+                                           Stream<F$> sf,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Stream<H> bind(Stream<B> sb,
+                                             Stream<C> sc,
+                                             Stream<D> sd,
+                                             Stream<E> se,
+                                             Stream<F$> sf,
+                                             Stream<G> sg,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Stream<I> bind(Stream<B> sb,
+                                               Stream<C> sc,
+                                               Stream<D> sd,
+                                               Stream<E> se,
+                                               Stream<F$> sf,
+                                               Stream<G> sg,
+                                               Stream<H> sh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        sh - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> Stream<B> sequence(Stream<B> bs)
        +
        Performs a bind across each stream element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The stream to apply in the final join.
        +
        Returns:
        +
        A new stream after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<IO<A>> sequence(IO<Stream<A>> io)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        io - The IO stream to sequence.
        +
        Returns:
        +
        The stream of IOs after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<P1<A>> sequence(F0<Stream<A>> p)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        p - The lazy stream to sequence.
        +
        Returns:
        +
        The stream of (pre-calculated) lazy values after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<Option<A>> sequence(Option<Stream<A>> o)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        o - The optional stream to sequence.
        +
        Returns:
        +
        The stream of options after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Stream<B> apply(Stream<F<A,B>> sf)
        +
        Performs function application within a stream (applicative functor pattern).
        +
        +
        Parameters:
        +
        sf - The stream of functions to apply.
        +
        Returns:
        +
        A new stream after applying the given stream of functions through this stream.
        +
        +
        • +
      + + + +
        +
      • +

        interleave

        +
        public final Stream<A> interleave(Stream<A> as)
        +
        Interleaves the given stream with this stream to produce a new stream.
        +
        +
        Parameters:
        +
        as - The stream to interleave this stream with.
        +
        Returns:
        +
        A new stream with elements interleaved from this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        enumerationStream

        +
        public static <A> Stream<A> enumerationStream(java.util.Enumeration<A> e)
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o)
        +
        Sort this stream according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o,
+                            Strategy<Unit> s)
        +
        Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        s - A strategy for parallelising the algorithm.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this stream.
        +
        +
        Returns:
        +
        An immutable collection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from,
+                                              long to)
        +
        Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        to - The maximum value for the stream (exclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + + + +
        +
      • +

        stream

        +
        @SafeVarargs
+public static <A> Stream<A> stream(A... as)
        +
        Constructs a stream with the given elements.
        +
        +
        Parameters:
        +
        as - The elements which which to construct a stream.
        +
        Returns:
        +
        a new stream with the given elements.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        iteratorStream

        +
        public static <A> Stream<A> iteratorStream(java.util.Iterator<A> it)
        +
        Constructs a stream with the given elements in the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from,
+                                    long step)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to,
+                                  long step)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from)
        +
        Returns an infinite stream of integers from the given from value (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>> filter()
        +
        Returns a first-class version of the filter function.
        +
        +
        Returns:
        +
        a function that filters a given stream using a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public final <B> Stream<B> zapp(Stream<F<A,B>> fs)
        +
        Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream. If this stream and the given stream + have different lengths, then the longer stream is normalised so this function never fails.
        +
        +
        Parameters:
        +
        fs - The stream of functions to apply to this stream.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> F<Stream<B>,Stream<C>> zipWith(F<A,F<B,C>> f)
        +
        Partially-applied version of zipWith. + Returns a function that zips a given stream with this stream using the given function.
        +
        +
        Parameters:
        +
        f - The function to zip this stream and a given stream with.
        +
        Returns:
        +
        A function that zips a given stream with this stream using the given function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> Stream<P2<A,B>> zip(Stream<B> bs)
        +
        Zips this stream with the given stream to produce a stream of pairs. If this stream and the + given stream have different lengths, then the longer stream is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final Stream<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this stream with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new stream with the same length as this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this stream is empty.
        +
        Returns:
        +
        An either projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<A> toOption()
        +
        Returns an option projection of this stream; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public final A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this stream.
        +
        +
        Returns:
        +
        A list projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List projection of this stream.
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this stream.
        +
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final Stream<A> cons(A a)
        +
        Prepends (cons) the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new stream with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(Stream<java.lang.Character> cs)
        +
        Returns a string from the given stream of characters. The inverse of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The stream of characters to produce the string from.
        +
        Returns:
        +
        A string from the given stream of characters.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Stream<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a stream of characters from the given string. The inverse of this function is asString(Stream).
        +
        +
        Parameters:
        +
        s - The string to produce the stream of characters from.
        +
        Returns:
        +
        A stream of characters from the given string.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(A a)
        +
        Append the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(F0<A> a)
        +
        Append the given element to this stream to produce a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final Stream<A> take(int n)
        +
        Returns the first n elements from the head of this stream.
        +
        +
        Parameters:
        +
        n - The number of elements to take from this stream.
        +
        Returns:
        +
        The first n elements from the head of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final Stream<A> drop(int i)
        +
        Drops the given number of elements from the head of this stream if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this stream.
        +
        Returns:
        +
        A stream with a length the same, or less than, this stream.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final Stream<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this stream that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this stream until it finds an element that does not + hold, or the stream is exhausted.
        +
        Returns:
        +
        The first elements of the head of this stream that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<Stream<B>> traverseIO(F<A,IO<B>> f)
        +
        Traversable instance of Stream for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<Stream<B>> traverseOption(F<A,Option<B>> f)
        +
        Traversable instance of Stream for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final Stream<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this stream.
        +
        Returns:
        +
        The stream whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<Stream<A>,Stream<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public final Stream<A> replace(F<A,java.lang.Boolean> p,
+                               A a)
        +
        Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        Parameters:
        +
        p - The predicate to match replaced elements.
        +
        a - The element with which to replace elements.
        +
        Returns:
        +
        A new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<Stream<A>,Stream<A>> split(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate not to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Stream<A> reverse()
        +
        Reverse this stream in constant stack space.
        +
        +
        Returns:
        +
        A new stream that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Get the last element of this stream. Undefined for infinite streams.
        +
        +
        Returns:
        +
        The last element in this stream, if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this stream. This function will not terminate for an infinite stream.
        +
        +
        Returns:
        +
        The length of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this stream.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this stream, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public final java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public final java.lang.String toStringEager()
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this stream.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + stream.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this stream.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <B> Stream<B> cobind(F<Stream<A>,B> k)
        +
        Binds the given function across the stream of substreams of this stream.
        +
        +
        Parameters:
        +
        k - A function to bind across this stream and its substreams.
        +
        Returns:
        +
        a new stream of the results of applying the given function to this stream and its substreams.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final Stream<Stream<A>> tails()
        +
        Returns a stream of the suffixes of this stream. A stream is considered to be a suffix of itself in this context.
        +
        +
        Returns:
        +
        a stream of the suffixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final Stream<Stream<A>> inits()
        +
        Returns a stream of all prefixes of this stream. A stream is considered a prefix of itself in tnis context.
        +
        +
        Returns:
        +
        a stream of the prefixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        substreams

        +
        public final Stream<Stream<A>> substreams()
        +
        Returns a stream of all infixes of this stream. A stream is considered to contain itself.
        +
        +
        Returns:
        +
        a stream of the infixes of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public final Option<java.lang.Integer> indexOf(F<A,java.lang.Boolean> p)
        +
        Returns the position of the first element matching the given predicate, if any.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        the position of the first element matching the given predicate, if any.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <B> Stream<B> sequenceW(Stream<F<Stream<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this stream, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of comonadic functions to apply to this stream.
        +
        Returns:
        +
        A new stream of the results of applying the stream of functions to this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toFunction

        +
        public final F<java.lang.Integer,A> toFunction()
        +
        Converts this stream to a function of natural numbers.
        +
        +
        Returns:
        +
        A function from natural numbers to values with the corresponding position in this stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromFunction

        +
        public static <A> Stream<A> fromFunction(F<Natural,A> f)
        +
        Converts a function of natural numbers to a stream.
        +
        +
        Parameters:
        +
        f - The function to convert to a stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the natural numbers, starting at 0.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromFunction

        +
        public static <A,B> Stream<A> fromFunction(Enumerator<B> e,
+                                           F<B,A> f,
+                                           B i)
        +
        Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
        +
        +
        Parameters:
        +
        e - An enumerator for the domain of the function.
        +
        f - The function to convert to a stream.
        +
        i - The index into the function at which to begin the stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the values of the given enumerator, + starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Stream<A>,Stream<B>> unzip(Stream<P2<A,B>> xs)
        +
        Transforms a stream of pairs into a stream of first components and a stream of second components.
        +
        +
        Parameters:
        +
        xs - The stream of pairs to transform.
        +
        Returns:
        +
        A stream of first components and a stream of second components.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>> zipWith()
        +
        A first-class version of the zipWith function.
        +
        +
        Returns:
        +
        a function that zips two given streams with a given function.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<P1<Stream<A>>,Stream<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F<A,F<Stream<A>,Stream<A>>> cons_()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Stream<A> nil()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil_

        +
        public static <A> P1<Stream<A>> nil_()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given stream is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given stream is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is not empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Stream<A> single(A a)
        +
        Returns a stream of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned stream.
        +
        Returns:
        +
        A stream of one element containing the given value.
        +
        +
        • +
      + + + +
        +
      • +

        single

        +
        public static <A> F<A,Stream<A>> single()
        +
        Returns a function that yields a stream containing its argument.
        +
        +
        Returns:
        +
        a function that yields a stream containing its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> Stream<A> cons(A head,
+                                 F0<Stream<A>> tail)
        +
        Prepends the given head element to the given tail element to produce a new stream.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The stream to prepend to.
        +
        Returns:
        +
        The stream with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Stream<A> join(Stream<Stream<A>> o)
        +
        Joins the given stream of streams by concatenation.
        +
        +
        Parameters:
        +
        o - The stream of streams to join.
        +
        Returns:
        +
        A new stream that is the join of the given streams.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Stream<Stream<A>>,Stream<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a stream of streams using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> Stream<A> unfold(F<B,Option<P2<A,B>>> f,
+                                     B b)
        +
        Unfolds across the given function starting at the given value to produce a stream.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new stream that is a result of unfolding until the function does not produce a + value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> Stream<A> iterateWhile(F<A,A> f,
+                                         F<A,java.lang.Boolean> p,
+                                         A a)
        +
        Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + +
        +
      • +

        iterableStream

        +
        public static <A> Stream<A> iterableStream(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a stream.
        +
        +
        Parameters:
        +
        i - The iterable to take to a stream.
        +
        Returns:
        +
        A stream from the given iterable.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayStream

        +
        @SafeVarargs
+public static <A> Stream<A> arrayStream(A... as)
        +
        • +
      + + + + + +
        +
      • +

        repeat

        +
        public static <A> Stream<A> repeat(A a)
        +
        Returns an infinite-length stream of the given element.
        +
        +
        Parameters:
        +
        a - The element to repeat infinitely.
        +
        Returns:
        +
        An infinite-length stream of the given element.
        +
        +
        • +
      + + + +
        +
      • +

        cycle

        +
        public static <A> Stream<A> cycle(Stream<A> as)
        +
        Returns an infinite-length stream of the given elements cycling. Fails on the empty stream.
        +
        +
        Parameters:
        +
        as - The elements to cycle infinitely. This must not be empty.
        +
        Returns:
        +
        An infinite-length stream of the given elements cycling.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterate

        +
        public static <A> Stream<A> iterate(F<A,A> f,
+                                    A a)
        +
        Returns a stream constructed by applying the given iteration function starting at the given value.
        +
        +
        Parameters:
        +
        f - The iteration function.
        +
        a - The value to begin iterating from.
        +
        Returns:
        +
        A stream constructed by applying the given iteration function starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        iterate

        +
        public static <A> F<F<A,A>,F<A,Stream<A>>> iterate()
        +
        A first-class version of the iterate function.
        +
        +
        Returns:
        +
        A function that returns a stream constructed by applying a given iteration function + starting at a given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>> bind_()
        +
        A first-class version of the bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across a given stream, joining the resulting streams.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>> foldRight()
        +
        A first-class version of the foldRight function.
        +
        +
        Returns:
        +
        A function that folds a given stream with a given function.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Tree.html b/javadoc/4.8/functionaljava/fj/data/Tree.html new file mode 100644 index 0000000..a3e9b8a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Tree.html @@ -0,0 +1,907 @@ + + + + + +Tree (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Tree<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Tree<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Tree<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Tree<B>bottomUp(Tree<A> t, + F<P2<A,Stream<B>>,B> f) +
      Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
      +
      <B> Tree<B>cobind(F<Tree<A>,B> f) +
      Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
      +
      Tree<Tree<A>>cojoin() +
      Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
      +
      java.lang.Stringdraw(Show<A> s) +
      Draws a 2-dimensional representation of a tree.
      +
      booleanequals(java.lang.Object other) 
      static <A> F<Tree<A>,Stream<A>>flatten_() +
      flatten :: Tree a -> [a] + flatten t = squish t [] + where squish (Node x ts) xs = x:Prelude.foldr squish xs ts + Puts the elements of the tree into a Stream, in pre-order.
      +
      Stream<A>flatten() +
      Puts the elements of the tree into a Stream, in pre-order.
      +
      static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>>fmap_() +
      Provides a transformation to lift any function so that it maps over Trees.
      +
      <B> Tree<B>fmap(F<A,B> f) +
      Maps the given function over this tree.
      +
      static <A,B> F<Tree<A>,B>foldMap_(F<A,B> f, + Monoid<B> m) +
      Provides a function that folds a tree with the given monoid.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this tree using the given monoid.
      +
      inthashCode() 
      booleanisLeaf() 
      java.util.Iterator<A>iterator() +
      Returns an iterator for this tree.
      +
      static <A> Tree<A>leaf(A root) +
      Creates a nullary tree.
      +
      intlength() 
      Stream<Stream<A>>levels() +
      Provides a stream of the elements of the tree at each level, in level order.
      +
      static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>>node() +
      First-class constructor of trees.
      +
      static <A> Tree<A>node(A root, + List<Tree<A>> forest) +
      Creates a new n-ary given a root and a subforest of length n.
      +
      static <A> Tree<A>node(A root, + P1<Stream<Tree<A>>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> Tree<A>node(A root, + Stream<Tree<A>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> F<Tree<A>,A>root_() +
      Provides a transformation from a tree to its root.
      +
      Aroot() +
      Returns the root element of the tree.
      +
      static <A> Show<Tree<A>>show2D(Show<A> s) +
      Provides a show instance that draws a 2-dimensional representation of a tree.
      +
      static <A> F<Tree<A>,P1<Stream<Tree<A>>>>subForest_() +
      Provides a transformation from a tree to its subforest.
      +
      P1<Stream<Tree<A>>>subForest() +
      Returns a stream of the tree's subtrees.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this tree.
      +
      java.lang.StringtoString() 
      static <A,B> F<B,Tree<A>>unfoldTree(F<B,P2<A,P1<Stream<B>>>> f) +
      Builds a tree from a seed value.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F<A,F<B,C>> f) +
      Zips this tree with another, using the given function.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F2<A,B,C> f) +
      Zips this tree with another, using the given function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this tree. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        leaf

        +
        public static <A> Tree<A> leaf(A root)
        +
        Creates a nullary tree.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        Returns:
        +
        A nullary tree with the root element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               P1<Stream<Tree<A>>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               Stream<Tree<A>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               List<Tree<A>> forest)
        +
        Creates a new n-ary given a root and a subforest of length n.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A list of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + +
        +
      • +

        node

        +
        public static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>> node()
        +
        First-class constructor of trees.
        +
        +
        Returns:
        +
        A function that constructs an n-ary tree given a root and a subforest or length n.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public A root()
        +
        Returns the root element of the tree.
        +
        +
        Returns:
        +
        The root element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        subForest

        +
        public P1<Stream<Tree<A>>> subForest()
        +
        Returns a stream of the tree's subtrees.
        +
        +
        Returns:
        +
        A stream of the tree's subtrees.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<Tree<A>,A> root_()
        +
        Provides a transformation from a tree to its root.
        +
        +
        Returns:
        +
        A transformation from a tree to its root.
        +
        +
        • +
      + + + +
        +
      • +

        subForest_

        +
        public static <A> F<Tree<A>,P1<Stream<Tree<A>>>> subForest_()
        +
        Provides a transformation from a tree to its subforest.
        +
        +
        Returns:
        +
        A transformation from a tree to its subforest.
        +
        +
        • +
      + + + +
        +
      • +

        flatten

        +
        public Stream<A> flatten()
        +
        Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        flatten_

        +
        public static <A> F<Tree<A>,Stream<A>> flatten_()
        +
        flatten :: Tree a -> [a] + flatten t = squish t [] + where squish (Node x ts) xs = x:Prelude.foldr squish xs ts + Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        levels

        +
        public Stream<Stream<A>> levels()
        +
        Provides a stream of the elements of the tree at each level, in level order.
        +
        +
        Returns:
        +
        The elements of the tree at each level.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Tree<B> fmap(F<A,B> f)
        +
        Maps the given function over this tree.
        +
        +
        Parameters:
        +
        f - The function to map over this tree.
        +
        Returns:
        +
        The new Tree after the function has been applied to each element in this Tree.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>> fmap_()
        +
        Provides a transformation to lift any function so that it maps over Trees.
        +
        +
        Returns:
        +
        A transformation to lift any function so that it maps over Trees.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public <B> B foldMap(F<A,B> f,
+                     Monoid<B> m)
        +
        Folds this tree using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this tree's elements, to the monoid.
        +
        m - The monoid to fold this tree with.
        +
        Returns:
        +
        The result of folding the tree with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this tree.
        +
        +
        Returns:
        +
        An immutable collection of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap_

        +
        public static <A,B> F<Tree<A>,B> foldMap_(F<A,B> f,
+                                          Monoid<B> m)
        +
        Provides a function that folds a tree with the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from a tree's elements to the monoid.
        +
        m - A monoid to fold the tree with.
        +
        Returns:
        +
        A function that, given a tree, folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        unfoldTree

        +
        public static <A,B> F<B,Tree<A>> unfoldTree(F<B,P2<A,P1<Stream<B>>>> f)
        +
        Builds a tree from a seed value.
        +
        +
        Parameters:
        +
        f - A function with which to build the tree.
        +
        Returns:
        +
        A function which, given a seed value, yields a tree.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Tree<B> cobind(F<Tree<A>,B> f)
        +
        Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to bind across all the subtrees of this tree.
        +
        Returns:
        +
        A new tree, with the results of applying the given function to each subtree of this tree. The result + of applying the function to the entire tree is the root label, and the results of applying to the + root's children are labels of the root's subforest, etc.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Tree<Tree<A>> cojoin()
        +
        Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
        +
        +
        Returns:
        +
        A tree of trees, with this tree as its root label, and subtrees of this tree as the labels of + its child nodes.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        draw

        +
        public java.lang.String draw(Show<A> s)
        +
        Draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a String showing this tree in two dimensions.
        +
        +
        • +
      + + + +
        +
      • +

        show2D

        +
        public static <A> Show<Tree<A>> show2D(Show<A> s)
        +
        Provides a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F2<A,B,C> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F<A,F<B,C>> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/TreeMap.html b/javadoc/4.8/functionaljava/fj/data/TreeMap.html new file mode 100644 index 0000000..a38bae5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/TreeMap.html @@ -0,0 +1,1018 @@ + + + + + +TreeMap (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<P2<K,V>>
    +
    +
    +
    +
    public final class TreeMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<P2<K,V>>
    +
    An immutable, in-memory map, backed by a red-black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <K,V> TreeMap<K,V>arrayTreeMap(Ord<K> keyOrd, + P2<K,V>... ps) +
      Constructs a tree map from the given elements.
      +
      booleancontains(K k) +
      Determines if the given key value exists in this tree map.
      +
      TreeMap<K,V>delete(K k) +
      Deletes the entry in the tree map that corresponds to the given key.
      +
      static <K,V> TreeMap<K,V>empty(Ord<K> keyOrd) +
      Constructs an empty tree map.
      +
      booleanequals(java.lang.Object other) 
      static <K,V> TreeMap<K,V>fromMutableMap(Ord<K> ord, + java.util.Map<K,V> m) +
      An immutable projection of the given mutable map.
      +
      F<K,Option<V>>get() +
      Returns a first-class version of the get method for this TreeMap.
      +
      Option<V>get(K k) +
      Returns a potential value that the given key maps to.
      +
      inthashCode() 
      booleanisEmpty() +
      Determines if this tree map has any entries.
      +
      static <K,V> TreeMap<K,V>iterableTreeMap(Ord<K> keyOrd, + java.lang.Iterable<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      java.util.Iterator<P2<K,V>>iterator() +
      Returns an iterator for this map's key-value pairs.
      +
      static <K,V> TreeMap<K,V>iteratorTreeMap(Ord<K> keyOrd, + java.util.Iterator<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      List<K>keys() +
      Returns all keys in this tree map.
      +
      <W> TreeMap<K,W>map(F<V,W> f) +
      Maps the given function across the values of this TreeMap.
      +
      Option<P2<K,V>>max() +
      Returns the maximum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>maxKey() +
      Returns the maximum key in the tree if the tree is not empty.
      +
      Option<P2<K,V>>min() +
      Returns the minimum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>minKey() +
      Returns the minimum key in the tree if the tree is not empty.
      +
      TreeMap<K,V>set(K k, + V v) +
      Inserts the given key and value association into the tree map.
      +
      intsize() +
      Returns the number of entries in this tree map.
      +
      P3<Set<V>,Option<V>,Set<V>>split(Ord<V> ord, + K k) +
      Splits this TreeMap at the given key.
      +
      P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>>splitLookup(K k) +
      Splits this TreeMap at the given key.
      +
      List<P2<K,V>>toList() 
      List<P2<K,V>>toListReverse() 
      java.util.Map<K,V>toMutableMap() +
      A mutable map projection of this tree map.
      +
      Stream<P2<K,V>>toStream() 
      Stream<P2<K,V>>toStreamReverse() 
      java.lang.StringtoString() 
      static <K,V> TreeMap<K,V>treeMap(Ord<K> keyOrd, + List<P2<K,V>> list) +
      Deprecated.  +
      As of release 4.5, use iterableTreeMap(Ord, Iterable)
      +
      +
      static <K,V> TreeMap<K,V>treeMap(Ord<K> keyOrd, + P2<K,V>... p2s) +
      Constructs a tree map from the given elements.
      +
      TreeMap<K,V>union(java.lang.Iterable<P2<K,V>> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      TreeMap<K,V>union(TreeMap<K,V> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      P2<java.lang.Boolean,TreeMap<K,V>>update(K k, + F<V,V> f) +
      Modifies the value for the given key, if present, by applying the given function to it.
      +
      TreeMap<K,V>update(K k, + F<V,V> f, + V v) +
      Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
      +
      List<V>values() +
      Returns all values in this tree map.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <K,V> TreeMap<K,V> empty(Ord<K> keyOrd)
        +
        Constructs an empty tree map.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        an empty TreeMap with the given key order.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> treeMap(Ord<K> keyOrd,
+                                                      P2<K,V>... p2s)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        p2s - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        treeMap

        +
        @Deprecated
+public static <K,V> TreeMap<K,V> treeMap(Ord<K> keyOrd,
+                                                     List<P2<K,V>> list)
        +
        Deprecated. As of release 4.5, use iterableTreeMap(Ord, Iterable)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        list - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iterableTreeMap

        +
        public static <K,V> TreeMap<K,V> iterableTreeMap(Ord<K> keyOrd,
+                                                 java.lang.Iterable<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorTreeMap

        +
        public static <K,V> TreeMap<K,V> iteratorTreeMap(Ord<K> keyOrd,
+                                                 java.util.Iterator<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        arrayTreeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> arrayTreeMap(Ord<K> keyOrd,
+                                                           P2<K,V>... ps)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        ps - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the tree map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public TreeMap<K,V> set(K k,
+                        V v)
        +
        Inserts the given key and value association into the tree map. + If the given key is already mapped to a value, the old value is replaced with the given one.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        Returns:
        +
        A new tree map with the given value mapped to the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public TreeMap<K,V> delete(K k)
        +
        Deletes the entry in the tree map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this tree map.
        +
        Returns:
        +
        A new tree map with the entry corresponding to the given key removed.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this tree map.
        +
        +
        Returns:
        +
        The number of entries in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this tree map has any entries.
        +
        +
        Returns:
        +
        true if this tree map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this tree map.
        +
        +
        Returns:
        +
        All values in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all keys in this tree map.
        +
        +
        Returns:
        +
        All keys in this tree map.
        +
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this tree map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this tree map.
        +
        Returns:
        +
        true if this tree map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<P2<K,V>> iterator()
        +
        Returns an iterator for this map's key-value pairs. + This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<P2<K,V>>
        +
        Returns:
        +
        A iterator for this map's key-value pairs.
        +
        +
        • +
      + + + +
        +
      • +

        toMutableMap

        +
        public java.util.Map<K,V> toMutableMap()
        +
        A mutable map projection of this tree map.
        +
        +
        Returns:
        +
        A new mutable map isomorphic to this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public Stream<P2<K,V>> toStreamReverse()
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public List<P2<K,V>> toListReverse()
        +
        • +
      + + + +
        +
      • +

        fromMutableMap

        +
        public static <K,V> TreeMap<K,V> fromMutableMap(Ord<K> ord,
+                                                java.util.Map<K,V> m)
        +
        An immutable projection of the given mutable map.
        +
        +
        Parameters:
        +
        ord - An order for the map's keys.
        +
        m - A mutable map to project to an immutable one.
        +
        Returns:
        +
        A new immutable tree map isomorphic to the given mutable map.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public F<K,Option<V>> get()
        +
        Returns a first-class version of the get method for this TreeMap.
        +
        +
        Returns:
        +
        a functional representation of this TreeMap.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public P2<java.lang.Boolean,TreeMap<K,V>> update(K k,
+                                                 F<V,V> f)
        +
        Modifies the value for the given key, if present, by applying the given function to it.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function, + paired with True if the map was modified, otherwise False.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public TreeMap<K,V> update(K k,
+                           F<V,V> f,
+                           V v)
        +
        Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        v - A value to associate with the given key if the key is not already present.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public P3<Set<V>,Option<V>,Set<V>> split(Ord<V> ord,
+                                         K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A set containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A set containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are mapped to keys less than the given + key in this map, all the elements in the second set are mapped to keys greater than the given key, + and the optional value is the value associated with the given key if present, otherwise None.
        +
        +
        • +
      + + + + + +
        +
      • +

        splitLookup

        +
        public P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>> splitLookup(K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A tree map containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A tree map containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two tree maps and an optional value, where all keys in the first tree map are mapped + to keys less than the given key in this map, all the keys in the second tree map are mapped + to keys greater than the given key, and the optional value is the value associated with the + given key if present, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <W> TreeMap<K,W> map(F<V,W> f)
        +
        Maps the given function across the values of this TreeMap.
        +
        +
        Parameters:
        +
        f - A function to apply to the values of this TreeMap.
        +
        Returns:
        +
        A new TreeMap with the values transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<P2<K,V>> min()
        +
        Returns the minimum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        minKey

        +
        public Option<K> minKey()
        +
        Returns the minimum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<P2<K,V>> max()
        +
        Returns the maximum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        maxKey

        +
        public Option<K> maxKey()
        +
        Returns the maximum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(TreeMap<K,V> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other tree we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(java.lang.Iterable<P2<K,V>> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other list/set of pairs we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/TreeZipper.html b/javadoc/4.8/functionaljava/fj/data/TreeZipper.html new file mode 100644 index 0000000..8460072 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/TreeZipper.html @@ -0,0 +1,1368 @@ + + + + + +TreeZipper (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeZipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeZipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<TreeZipper<A>>
    +
    +
    +
    +
    public final class TreeZipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<TreeZipper<A>>
    +
    Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree. + Provides navigation, insertion, deletion, and memorization of visited locations within a tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<TreeZipper<A>> iterator()
        +
        Returns an iterator of all the positions of this TreeZipper. Exists for use with the foreach syntax.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<TreeZipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> TreeZipper<A> treeZipper(Tree<A> tree,
+                                           Stream<Tree<A>> lefts,
+                                           Stream<Tree<A>> rights,
+                                           Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents)
        +
        Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
        +
        +
        Parameters:
        +
        tree - The currently selected tree.
        +
        lefts - The selected tree's left siblings, closest first.
        +
        rights - The selected tree's right siblings, closest first.
        +
        parents - The parent of the selected tree, and the parent's siblings.
        +
        Returns:
        +
        A new zipper with the given tree selected, and the given forests on the left and right.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> F<Tree<A>,F<Stream<Tree<A>>,F<Stream<Tree<A>>,F<Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>>,TreeZipper<A>>>>> treeZipper()
        +
        First-class constructor for tree zippers.
        +
        +
        Returns:
        +
        A function that returns a new tree zipper, given a selected tree, left and right siblings, + and a parent context.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        eq

        +
        public static <A> Equal<TreeZipper<A>> eq(Equal<A> e)
        +
        An Equal instance for tree zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for tree elements.
        +
        Returns:
        +
        An Equal instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<TreeZipper<A>> show(Show<A> s)
        +
        A Show instance for tree zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for tree elements.
        +
        Returns:
        +
        A Show instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        parent

        +
        public Option<TreeZipper<A>> parent()
        +
        Navigates to the parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the parent node of the current node, + or none if the current node is the root node.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public TreeZipper<A> root()
        +
        Navigates to the top-most parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the top-most parent of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<TreeZipper<A>,TreeZipper<A>> root_()
        +
        A first-class version of the root function.
        +
        +
        Returns:
        +
        A function that returns a new tree-zipper focused on the root of the given tree zipper's tree.
        +
        +
        • +
      + + + +
        +
      • +

        left

        +
        public Option<TreeZipper<A>> left()
        +
        Navigates to the left sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the left sibling of the current node, + or none if there are no siblings on the left.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public Option<TreeZipper<A>> right()
        +
        Navigates to the right sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the right sibling of the current node, + or none if there are no siblings on the right.
        +
        +
        • +
      + + + +
        +
      • +

        firstChild

        +
        public Option<TreeZipper<A>> firstChild()
        +
        Navigtes to the first child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the first child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        lastChild

        +
        public Option<TreeZipper<A>> lastChild()
        +
        Navigtes to the last child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the last child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        getChild

        +
        public Option<TreeZipper<A>> getChild(int n)
        +
        Navigates to the given child of the current location, starting at index 0.
        +
        +
        Parameters:
        +
        n - The index of the child to which to navigate.
        +
        Returns:
        +
        An optional tree zipper focused on the child node at the given index, or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public Option<TreeZipper<A>> findChild(F<Tree<A>,java.lang.Boolean> p)
        +
        Navigates to the first child of the current location, that satisfies the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by the child node.
        +
        Returns:
        +
        An optional tree zipper focused on the first child node that satisfies the given predicate, + or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> TreeZipper<A> fromTree(Tree<A> t)
        +
        Creates a new tree zipper focused on the root of the given tree.
        +
        +
        Parameters:
        +
        t - A tree over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the root of the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        fromForest

        +
        public static <A> Option<TreeZipper<A>> fromForest(Stream<Tree<A>> ts)
        +
        Creates a new tree zipper focused on the first element of the given forest.
        +
        +
        Parameters:
        +
        ts - A forest over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the first element of the given forest.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public Tree<A> toTree()
        +
        Returns the tree containing this location.
        +
        +
        Returns:
        +
        the tree containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        toForest

        +
        public Stream<Tree<A>> toForest()
        +
        Returns the forest containing this location.
        +
        +
        Returns:
        +
        the forest containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public Tree<A> focus()
        +
        Returns the tree at the currently focused node.
        +
        +
        Returns:
        +
        the tree at the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<Tree<A>> lefts()
        +
        Returns the left siblings of the currently focused node.
        +
        +
        Returns:
        +
        the left siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<Tree<A>> rights()
        +
        Returns the right siblings of the currently focused node.
        +
        +
        Returns:
        +
        the right siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        parents

        +
        public Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents()
        +
        Returns the parents of the currently focused node.
        +
        +
        Returns:
        +
        the parents of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        isRoot

        +
        public boolean isRoot()
        +
        Indicates whether the current node is at the top of the tree.
        +
        +
        Returns:
        +
        true if the current node is the root of the tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isFirst

        +
        public boolean isFirst()
        +
        Indicates whether the current node is the leftmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no left siblings, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLast

        +
        public boolean isLast()
        +
        Indicates whether the current node is the rightmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no siblings on its right, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        Indicates whether the current node is at the bottom of the tree.
        +
        +
        Returns:
        +
        true if the current node has no child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isChild

        +
        public boolean isChild()
        +
        Indicates whether the current node is a child node of another node.
        +
        +
        Returns:
        +
        true if the current node has a parent node, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        hasChildren

        +
        public boolean hasChildren()
        +
        Indicates whether the current node has any child nodes.
        +
        +
        Returns:
        +
        true if the current node has child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        setTree

        +
        public TreeZipper<A> setTree(Tree<A> t)
        +
        Replaces the current node with the given tree.
        +
        +
        Parameters:
        +
        t - A tree with which to replace the current node.
        +
        Returns:
        +
        A new tree zipper in which the focused node is replaced with the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        modifyTree

        +
        public TreeZipper<A> modifyTree(F<Tree<A>,Tree<A>> f)
        +
        Modifies the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to modify the current tree.
        +
        Returns:
        +
        A new tree zipper in which the focused node has been transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        modifyLabel

        +
        public TreeZipper<A> modifyLabel(F<A,A> f)
        +
        Modifies the label at the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to transform the current node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        setLabel

        +
        public TreeZipper<A> setLabel(A v)
        +
        Replaces the label of the current node with the given value.
        +
        +
        Parameters:
        +
        v - The new value for the node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label replaced by the given value.
        +
        +
        • +
      + + + +
        +
      • +

        getLabel

        +
        public A getLabel()
        +
        Returns the label at the current node.
        +
        +
        Returns:
        +
        the label at the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertLeft

        +
        public TreeZipper<A> insertLeft(Tree<A> t)
        +
        Inserts a tree to the left of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the left of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the right.
        +
        +
        • +
      + + + +
        +
      • +

        insertRight

        +
        public TreeZipper<A> insertRight(Tree<A> t)
        +
        Inserts a tree to the right of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the right of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the left.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownFirst

        +
        public TreeZipper<A> insertDownFirst(Tree<A> t)
        +
        Inserts a tree as the first child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the first child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownLast

        +
        public TreeZipper<A> insertDownLast(Tree<A> t)
        +
        Inserts a tree as the last child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the last child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownAt

        +
        public Option<TreeZipper<A>> insertDownAt(int n,
+                                          Tree<A> t)
        +
        Inserts a tree at the specified location in the current node's stream of children. The inserted tree + becomes the current node.
        +
        +
        Parameters:
        +
        n - The index at which to insert the given tree, starting at 0.
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, at the specified index in the current node's stream + of children, or None if the current node has fewer than n children.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Option<TreeZipper<A>> delete()
        +
        Removes the current node from the tree. The new position becomes the right sibling, or the left sibling + if the current node has no right siblings, or the parent node if the current node has no siblings.
        +
        +
        Returns:
        +
        A new tree zipper with the current node removed.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public TreeZipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the nodes in this zipper with a boolean that indicates whether that node has focus. + All of the booleans will be false, except for the focused node.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each node of this zipper paired with a boolean that is true if that + node has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> TreeZipper<B> map(F<A,B> f)
        +
        Maps the given function across this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to the label of every node.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> F<Tree<A>,TreeZipper<A>> fromTree()
        +
        First-class conversion of a Tree to the corresponding tree zipper.
        +
        +
        Returns:
        +
        A function that takes a tree to its tree zipper representation.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> left_()
        +
        A first-class version of the left() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its left sibling.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> right_()
        +
        A first-class version of the right() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its right sibling.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public TreeZipper<TreeZipper<A>> positions()
        +
        Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern). + This tree zipper becomes the focused node of the new zipper.
        +
        +
        Returns:
        +
        A tree zipper over the tree of all possible permutations of this tree zipper.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> TreeZipper<B> cobind(F<TreeZipper<A>,B> f)
        +
        Maps the given function over the tree of all positions for this zipper (comonad pattern). Returns a zipper + over the tree of results of the function application.
        +
        +
        Parameters:
        +
        f - A function to map over the tree of all positions for this zipper.
        +
        Returns:
        +
        A zipper over the tree of results of the function application.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public static <A> F2<F<Tree<A>,java.lang.Boolean>,TreeZipper<A>,Option<TreeZipper<A>>> findChild()
        +
        A first-class version of the findChild function.
        +
        +
        Returns:
        +
        a function that finds the first child, of a given tree zipper, that matches a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Validation.FailProjection.html b/javadoc/4.8/functionaljava/fj/data/Validation.FailProjection.html new file mode 100644 index 0000000..443f281 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Validation.FailProjection.html @@ -0,0 +1,678 @@ + + + + + +Validation.FailProjection (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Validation.FailProjection<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation.FailProjection<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>
    +
    +
    +
    Enclosing class:
    +
    Validation<E,T>
    +
    +
    +
    +
    public static final class Validation.FailProjection<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<E>
    +
    A failing projection of a validation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> Validation<A,T>apply(Validation<F<E,A>,T> v) +
      Function application on the failing value.
      +
      <A> Validation<A,T>bind(F<E,Validation<A,T>> f) +
      Binds the given function across this validation's failing value if it has one.
      +
      booleanexists(F<E,java.lang.Boolean> f) +
      Returns false if this is a success or returns the result of the application of the given + function to the failing value.
      +
      EfailE(F0<java.lang.String> err) +
      Returns the failing value or fails with the given error message.
      +
      EfailE(java.lang.String err) +
      Returns the failing value or fails with the given error message.
      +
      <A> Option<Validation<E,A>>filter(F<E,java.lang.Boolean> f) +
      Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
      +
      booleanforall(F<E,java.lang.Boolean> f) +
      Returns true if this is a success or returns the result of the application of the given + function to the failing value.
      +
      Unitforeach(F<E,Unit> f) +
      Executes a side-effect on the failing value if there is one.
      +
      voidforeachDoEffect(Effect1<E> f) +
      Executes a side-effect on the failing value if there is one.
      +
      java.util.Iterator<E>iterator() +
      Returns an iterator for this projection.
      +
      <A> Validation<A,T>map(F<E,A> f) +
      Maps the given function across the failing side of this validation.
      +
      Eon(F<T,E> f) +
      The failing value or the application of the given function to the success value.
      +
      EorFail(E e) +
      Returns the failing value or the given value.
      +
      EorFail(F0<E> e) +
      Returns the failing value or the given value.
      +
      <A> Validation<A,T>sequence(Validation<A,T> v) +
      Performs a bind across the validation, but ignores the element value in the function.
      +
      Array<E>toArray() +
      Returns a single element array if this is a failing value, otherwise an empty list.
      +
      List<E>toList() +
      Returns a single element list if this is a failing value, otherwise an empty list.
      +
      Option<E>toOption() +
      Returns the failing value in Some if there is one, otherwise None.
      +
      Stream<E>toStream() +
      Returns a single element stream if this is a failing value, otherwise an empty list.
      +
      Validation<E,T>validation() +
      Returns the underlying validation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validation

        +
        public Validation<E,T> validation()
        +
        Returns the underlying validation.
        +
        +
        Returns:
        +
        The underlying validation.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(F0<java.lang.String> err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(java.lang.String err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        orFail

        +
        public E orFail(F0<E> e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orFail

        +
        public E orFail(E e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public E on(F<T,E> f)
        +
        The failing value or the application of the given function to the success value.
        +
        +
        Parameters:
        +
        f - The function to execute on the success value.
        +
        Returns:
        +
        The failing value or the application of the given function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<E,Unit> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<E> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A> Validation<A,T> map(F<E,A> f)
        +
        Maps the given function across the failing side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <A> Validation<A,T> bind(F<E,Validation<A,T>> f)
        +
        Binds the given function across this validation's failing value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Validation<A,T> sequence(Validation<A,T> v)
        +
        Performs a bind across the validation, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        v - The validation value to apply in the final join.
        +
        Returns:
        +
        A new validation value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <A> Option<Validation<E,A>> filter(F<E,java.lang.Boolean> f)
        +
        Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <A> Validation<A,T> apply(Validation<F<E,A>,T> v)
        +
        Function application on the failing value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the failing value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<E,java.lang.Boolean> f)
        +
        Returns true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<E,java.lang.Boolean> f)
        +
        Returns false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<E> toList()
        +
        Returns a single element list if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<E> toOption()
        +
        Returns the failing value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The failing value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<E> toArray()
        +
        Returns a single element array if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<E> toStream()
        +
        Returns a single element stream if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Validation.html b/javadoc/4.8/functionaljava/fj/data/Validation.html new file mode 100644 index 0000000..652a38e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Validation.html @@ -0,0 +1,2499 @@ + + + + + +Validation (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Validation<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<T>
    +
    +
    +
    +
    public class Validation<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<T>
    +
    Isomorphic to Either but has renamed functions and represents failure on the left and success on the right. + This type also has accumulating functions that accept a Semigroup for binding computation while keeping error + values
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Byte>> parseByte
        +
        A function that parses a string into a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Double>> parseDouble
        +
        A function that parses a string into a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Float>> parseFloat
        +
        A function that parses a string into a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Integer>> parseInt
        +
        A function that parses a string into an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Long>> parseLong
        +
        A function that parses a string into a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Short>> parseShort
        +
        A function that parses a string into a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Validation

        +
        protected Validation(Either<E,T> e)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isFail

        +
        public final boolean isFail()
        +
        Returns true if this is a failure, false otherwise.
        +
        +
        Returns:
        +
        true if this is a failure, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSuccess

        +
        public final boolean isSuccess()
        +
        Returns true if this is a success, false otherwise.
        +
        +
        Returns:
        +
        true if this is a success, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public final E fail()
        +
        Returns the failing value, or throws an error if there is no failing value.
        +
        +
        Returns:
        +
        the failing value, or throws an error if there is no failing value.
        +
        +
        • +
      + + + +
        +
      • +

        success

        +
        public final T success()
        +
        Returns the success value, or throws an error if there is no success value.
        +
        +
        Returns:
        +
        the success value, or throws an error if there is no success value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public final <X> X validation(F<E,X> fail,
+                              F<T,X> success)
        +
        The catamorphism for validation. Folds over this validation breaking into left or right.
        +
        +
        Parameters:
        +
        fail - The function to call if this failed.
        +
        success - The function to call if this succeeded.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public final Validation.FailProjection<E,T> f()
        +
        Returns a failing projection of this validation.
        +
        +
        Returns:
        +
        a failing projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final Either<E,T> toEither()
        +
        Returns an either projection of this validation.
        +
        +
        Returns:
        +
        An either projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(F0<java.lang.String> err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(java.lang.String err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(F0<T> t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(T t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final T on(F<E,T> f)
        +
        The success value or the application of the given function to the failing value.
        +
        +
        Parameters:
        +
        f - The function to execute on the failing value.
        +
        Returns:
        +
        The success value or the application of the given function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<T,Unit> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<T> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <A> Validation<E,A> map(F<T,A> f)
        +
        Maps the given function across the success side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <A> Validation<E,A> bind(F<T,Validation<E,A>> f)
        +
        Binds the given function across this validation's success value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <A> Validation<E,A> sequence(Validation<E,A> v)
        +
        Anonymous bind through this validation.
        +
        +
        Parameters:
        +
        v - The value to bind with.
        +
        Returns:
        +
        A validation after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <E,A> Validation<E,List<A>> sequence(Semigroup<E> s,
+                                                   List<Validation<E,A>> list)
        +
        If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <A> Option<Validation<A,T>> filter(F<T,java.lang.Boolean> f)
        +
        Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <A> Validation<E,A> apply(Validation<E,F<T,A>> v)
        +
        Function application on the success value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the success value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<T,java.lang.Boolean> f)
        +
        Returns true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<T,java.lang.Boolean> f)
        +
        Returns false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<T> toList()
        +
        Returns a single element list if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<T> toOption()
        +
        Returns the success value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The success value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<T> toArray()
        +
        Returns a single element array if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<T> toStream()
        +
        Returns a single element stream if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        accumapply

        +
        public final <A> Validation<E,A> accumapply(Semigroup<E> s,
+                                            Validation<E,F<T,A>> v)
        +
        Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if
        +
        v - The validating function to apply.
        +
        Returns:
        +
        A failing validation if this or the given validation failed (with errors accumulated if both) or a + succeeding validation if both succeeded.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F<T,F<A,B>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F2<T,A,B> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A> Option<E> accumulate(Semigroup<E> s,
+                                      Validation<E,A> va)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F<T,F<A,F<B,C>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F3<T,A,B,C> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Option<E> accumulate(Semigroup<E> s,
+                                        Validation<E,A> va,
+                                        Validation<E,B> vb)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F<T,F<A,F<B,F<C,D>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F4<T,A,B,C,D> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Option<E> accumulate(Semigroup<E> s,
+                                          Validation<E,A> va,
+                                          Validation<E,B> vb,
+                                          Validation<E,C> vc)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F<T,F<A,F<B,F<C,F<D,E$>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F5<T,A,B,C,D,E$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Option<E> accumulate(Semigroup<E> s,
+                                            Validation<E,A> va,
+                                            Validation<E,B> vb,
+                                            Validation<E,C> vc,
+                                            Validation<E,D> vd)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F<T,F<A,F<B,F<C,F<D,F<E$,F$>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F6<T,A,B,C,D,E$,F$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Option<E> accumulate(Semigroup<E> s,
+                                               Validation<E,A> va,
+                                               Validation<E,B> vb,
+                                               Validation<E,C> vc,
+                                               Validation<E,D> vd,
+                                               Validation<E,E$> ve)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F7<T,A,B,C,D,E$,F$,G> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Option<E> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  Validation<E,D> vd,
+                                                  Validation<E,E$> ve,
+                                                  Validation<E,F$> vf)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F8<T,A,B,C,D,E$,F$,G,H> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Option<E> accumulate(Semigroup<E> s,
+                                                    Validation<E,A> va,
+                                                    Validation<E,B> vb,
+                                                    Validation<E,C> vc,
+                                                    Validation<E,D> vd,
+                                                    Validation<E,E$> ve,
+                                                    Validation<E,F$> vf,
+                                                    Validation<E,G> vg)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<T> iterator()
        +
        Returns an iterator for this validation. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<T>
        +
        Returns:
        +
        A iterator for this validation.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequenceNonCumulative

        +
        public static <A,E> Validation<List<E>,List<A>> sequenceNonCumulative(List<Validation<E,A>> list)
        +
        If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values. Does not accumulate the failures into a + single failure using a semigroup.
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<Validation<E,C>> traverseIO(F<T,IO<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <C> P1<Validation<E,C>> traverseP1(F<T,P1<C>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        nel

        +
        public final Validation<NonEmptyList<E>,T> nel()
        +
        Puts this validation's failing value in a non-empty list if there is one.
        +
        +
        Returns:
        +
        A validation with its failing value in a non-empty list if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> Validation<E,T> validation(Either<E,T> e)
        +
        Construct a validation using the given either value.
        +
        +
        Parameters:
        +
        e - The either value to construct a validation with.
        +
        Returns:
        +
        A validation using the given either value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> F<Either<E,T>,Validation<E,T>> validation()
        +
        Returns a function that constructs a validation with an either.
        +
        +
        Returns:
        +
        A function that constructs a validation with an either.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <E,T> F<Validation<E,T>,Either<E,T>> either()
        +
        Returns a function that constructs an either with a validation.
        +
        +
        Returns:
        +
        A function that constructs an either with a validation.
        +
        +
        • +
      + + + + + +
        +
      • +

        success

        +
        public static <E,T> Validation<E,T> success(T t)
        +
        Returns a succeeding validation containing the given value.
        +
        +
        Parameters:
        +
        t - The value to use in the succeeding validation.
        +
        Returns:
        +
        A succeeding validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <E,T> Validation<E,T> fail(E e)
        +
        Returns a failing validation containing the given value.
        +
        +
        Parameters:
        +
        e - The value to use in the failing validation.
        +
        Returns:
        +
        A failing validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        failNEL

        +
        public static <E,T> Validation<NonEmptyList<E>,T> failNEL(E e)
        +
        Returns a failing validation containing a non-empty list that contains the given value.
        +
        +
        Parameters:
        +
        e - The value to use in a non-empty list for the failing validation.
        +
        Returns:
        +
        A failing validation containing a non-empty list that contains the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        condition

        +
        public static <E,T> Validation<E,T> condition(boolean c,
+                                              E e,
+                                              T t)
        +
        Returns a validation based on a boolean condition. If the condition is true, the validation succeeds, + otherwise it fails.
        +
        +
        Parameters:
        +
        c - The condition to base the returned validation on.
        +
        e - The failing value to use if the condition is false.
        +
        t - The succeeding value to use if the condition is true.
        +
        Returns:
        +
        A validation based on a boolean condition.
        +
        +
        • +
      + + + +
        +
      • +

        parseByte

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Byte> parseByte(java.lang.String s)
        +
        Parses the given string into a byte.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse byte or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Double> parseDouble(java.lang.String s)
        +
        Parses the given string into a double.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse double or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Float> parseFloat(java.lang.String s)
        +
        Parses the given string into a float.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse float or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Integer> parseInt(java.lang.String s)
        +
        Parses the given string into a integer.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse integer or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Long> parseLong(java.lang.String s)
        +
        Parses the given string into a long.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse long or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Short> parseShort(java.lang.String s)
        +
        Parses the given string into a short.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse short or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public static <A,B> P2<List<A>,List<B>> partition(List<Validation<A,B>> list)
        +
        Partitions the list into the list of fails and the list of successes
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Writer.html b/javadoc/4.8/functionaljava/fj/data/Writer.html new file mode 100644 index 0000000..2090027 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Writer.html @@ -0,0 +1,380 @@ + + + + + +Writer (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Writer<W,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Writer<W,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Writer<W,A>
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public P2<W,A> run()
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        • +
      + + + +
        +
      • +

        log

        +
        public W log()
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<W> monoid()
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     W w,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        tell

        +
        public Writer<W,A> tell(W w)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Writer<W,B> map(F<A,B> f)
        +
        • +
      + + + + + + + + + +
        +
      • +

        unit

        +
        public static <B> Writer<java.lang.String,B> unit(B b)
        +
        • +
      + + + +
        +
      • +

        stringLogger

        +
        public static <A> F<A,Writer<java.lang.String,A>> stringLogger()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/Zipper.html b/javadoc/4.8/functionaljava/fj/data/Zipper.html new file mode 100644 index 0000000..c3d6bff --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/Zipper.html @@ -0,0 +1,1286 @@ + + + + + +Zipper (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Zipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Zipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<Zipper<A>>
    +
    +
    +
    +
    public final class Zipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<Zipper<A>>
    +
    Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream. Focus can be moved forward and backwards through the stream, elements can be inserted + before or after the focused position, and the focused item can be deleted. +

    + Based on the pointedlist library by Jeff Wheeler.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanatEnd() +
      Returns whether the focus is on the last element.
      +
      booleanatStart() +
      Returns whether the focus is on the first element.
      +
      <B> Zipper<B>cobind(F<Zipper<A>,B> f) +
      Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
      +
      Zipper<A>cycleNext() +
      Move the focus to the next element.
      +
      Zipper<A>cyclePrevious() +
      Move the focus to the previous element.
      +
      Option<Zipper<A>>deleteLeft() +
      Possibly deletes the element at the focus, then moves the element on the left into focus.
      +
      Option<Zipper<A>>deleteLeftCycle() +
      Possibly deletes the element at the focus, then move the element on the left into focus.
      +
      Zipper<A>deleteOthers() +
      Deletes all elements in the zipper except the focus.
      +
      Option<Zipper<A>>deleteRight() +
      Possibly deletes the element at the focus, then moves the element on the right into focus.
      +
      Option<Zipper<A>>deleteRightCycle() +
      Possibly deletes the element at the focus, then move the element on the right into focus.
      +
      static <A> Equal<Zipper<A>>eq(Equal<A> e) +
      An Equal instance for Zippers.
      +
      booleanequals(java.lang.Object other) 
      Option<Zipper<A>>find(F<A,java.lang.Boolean> p) +
      Moves the focus to the element matching the given predicate, if present.
      +
      Afocus() +
      Returns the focus element of this zipper.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Performs a right-fold reduction across this zipper.
      +
      static <A> Option<Zipper<A>>fromStream(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      static <A> Option<Zipper<A>>fromStreamEnd(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      inthashCode() 
      intindex() +
      Returns the index of the focus.
      +
      Zipper<A>insertLeft(A a) +
      Inserts an element to the left of the focus, then moves the focus to the new element.
      +
      Zipper<A>insertRight(A a) +
      Inserts an element to the right of the focus, then moves the focus to the new element.
      +
      java.util.Iterator<Zipper<A>>iterator() +
      Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
      +
      Stream<A>lefts() +
      Returns a Stream of the elements to the left of focus.
      +
      intlength() +
      Returns the length of this zipper.
      +
      <B> Zipper<B>map(F<A,B> f) +
      Maps the given function across the elements of this zipper (covariant functor pattern).
      +
      static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>>move() +
      A first-class version of the move function.
      +
      Option<Zipper<A>>move(int n) +
      Move the focus to the specified index.
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>next_() +
      First-class version of the next() function.
      +
      Option<Zipper<A>>next() +
      Possibly moves the focus to the next element in the list.
      +
      static <A> Ord<Zipper<A>>ord(Ord<A> o) +
      An Ord instance for Zippers.
      +
      static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>>p_() +
      A first-class function that yields the product-3 representation of a given Zipper.
      +
      P3<Stream<A>,A,Stream<A>>p() +
      Returns the product-3 representation of this Zipper.
      +
      Zipper<Zipper<A>>positions() +
      Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>previous_() +
      First-class version of the previous() function.
      +
      Option<Zipper<A>>previous() +
      Possibly moves the focus to the previous element in the list.
      +
      Zipper<A>replace(A a) +
      Replaces the element in focus with the given element.
      +
      Stream<A>rights() +
      Returns a Stream of the elements to the right of focus.
      +
      static <A> Show<Zipper<A>>show(Show<A> s) +
      A Show instance for Zippers.
      +
      static <A> Zipper<A>single(A a) +
      Creates a new zipper with a single element.
      +
      Stream<A>toStream() +
      Returns the Stream representation of this zipper.
      +
      Zipper<A>tryNext() +
      Attempts to move the focus to the next element, or throws an error if there are no more elements.
      +
      Zipper<A>tryPrevious() +
      Attempts to move the focus to the previous element, or throws an error if there are no more elements.
      +
      static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>>zipper() +
      First-class constructor of zippers.
      +
      static <A> Zipper<A>zipper(P3<Stream<A>,A,Stream<A>> p) +
      Creates a new Zipper from the given triple.
      +
      static <A> Zipper<A>zipper(Stream<A> left, + A focus, + Stream<A> right) +
      Creates a new Zipper with the given streams before and after the focus, and the given focused item.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F<A,F<B,C>> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F2<A,B,C> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      Zipper<P2<A,java.lang.Boolean>>zipWithFocus() +
      Zips the elements of this zipper with a boolean that indicates whether that element has focus.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(Stream<A> left,
+                                   A focus,
+                                   Stream<A> right)
        +
        Creates a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        Parameters:
        +
        left - The stream of elements before the focus.
        +
        focus - The element under focus.
        +
        right - The stream of elements after the focus.
        +
        Returns:
        +
        a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(P3<Stream<A>,A,Stream<A>> p)
        +
        Creates a new Zipper from the given triple.
        +
        +
        Parameters:
        +
        p - A triple of the elements before the focus, the focus element, and the elements after the focus, + respectively.
        +
        Returns:
        +
        a new Zipper created from the given triple.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>> zipper()
        +
        First-class constructor of zippers.
        +
        +
        Returns:
        +
        A function that yields a new zipper given streams on the left and right and a focus element.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<Stream<A>,A,Stream<A>> p()
        +
        Returns the product-3 representation of this Zipper.
        +
        +
        Returns:
        +
        the product-3 representation of this Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>> p_()
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        Returns:
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<Zipper<A>> ord(Ord<A> o)
        +
        An Ord instance for Zippers.
        +
        +
        Parameters:
        +
        o - An Ord instance for the element type.
        +
        Returns:
        +
        An Ord instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static <A> Equal<Zipper<A>> eq(Equal<A> e)
        +
        An Equal instance for Zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for the element type.
        +
        Returns:
        +
        An Equal instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<Zipper<A>> show(Show<A> s)
        +
        A Show instance for Zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for the element type.
        +
        Returns:
        +
        A Show instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Zipper<B> map(F<A,B> f)
        +
        Maps the given function across the elements of this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to all elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B z)
        +
        Performs a right-fold reduction across this zipper.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of this zipper.
        +
        z - The beginning value to start the application from.
        +
        Returns:
        +
        the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Zipper<A> single(A a)
        +
        Creates a new zipper with a single element.
        +
        +
        Parameters:
        +
        a - The focus element of the new zipper.
        +
        Returns:
        +
        a new zipper with a single element which is in focus.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static <A> Option<Zipper<A>> fromStream(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's head will be the focus of the zipper, and the rest of the stream will follow + on the right side.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        fromStreamEnd

        +
        public static <A> Option<Zipper<A>> fromStreamEnd(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's last element will be the focus of the zipper, following the rest of the stream in order, + to the left.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public A focus()
        +
        Returns the focus element of this zipper.
        +
        +
        Returns:
        +
        the focus element of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public Option<Zipper<A>> next()
        +
        Possibly moves the focus to the next element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryNext

        +
        public Zipper<A> tryNext()
        +
        Attempts to move the focus to the next element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        previous

        +
        public Option<Zipper<A>> previous()
        +
        Possibly moves the focus to the previous element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryPrevious

        +
        public Zipper<A> tryPrevious()
        +
        Attempts to move the focus to the previous element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        next_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> next_()
        +
        First-class version of the next() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the next element.
        +
        +
        • +
      + + + +
        +
      • +

        previous_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> previous_()
        +
        First-class version of the previous() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the previous element.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertLeft

        +
        public Zipper<A> insertLeft(A a)
        +
        Inserts an element to the left of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its right.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertRight

        +
        public Zipper<A> insertRight(A a)
        +
        Inserts an element to the right of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeft

        +
        public Option<Zipper<A>> deleteLeft()
        +
        Possibly deletes the element at the focus, then moves the element on the left into focus. + If no element is on the left, focus on the element to the right. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRight

        +
        public Option<Zipper<A>> deleteRight()
        +
        Possibly deletes the element at the focus, then moves the element on the right into focus. + If no element is on the right, focus on the element to the left. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteOthers

        +
        public Zipper<A> deleteOthers()
        +
        Deletes all elements in the zipper except the focus.
        +
        +
        Returns:
        +
        A new zipper with the focus element as the only element.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this zipper.
        +
        +
        Returns:
        +
        the length of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        atStart

        +
        public boolean atStart()
        +
        Returns whether the focus is on the first element.
        +
        +
        Returns:
        +
        true if the focus is on the first element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        Returns whether the focus is on the last element.
        +
        +
        Returns:
        +
        true if the focus is on the last element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public Zipper<Zipper<A>> positions()
        +
        Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
        +
        +
        Returns:
        +
        a zipper of variations of the provided zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Zipper<B> cobind(F<Zipper<A>,B> f)
        +
        Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
        +
        +
        Parameters:
        +
        f - The comonadic function to apply for each variation of this zipper.
        +
        Returns:
        +
        A new zipper, with the given function applied for each variation of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public Zipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the elements of this zipper with a boolean that indicates whether that element has focus. + All of the booleans will be false, except the focused element.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each element of this zipper paired with a boolean that is true if that + element has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public Option<Zipper<A>> move(int n)
        +
        Move the focus to the specified index.
        +
        +
        Parameters:
        +
        n - The index to which to move the focus.
        +
        Returns:
        +
        A new zipper with the focus moved to the specified index, or none if there is no such index.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>> move()
        +
        A first-class version of the move function.
        +
        +
        Returns:
        +
        A function that moves the focus of the given zipper to the given index.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<Zipper<A>> find(F<A,java.lang.Boolean> p)
        +
        Moves the focus to the element matching the given predicate, if present.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        A new zipper with the nearest matching element focused if it is present in this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public int index()
        +
        Returns the index of the focus.
        +
        +
        Returns:
        +
        the index of the focus.
        +
        +
        • +
      + + + +
        +
      • +

        cycleNext

        +
        public Zipper<A> cycleNext()
        +
        Move the focus to the next element. If the last element is focused, loop to the first element.
        +
        +
        Returns:
        +
        A new zipper with the next element focused, unless the last element is currently focused, in which case + the first element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        cyclePrevious

        +
        public Zipper<A> cyclePrevious()
        +
        Move the focus to the previous element. If the first element is focused, loop to the last element.
        +
        +
        Returns:
        +
        A new zipper with the previous element focused, unless the first element is currently focused, + in which case the last element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeftCycle

        +
        public Option<Zipper<A>> deleteLeftCycle()
        +
        Possibly deletes the element at the focus, then move the element on the left into focus. If no element is on the + left, focus on the last element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the previous element to the left, or the last + element if there is no element to the left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRightCycle

        +
        public Option<Zipper<A>> deleteRightCycle()
        +
        Possibly deletes the element at the focus, then move the element on the right into focus. If no element is on the + right, focus on the first element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the next element to the right, or the first + element if there is no element to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public Zipper<A> replace(A a)
        +
        Replaces the element in focus with the given element.
        +
        +
        Parameters:
        +
        a - An element to replace the focused element with.
        +
        Returns:
        +
        A new zipper with the given element in focus.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns the Stream representation of this zipper.
        +
        +
        Returns:
        +
        A stream that contains all the elements of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<A> lefts()
        +
        Returns a Stream of the elements to the left of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the left of focus.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<A> rights()
        +
        Returns a Stream of the elements to the right of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the right of focus.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F2<A,B,C> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F<A,F<B,C>> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<Zipper<A>> iterator()
        +
        Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<Zipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Deep.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Deep.html new file mode 100644 index 0000000..eb5baee --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Deep.html @@ -0,0 +1,727 @@ + + + + + +Deep (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Deep<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Deep<V,A>
+extends FingerTree<V,A>
    +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prefix

        +
        public Digit<V,A> prefix()
        +
        Returns the first few elements of this tree.
        +
        +
        Returns:
        +
        the first few elements of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        middle

        +
        public FingerTree<V,Node<V,A>> middle()
        +
        Returns a finger tree of the inner nodes of this tree.
        +
        +
        Returns:
        +
        a finger tree of the inner nodes of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        suffix

        +
        public Digit<V,A> suffix()
        +
        Returns the last few elements of this tree.
        +
        +
        Returns:
        +
        the last few elements of this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the tree. Matches the function on the Deep tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Digit.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Digit.html new file mode 100644 index 0000000..20aac5c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Digit.html @@ -0,0 +1,480 @@ + + + + + +Digit (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Digit<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Digit<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Four, One, Three, Two
    +
    +
    +
    +
    public abstract class Digit<V,A>
+extends java.lang.Object
    +
    A digit is a vector of 1-4 elements. Serves as a pointer to the prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Digit<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps a function across the elements of this digit, measuring with the given measurement.
      +
      abstract <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Vmeasure() +
      Returns the sum of the measurements of this digit according to the monoid.
      +
      AreduceLeft(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      AreduceRight(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      abstract Stream<A>toStream() 
      java.lang.StringtoString() 
      FingerTree<V,A>toTree() +
      Returns the tree representation of this digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public final A reduceRight(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public final A reduceLeft(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Digit<V,B> map(F<A,B> f,
+                                Measured<V,B> m)
        +
        Maps a function across the elements of this digit, measuring with the given measurement.
        +
        +
        Parameters:
        +
        f - A function to map across the elements of this digit.
        +
        m - A measuring for the function's domain (destination type).
        +
        Returns:
        +
        A new digit with the same structure as this digit, but with all elements transformed + with the given function and measured with the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<One<V,A>,B> one,
+                            F<Two<V,A>,B> two,
+                            F<Three<V,A>,B> three,
+                            F<Four<V,A>,B> four)
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        Returns the sum of the measurements of this digit according to the monoid.
        +
        +
        Returns:
        +
        the sum of the measurements of this digit according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public final FingerTree<V,A> toTree()
        +
        Returns the tree representation of this digit.
        +
        +
        Returns:
        +
        the tree representation of this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Empty.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Empty.html new file mode 100644 index 0000000..472f8d4 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Empty.html @@ -0,0 +1,667 @@ + + + + + +Empty (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Empty<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Empty<V,A>
+extends FingerTree<V,A>
    +
    The empty tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns zero.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        Zero.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the empty tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/FingerTree.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/FingerTree.html new file mode 100644 index 0000000..1be25a1 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/FingerTree.html @@ -0,0 +1,870 @@ + + + + + +FingerTree (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class FingerTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.FingerTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    V - The monoidal type with which to annotate nodes.
    +
    A - The type of the tree's elements.
    +
    +
    +
    Direct Known Subclasses:
    +
    Deep, Empty, Single
    +
    +
    +
    +
    public abstract class FingerTree<V,A>
+extends java.lang.Object
    +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. +

    + This class serves as a datastructure construction kit, rather than a datastructure in its own right. By supplying + a monoid, a measurement function, insertion, deletion, and so forth, any purely functional datastructure can be + emulated. See Seq for an example. +

    + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract FingerTree<V,A>append(FingerTree<V,A> t) +
      Appends one finger tree to another.
      +
      abstract FingerTree<V,A>cons(A a) +
      Adds the given element to this tree as the first element.
      +
      static <V,A> FingerTree<V,A>empty(Monoid<V> m, + F<A,V> f) +
      Creates an empty finger tree with elements of type A and node annotations + of type V.
      +
      static <A> FingerTree<java.lang.Integer,A>emptyIntAddition() 
      static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>>emptyIntMax() +
      Returns a finger tree which combines the integer node annotations with the + maximum function.
      +
      <B> FingerTree<V,A>filter(F<A,java.lang.Boolean> f) 
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds the tree to the left with the given function and the given initial element.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds the tree to the right with the given function and the given initial element.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      abstract Ahead() +
      The first element of this tree.
      +
      Option<A>headOption() 
      abstract FingerTree<V,A>init() +
      The tree without the last element.
      +
      booleanisEmpty() +
      Indicates whether this tree is empty.
      +
      abstract Alast() +
      The last element of this tree.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      abstract <B> FingerTree<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps the given function across this tree, measuring with the given Measured instance.
      +
      abstract <B> Bmatch(F<Empty<V,A>,B> empty, + F<Single<V,A>,B> single, + F<Deep<V,A>,B> deep) +
      Provides pattern matching on trees.
      +
      abstract Vmeasure() +
      Returns the sum of this tree's annotations.
      +
      Measured<V,A>measured() 
      static <V,A> Measured<V,A>measured(Monoid<V> monoid, + F<A,V> measure) +
      Constructs a Measured instance for the element type, given a monoid and a measuring function.
      +
      static <V,A> MakeTree<V,A>mkTree(Measured<V,A> m) +
      Returns a builder of trees and tree components that annotates them using the given Measured instance.
      +
      abstract AreduceLeft(F<A,F<A,A>> f) +
      Folds the tree to the left with the given function.
      +
      abstract AreduceRight(F<A,F<A,A>> f) +
      Folds the tree to the right with the given function.
      +
      abstract FingerTree<V,A>snoc(A a) +
      Adds the given element to this tree as the last element.
      +
      P2<FingerTree<V,A>,FingerTree<V,A>>split(F<V,java.lang.Boolean> predicate) +
      Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
      +
      P3<FingerTree<V,A>,A,FingerTree<V,A>>split1(F<V,java.lang.Boolean> predicate) +
      Like split, but returns the element where pred first holds separately.
      +
      abstract FingerTree<V,A>tail() +
      The tree without the first element.
      +
      abstract Stream<A>toStream() 
      <B> Buncons(B nil, + F2<A,FingerTree<V,A>,B> cons) +
      Performs a reduction on this finger tree using the given arguments.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B z)
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public abstract A reduceRight(F<A,F<A,A>> f)
        +
        Folds the tree to the right with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B z)
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public abstract A reduceLeft(F<A,F<A,A>> f)
        +
        Folds the tree to the left with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public abstract <B> FingerTree<V,B> map(F<A,B> f,
+                                        Measured<V,B> m)
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Parameters:
        +
        f - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <B> FingerTree<V,A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public abstract V measure()
        +
        Returns the sum of this tree's annotations.
        +
        +
        Returns:
        +
        the sum of this tree's annotations.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Indicates whether this tree is empty.
        +
        +
        Returns:
        +
        true if this tree is the empty tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public final Measured<V,A> measured()
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Empty<V,A>,B> empty,
+                            F<Single<V,A>,B> single,
+                            F<Deep<V,A>,B> deep)
        +
        Provides pattern matching on trees. This is the Church encoding of the FingerTree datatype.
        +
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> monoid,
+                                           F<A,V> measure)
        +
        Constructs a Measured instance for the element type, given a monoid and a measuring function.
        +
        +
        Parameters:
        +
        monoid - A monoid for the measures.
        +
        measure - A function with which to measure element values.
        +
        Returns:
        +
        A Measured instance for the given element type, that uses the given monoid and measuring function.
        +
        +
        • +
      + + + +
        +
      • +

        mkTree

        +
        public static <V,A> MakeTree<V,A> mkTree(Measured<V,A> m)
        +
        Returns a builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        Parameters:
        +
        m - A Measured instance with which to annotate trees, digits, and nodes.
        +
        Returns:
        +
        A builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public abstract FingerTree<V,A> cons(A a)
        +
        Adds the given element to this tree as the first element.
        +
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public abstract FingerTree<V,A> snoc(A a)
        +
        Adds the given element to this tree as the last element.
        +
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F2<A,FingerTree<V,A>,B> cons)
        +
        Performs a reduction on this finger tree using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this finger tree is empty.
        +
        cons - The function to apply to the head and tail of this finger tree if it is not empty.
        +
        Returns:
        +
        A reduction on this finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public abstract A last()
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract FingerTree<V,A> tail()
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public abstract FingerTree<V,A> init()
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public abstract FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Appends one finger tree to another.
        +
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<FingerTree<V,A>,FingerTree<V,A>> split(F<V,java.lang.Boolean> predicate)
        +
        Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subtree containing elements before the point where pred first holds and the subtree + containing element at and after the point where pred first holds. Empty if pred never holds.
        +
        +
        • +
      + + + +
        +
      • +

        split1

        +
        public final P3<FingerTree<V,A>,A,FingerTree<V,A>> split1(F<V,java.lang.Boolean> predicate)
        +
        Like split, but returns the element where pred first holds separately. + + Throws an error if the tree is empty.
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        emptyIntAddition

        +
        public static <A> FingerTree<java.lang.Integer,A> emptyIntAddition()
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <V,A> FingerTree<V,A> empty(Monoid<V> m,
+                                          F<A,V> f)
        +
        Creates an empty finger tree with elements of type A and node annotations + of type V.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations
        +
        f - Function to convert node element to annotation.
        +
        Returns:
        +
        An empty finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        emptyIntMax

        +
        public static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>> emptyIntMax()
        +
        Returns a finger tree which combines the integer node annotations with the + maximum function. A priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Four.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Four.html new file mode 100644 index 0000000..b0d326a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Four.html @@ -0,0 +1,419 @@ + + + + + +Four (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Four<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Four<V,A>
+extends Digit<V,A>
    +
    A four-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V4<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V4<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/MakeTree.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/MakeTree.html new file mode 100644 index 0000000..423c9af --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/MakeTree.html @@ -0,0 +1,544 @@ + + + + + +MakeTree (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class MakeTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class MakeTree<V,A>
+extends java.lang.Object
    +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public FingerTree<V,A> empty()
        +
        Constructs an empty tree.
        +
        +
        Returns:
        +
        The empty tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public FingerTree<V,A> single(A a)
        +
        Constructs a singleton tree.
        +
        +
        Parameters:
        +
        a - A single element for the tree.
        +
        Returns:
        +
        A tree with the given value as the single element.
        +
        +
        • +
      + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree. This structure consists of two digits, of 1 to 4 elements each, on the left and right, + with the rest of the tree in the middle.
        +
        +
        Parameters:
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle.
        +
        +
        • +
      + + + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(V v,
+                            Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree with the given annotation value.
        +
        +
        Parameters:
        +
        v - The value with which to annotate this tree.
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle, and annotated with the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        one

        +
        public One<V,A> one(A a)
        +
        A digit of one element.
        +
        +
        Parameters:
        +
        a - The element of the digit.
        +
        Returns:
        +
        A digit of the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        two

        +
        public Two<V,A> two(A a,
+                    A b)
        +
        A digit of two elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        three

        +
        public Three<V,A> three(A a,
+                        A b,
+                        A c)
        +
        A digit of three elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        four

        +
        public Four<V,A> four(A a,
+                      A b,
+                      A c,
+                      A d)
        +
        A digit of four elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        d - The fifth element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(A a,
+                        A b)
        +
        A binary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The right child of the node.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(A a,
+                        A b,
+                        A c)
        +
        A trinary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The middle child of the node.
        +
        c - The right child of the node.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(V2<A> v)
        +
        A binary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(V3<A> v)
        +
        A trinary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Measured.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Measured.html new file mode 100644 index 0000000..ddd42cd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Measured.html @@ -0,0 +1,390 @@ + + + + + +Measured (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Measured<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Measured<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Measured<V,A>
+extends java.lang.Object
    +
    Determines how the elements of a tree are measured and how measures are summed. Consists of a monoid and a + measuring function. Different instances of this class will result in different behaviours for the tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> m,
+                                           F<A,V> measure)
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<V> monoid()
        +
        Returns the monoid used to sum measures.
        +
        +
        Returns:
        +
        the monoid used to sum measures.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public F<A,V> measure()
        +
        Returns the measuring function.
        +
        +
        Returns:
        +
        the measuring function.
        +
        +
        • +
      + + + + + +
        +
      • +

        measure

        +
        public V measure(A a)
        +
        Measures a given element.
        +
        +
        Parameters:
        +
        a - An element to measure.
        +
        Returns:
        +
        the element's measurement.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public V sum(V a,
+             V b)
        +
        Sums the given measurements with the monoid.
        +
        +
        Parameters:
        +
        a - A measurement to add to another.
        +
        b - A measurement to add to another.
        +
        Returns:
        +
        The sum of the two measurements.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public V zero()
        +
        Returns the identity measurement for the monoid.
        +
        +
        Returns:
        +
        the identity measurement for the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        nodeMeasured

        +
        public Measured<V,Node<V,A>> nodeMeasured()
        +
        A measured instance for nodes.
        +
        +
        Returns:
        +
        A measured instance for nodes.
        +
        +
        • +
      + + + +
        +
      • +

        digitMeasured

        +
        public Measured<V,Digit<V,A>> digitMeasured()
        +
        A measured instance for digits.
        +
        +
        Returns:
        +
        A measured instance for digits.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Node.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node.html new file mode 100644 index 0000000..b0474c8 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node.html @@ -0,0 +1,399 @@ + + + + + +Node (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Node<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Node2, Node3
    +
    +
    +
    +
    public abstract class Node<V,A>
+extends java.lang.Object
    +
    An inner node of the 2-3 tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        • +
      + + + +
        +
      • +

        foldLeft_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldLeft_(F<B,F<A,B>> bff)
        +
        • +
      + + + +
        +
      • +

        foldRight_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldRight_(F<A,F<B,B>> aff)
        +
        • +
      + + + + + + + +
        +
      • +

        liftM

        +
        public static <V,A,B> F<Node<V,A>,Node<V,B>> liftM(F<A,B> f,
+                                                   Measured<V,B> m)
        +
        • +
      + + + +
        +
      • +

        toDigit

        +
        public abstract Digit<V,A> toDigit()
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Node2<V,A>,B> n2,
+                            F<Node3<V,A>,B> n3)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Node2.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node2.html new file mode 100644 index 0000000..75442b1 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node2.html @@ -0,0 +1,396 @@ + + + + + +Node2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node2<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node2<V,A>
+extends Node<V,A>
    +
    A two-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V2<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Node3.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node3.html new file mode 100644 index 0000000..9ebfc39 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Node3.html @@ -0,0 +1,396 @@ + + + + + +Node3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node3<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node3<V,A>
+extends Node<V,A>
    +
    A three-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V3<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/One.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/One.html new file mode 100644 index 0000000..c216a32 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/One.html @@ -0,0 +1,419 @@ + + + + + +One (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class One<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class One<V,A>
+extends Digit<V,A>
    +
    A single-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      Avalue() +
      Returns the single element in this digit.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element in this digit.
        +
        +
        Returns:
        +
        the single element in this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Single.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Single.html new file mode 100644 index 0000000..459d511 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Single.html @@ -0,0 +1,687 @@ + + + + + +Single (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Single<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Single<V,A>
+extends FingerTree<V,A>
    +
    A tree with a single element.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the annotation of this tree's single element.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the annotation of this tree's single element.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the singleton tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element of this tree.
        +
        +
        Returns:
        +
        the single element of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Three.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Three.html new file mode 100644 index 0000000..5766cf6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Three.html @@ -0,0 +1,419 @@ + + + + + +Three (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Three<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Three<V,A>
+extends Digit<V,A>
    +
    A three-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V3<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V3<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/Two.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/Two.html new file mode 100644 index 0000000..b90c984 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/Two.html @@ -0,0 +1,419 @@ + + + + + +Two (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Two<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Two<V,A>
+extends Digit<V,A>
    +
    A two-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V2<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V2<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/package-frame.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-frame.html new file mode 100644 index 0000000..51af3d6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-frame.html @@ -0,0 +1,33 @@ + + + + + +fj.data.fingertrees (core 4.8 API) + + + + + +

fj.data.fingertrees

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/package-summary.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-summary.html new file mode 100644 index 0000000..ef1c5ca --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-summary.html @@ -0,0 +1,236 @@ + + + + + +fj.data.fingertrees (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.fingertrees

+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Deep<V,A> +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    Digit<V,A> +
    A digit is a vector of 1-4 elements.
    +
    Empty<V,A> +
    The empty tree.
    +
    FingerTree<V,A> +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
    +
    Four<V,A> +
    A four-element prefix or suffix of a finger tree.
    +
    MakeTree<V,A> +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    Measured<V,A> +
    Determines how the elements of a tree are measured and how measures are summed.
    +
    Node<V,A> +
    An inner node of the 2-3 tree.
    +
    Node2<V,A> +
    A two-element inner tree node.
    +
    Node3<V,A> +
    A three-element inner tree node.
    +
    One<V,A> +
    A single-element prefix or suffix of a finger tree.
    +
    Single<V,A> +
    A tree with a single element.
    +
    Three<V,A> +
    A three-element prefix or suffix of a finger tree.
    +
    Two<V,A> +
    A two-element prefix or suffix of a finger tree.
    +
    +
    • +
+ + + +

Package fj.data.fingertrees Description

+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. + + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/fingertrees/package-tree.html b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-tree.html new file mode 100644 index 0000000..1af1a80 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/fingertrees/package-tree.html @@ -0,0 +1,157 @@ + + + + + +fj.data.fingertrees Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.fingertrees

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.fingertrees.Digit<V,A> +
        +
      • fj.data.fingertrees.Four<V,A>
        • +
      • fj.data.fingertrees.One<V,A>
        • +
      • fj.data.fingertrees.Three<V,A>
        • +
      • fj.data.fingertrees.Two<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.FingerTree<V,A> +
        +
      • fj.data.fingertrees.Deep<V,A>
        • +
      • fj.data.fingertrees.Empty<V,A>
        • +
      • fj.data.fingertrees.Single<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    • fj.data.fingertrees.Measured<V,A>
      • +
    • fj.data.fingertrees.Node<V,A> +
        +
      • fj.data.fingertrees.Node2<V,A>
        • +
      • fj.data.fingertrees.Node3<V,A>
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/BitSet.html b/javadoc/4.8/functionaljava/fj/data/hamt/BitSet.html new file mode 100644 index 0000000..f828b6d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/BitSet.html @@ -0,0 +1,811 @@ + + + + + +BitSet (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class BitSet

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.BitSet
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BitSet
+extends java.lang.Object
    +
    A sequence of bits representing a value. The most significant bit (the + bit with the highest value) is the leftmost bit and has the highest index. + For example, the BitSet("1011") represents the decimal number 11 and has + indices [3, 0] inclusive where the bit with the lowest value has the lowest + index and is the rightmost bit. + + Created by maperr on 31/05/2016.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static BitSet empty()
        +
        • +
      + + + +
        +
      • +

        longBitSet

        +
        public static BitSet longBitSet(long l)
        +
        • +
      + + + +
        +
      • +

        listBitSet

        +
        public static BitSet listBitSet(List<java.lang.Boolean> list)
        +
        • +
      + + + +
        +
      • +

        streamBitSet

        +
        public static BitSet streamBitSet(Stream<java.lang.Boolean> s)
        +
        • +
      + + + +
        +
      • +

        stringBitSet

        +
        public static BitSet stringBitSet(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        isSet

        +
        public boolean isSet(int index)
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index,
+                  boolean b)
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public BitSet clear(int index)
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        shiftRight

        +
        public BitSet shiftRight(int n)
        +
        • +
      + + + +
        +
      • +

        shiftLeft

        +
        public BitSet shiftLeft(int n)
        +
        • +
      + + + +
        +
      • +

        bitsUsed

        +
        public int bitsUsed()
        +
        • +
      + + + +
        +
      • +

        bitsOn

        +
        public int bitsOn()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Boolean> toStream()
        +
        Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        bitsToRight

        +
        public int bitsToRight(int index)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<java.lang.Boolean> toList()
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <A> A foldRight(F2<java.lang.Boolean,A,A> f,
+                       A acc)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <A> A foldLeft(F2<A,java.lang.Boolean,A> f,
+                      A acc)
        +
        • +
      + + + + + + + +
        +
      • +

        not

        +
        public BitSet not()
        +
        • +
      + + + +
        +
      • +

        takeLower

        +
        public BitSet takeLower(int n)
        +
        • +
      + + + +
        +
      • +

        takeUpper

        +
        public BitSet takeUpper(int n)
        +
        • +
      + + + +
        +
      • +

        range

        +
        public BitSet range(int highIndex,
+                    int lowIndex)
        +
        Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g. "101101".range(1, 4) == "0110"
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(char c)
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(int i)
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public static int toInt(boolean b)
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/HashArrayMappedTrie.html b/javadoc/4.8/functionaljava/fj/data/hamt/HashArrayMappedTrie.html new file mode 100644 index 0000000..1c23402 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/HashArrayMappedTrie.html @@ -0,0 +1,606 @@ + + + + + +HashArrayMappedTrie (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class HashArrayMappedTrie<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.HashArrayMappedTrie<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HashArrayMappedTrie<K,V>
+extends java.lang.Object
    +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie. It is a refined version of the more general notion of + a hash tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        SIZE

        +
        public static final int SIZE
        +
        • +
      + + + + + + + +
        +
      • +

        MAX_INDEX

        +
        public static final int MAX_INDEX
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        emptyKeyInteger

        +
        public static <V> HashArrayMappedTrie<java.lang.Integer,V> emptyKeyInteger()
        +
        Create and empty trie keyed by integer.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns if the trie is empty.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k)
        +
        Returns an optional value for the given key k.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k,
+                      int lowIndex,
+                      int highIndex)
        +
        Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
        +
        • +
      + + + + + + + + + + + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        Returns a stream of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList(Ord<K> o)
        +
        Returns the list of key-value pairs, ordered by key.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        Returns a list of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeftOnNode

        +
        public <B> B foldLeftOnNode(F2<B,Node<K,V>,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      F2<B,HashArrayMappedTrie<K,V>,B> g,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + +
        +
      • +

        getBitSet

        +
        public BitSet getBitSet()
        +
        • +
      + + + +
        +
      • +

        getSeq

        +
        public Seq<Node<K,V>> getSeq()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in the trie.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/Node.html b/javadoc/4.8/functionaljava/fj/data/hamt/Node.html new file mode 100644 index 0000000..4dea88d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/Node.html @@ -0,0 +1,358 @@ + + + + + +Node (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class Node<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.Node<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Node<K,V>
+extends java.lang.Object
    +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie. + + Created by maperr on 31/05/2016.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/package-frame.html b/javadoc/4.8/functionaljava/fj/data/hamt/package-frame.html new file mode 100644 index 0000000..af89d7f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/package-frame.html @@ -0,0 +1,22 @@ + + + + + +fj.data.hamt (core 4.8 API) + + + + + +

fj.data.hamt

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/package-summary.html b/javadoc/4.8/functionaljava/fj/data/hamt/package-summary.html new file mode 100644 index 0000000..c072f83 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/package-summary.html @@ -0,0 +1,157 @@ + + + + + +fj.data.hamt (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hamt

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BitSet +
    A sequence of bits representing a value.
    +
    HashArrayMappedTrie<K,V> +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
    +
    Node<K,V> +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hamt/package-tree.html b/javadoc/4.8/functionaljava/fj/data/hamt/package-tree.html new file mode 100644 index 0000000..afc99fb --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hamt/package-tree.html @@ -0,0 +1,137 @@ + + + + + +fj.data.hamt Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hamt

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.Apply.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.Apply.html new file mode 100644 index 0000000..7e9dc88 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.Apply.html @@ -0,0 +1,392 @@ + + + + + +HList.Apply (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HList.Apply<F$,A,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.Apply<F$,A,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    F$ - The type of the function to apply.
    +
    A - The domain of the function.
    +
    R - The function's codomain.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public abstract static class HList.Apply<F$,A,R>
+extends java.lang.Object
    +
    Type-level function application operators.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Apply

        +
        public Apply()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public abstract R apply(F$ f,
+                        A a)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <X,Y> HList.Apply<F<X,Y>,X,Y> f()
        +
        Function application operator.
        +
        +
        Returns:
        +
        an operator that applies a given function to a given argument.
        +
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <X> HList.Apply<Unit,X,X> id()
        +
        Identity operator
        +
        +
        Returns:
        +
        An operator that returns its second argument no matter which function is being applied.
        +
        +
        • +
      + + + +
        +
      • +

        comp

        +
        public static <X,Y,Z> HList.Apply<Unit,P2<F<X,Y>,F<Y,Z>>,F<X,Z>> comp()
        +
        A function application operator for function composition.
        +
        +
        Type Parameters:
        +
        X - The domain.
        +
        Y - The type through which to compose.
        +
        Z - The codomain.
        +
        Returns:
        +
        an operator that composes functions.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.Apply<Unit,P2<E,L>,HList.HCons<E,L>> cons()
        +
        An operator for the construction of heterogeneous lists.
        +
        +
        Returns:
        +
        an operator that constructs heterogeneous lists.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B,C> HList.Apply<HList.HAppend<A,B,C>,P2<A,B>,C> append()
        +
        A function application operator for concatenating heterogeneous lists.
        +
        +
        Type Parameters:
        +
        A - The type of the list to which to append.
        +
        B - The type of the list to append.
        +
        C - The type of the concatenated list.
        +
        Returns:
        +
        an operator that concatenates heterogeneous lists.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.HAppend.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HAppend.html new file mode 100644 index 0000000..2aa0eda --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HAppend.html @@ -0,0 +1,304 @@ + + + + + +HList.HAppend (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HAppend<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HAppend<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The type of the first list.
    +
    B - The type of the second list.
    +
    C - The type of the combined list.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HAppend<A,B,C>
+extends java.lang.Object
    +
    The concatenation of two heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        append

        +
        public C append(A a,
+                B b)
        +
        Append a given heterogeneous list to another.
        +
        +
        Parameters:
        +
        a - a heterogeneous list to be appended to.
        +
        b - a heterogeneous list to append to another.
        +
        Returns:
        +
        a new heterogeneous list consisting of the second argument appended to the first.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <L extends HList<L>> HList.HAppend<HList.HNil,L,L> append()
        +
        Returns a method for concatenating lists to the empty list.
        +
        +
        Returns:
        +
        a method for concatenating lists to the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public static <X,A extends HList<A>,B,C extends HList<C>,H extends HList.HAppend<A,B,C>> HList.HAppend<HList.HCons<X,A>,B,HList.HCons<X,C>> append(H h)
        +
        Returns a method for appending lists to a nonempty heterogeneous list.
        +
        +
        Parameters:
        +
        h - a method for appending lists to the tail of the given nonempty list.
        +
        Returns:
        +
        a method for appending lists to a nonempty heterogeneous list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.HCons.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HCons.html new file mode 100644 index 0000000..54348cd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HCons.html @@ -0,0 +1,324 @@ + + + + + +HList.HCons (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HCons<E,L extends HList<L>>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HCons<E,L extends HList<L>>
+extends HList<HList.HCons<E,L>>
    +
    The nonempty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.HFoldr.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HFoldr.html new file mode 100644 index 0000000..1cb5f50 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HFoldr.html @@ -0,0 +1,323 @@ + + + + + +HList.HFoldr (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HFoldr<G,V,L,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HFoldr<G,V,L,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    G - The type of the function with which to fold.
    +
    V - The type of the value to be substituted for the empty list.
    +
    L - The type of the heterogeneous list to be folded.
    +
    R - The return type of the fold.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HFoldr<G,V,L,R>
+extends java.lang.Object
    +
    The catamorphism over heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hFoldr

        +
        public static <G,V> HList.HFoldr<G,V,HList.HNil,V> hFoldr()
        +
        A fold instance for the empty list.
        +
        +
        Type Parameters:
        +
        G - The type of the function with which to fold.
        +
        V - The type of value that this fold returns.
        +
        Returns:
        +
        a fold instance for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        hFoldr

        +
        public static <E,G,V,L extends HList<L>,R,RR,H extends HList.HFoldr<G,V,L,R>,PP extends HList.Apply<G,P2<E,R>,RR>> HList.HFoldr<G,V,HList.HCons<E,L>,RR> hFoldr(PP p,
+                                                                                                                                                                H h)
        +
        A fold instance for a non-empty heterogeneous list
        +
        +
        Type Parameters:
        +
        E - The type of the head of the list.
        +
        G - The type of function to apply to the head of the list and the fold of its tail.
        +
        V - The type of value to substitute for the empty list.
        +
        L - The type of the tail of the list.
        +
        R - The type of the fold of the tail of the list.
        +
        RR - The return type of the fold.
        +
        H - The type of the fold instance for the tail of the list.
        +
        PP - The type of the given function application operator.
        +
        Parameters:
        +
        p - An operator that applies a function on the head of the list and the fold of its tail.
        +
        h - A fold instance for the tail of the list.
        +
        Returns:
        +
        A fold instance for a non-empty heterogeneous list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public R foldRight(G f,
+                   V v,
+                   L l)
        +
        Folds a non-empty heterogeneous list.
        +
        +
        Parameters:
        +
        f - A function with which to fold.
        +
        v - The value to substitute for the empty list.
        +
        l - The heterogeneous list to be folded.
        +
        Returns:
        +
        a value obtained by folding the given list with the given function.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.HNil.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HNil.html new file mode 100644 index 0000000..087b643 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.HNil.html @@ -0,0 +1,298 @@ + + + + + +HList.HNil (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HNil

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HNil
+extends HList<HList.HNil>
    +
    The empty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HList.html b/javadoc/4.8/functionaljava/fj/data/hlist/HList.html new file mode 100644 index 0000000..3c12763 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HList.html @@ -0,0 +1,384 @@ + + + + + +HList (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList<A extends HList<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The specific type of the list, as a subtype of HList
    +
    +
    +
    Direct Known Subclasses:
    +
    HList.HCons, HList.HNil
    +
    +
    +
    +
    public abstract class HList<A extends HList<A>>
+extends java.lang.Object
    +
    Type-safe heterogeneous lists.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class HList.Apply<F$,A,R> +
      Type-level function application operators.
      +
      static class HList.HAppend<A,B,C> +
      The concatenation of two heterogeneous lists.
      +
      static class HList.HCons<E,L extends HList<L>> +
      The nonempty list
      +
      static class HList.HFoldr<G,V,L,R> +
      The catamorphism over heterogeneous lists.
      +
      static class HList.HNil +
      The empty list
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        extend

        +
        public abstract <E> HList.HCons<E,A> extend(E e)
        +
        Extends (cons) this list by prepending the given element, returning a new list.
        +
        +
        Parameters:
        +
        e - an element to prepend to this list.
        +
        Returns:
        +
        a new heterogeneous list, consisting of the given element prepended to this list.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        nil

        +
        public static HList.HNil nil()
        +
        Returns the empty list.
        +
        +
        Returns:
        +
        the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.HCons<E,L> cons(E e,
+                                                           L l)
        +
        Returns a heterogeneous list consisting of an element and another list.
        +
        +
        Parameters:
        +
        e - an element to put in a list.
        +
        l - the rest of the list.
        +
        Returns:
        +
        a heterogeneous list consisting of an element and another list.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <E> HList.HCons<E,HList.HNil> single(E e)
        +
        Returns a heterogeneous list consisting of a single element.
        +
        +
        Parameters:
        +
        e - an element to put in a list
        +
        Returns:
        +
        a heterogeneous list consisting of a single element.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAdd.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAdd.html new file mode 100644 index 0000000..dfdd980 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAdd.html @@ -0,0 +1,298 @@ + + + + + +HPre.HAdd (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAdd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>
+extends java.lang.Object
    +
    Type-level integer arithmetic
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAnd.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAnd.html new file mode 100644 index 0000000..52ed35d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HAnd.html @@ -0,0 +1,306 @@ + + + + + +HPre.HAnd (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAnd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A and B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean conjunction. A value of this type represents evidence that AB -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HBool.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HBool.html new file mode 100644 index 0000000..f247c55 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HBool.html @@ -0,0 +1,204 @@ + + + + + +HPre.HBool (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HBool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HBool
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HFalse, HPre.HTrue
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HBool
+extends java.lang.Object
    +
    A type-level Boolean
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HCond.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HCond.html new file mode 100644 index 0000000..2f7b19b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HCond.html @@ -0,0 +1,285 @@ + + + + + +HPre.HCond (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HCond<T,X,Y,Z>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HCond<T,X,Y,Z>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - A boolean
    +
    X - The type of Z if T is true.
    +
    Y - The type of Z if T is false.
    +
    Z - A type that is either X or Z, depending on T.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HCond<T,X,Y,Z>
+extends java.lang.Object
    +
    A type-level conditional. The type of the last parameter is implied by the first three.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HEq.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HEq.html new file mode 100644 index 0000000..914fb2f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HEq.html @@ -0,0 +1,323 @@ + + + + + +HPre.HEq (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HEq<X,Y,B extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HEq<X,Y,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HEq<X,Y,B extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level equality. Represents evidence for X and Y being equal, or counterevidence against.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HFalse.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HFalse.html new file mode 100644 index 0000000..075b50c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HFalse.html @@ -0,0 +1,205 @@ + + + + + +HPre.HFalse (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HFalse

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HFalse
+extends HPre.HBool
    +
    Boolean false
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HNat.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HNat.html new file mode 100644 index 0000000..bdad792 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HNat.html @@ -0,0 +1,332 @@ + + + + + +HPre.HNat (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HNat<A extends HPre.HNat<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HNat<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HSucc, HPre.HZero
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public abstract static class HPre.HNat<A extends HPre.HNat<A>>
+extends java.lang.Object
    +
    Type-level natural numbers.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HNat

        +
        public HNat()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HOr.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HOr.html new file mode 100644 index 0000000..aad220d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HOr.html @@ -0,0 +1,306 @@ + + + + + +HPre.HOr (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HOr<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A or B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean disjunction. A value of this type represents evidence that A+B -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HSucc.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HSucc.html new file mode 100644 index 0000000..160c390 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HSucc.html @@ -0,0 +1,277 @@ + + + + + +HPre.HSucc (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HSucc<N extends HPre.HNat<N>>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    N - The predecessor of this number.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HSucc<N extends HPre.HNat<N>>
+extends HPre.HNat<HPre.HSucc<N>>
    +
    A natural number N + 1
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HTrue.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HTrue.html new file mode 100644 index 0000000..57acb49 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HTrue.html @@ -0,0 +1,205 @@ + + + + + +HPre.HTrue (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HTrue

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HTrue
+extends HPre.HBool
    +
    Boolean true
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HZero.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HZero.html new file mode 100644 index 0000000..97109d8 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.HZero.html @@ -0,0 +1,273 @@ + + + + + +HPre.HZero (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HZero

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HZero
+extends HPre.HNat<HPre.HZero>
    +
    Type-level zero
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/HPre.html b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.html new file mode 100644 index 0000000..15f9a7c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/HPre.html @@ -0,0 +1,344 @@ + + + + + +HPre (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HPre
+extends java.lang.Object
    +
    A basic prelude of values lifted into the type system.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hTrue

        +
        public static HPre.HTrue hTrue()
        +
        Returns a boolean value whose type represents truth.
        +
        +
        Returns:
        +
        a boolean value whose type represents truth.
        +
        +
        • +
      + + + +
        +
      • +

        hFalse

        +
        public static HPre.HFalse hFalse()
        +
        Returns a boolean value whose type represents falsehood.
        +
        +
        Returns:
        +
        a boolean value whose type represents falsehood.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/package-frame.html b/javadoc/4.8/functionaljava/fj/data/hlist/package-frame.html new file mode 100644 index 0000000..ff22d75 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/package-frame.html @@ -0,0 +1,37 @@ + + + + + +fj.data.hlist (core 4.8 API) + + + + + +

fj.data.hlist

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/package-summary.html b/javadoc/4.8/functionaljava/fj/data/hlist/package-summary.html new file mode 100644 index 0000000..488253d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/package-summary.html @@ -0,0 +1,253 @@ + + + + + +fj.data.hlist (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hlist

+
+
Type-safe, extensible, heterogeneous lists
+
+

See: Description

+
+
+ + + + +

Package fj.data.hlist Description

+
Type-safe, extensible, heterogeneous lists
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/hlist/package-tree.html b/javadoc/4.8/functionaljava/fj/data/hlist/package-tree.html new file mode 100644 index 0000000..d3e488e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/hlist/package-tree.html @@ -0,0 +1,161 @@ + + + + + +fj.data.hlist Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hlist

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Fold.html b/javadoc/4.8/functionaljava/fj/data/optic/Fold.html new file mode 100644 index 0000000..447479f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Fold.html @@ -0,0 +1,524 @@ + + + + + +Fold (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Fold<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Fold<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Fold
    +
    A - the target of a Fold
    +
    +
    +
    +
    public abstract class Fold<S,A>
+extends java.lang.Object
    +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target. + + Fold is on the top of the Optic hierarchy which means that Getter, PTraversal, POptional, + PLens, PPrism and PIso are valid Fold
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fold

        +
        public Fold()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> m,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a Fold matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a Fold
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public final <S1> Fold<Either<S,S1>,A> sum(Fold<S1,A> other)
        +
        join two Fold with the same target
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <B> Fold<S,B> composeFold(Fold<A,B> other)
        +
        compose a Fold with a Fold
        +
        • +
      + + + +
        +
      • +

        composeGetter

        +
        public final <C> Fold<S,C> composeGetter(Getter<A,C> other)
        +
        compose a Fold with a Getter
        +
        • +
      + + + + + + + +
        +
      • +

        composePrism

        +
        public final <B,C,D> Fold<S,C> composePrism(PPrism<A,B,C,D> other)
        +
        compose a Fold with a PPrism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public final <B,C,D> Fold<S,C> composeLens(PLens<A,B,C,D> other)
        +
        compose a Fold with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <B,C,D> Fold<S,C> composeIso(PIso<A,B,C,D> other)
        +
        compose a Fold with a PIso
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <A> Fold<A,A> id()
        +
        • +
      + + + +
        +
      • +

        codiagonal

        +
        public static <A> Fold<Either<A,A>,A> codiagonal()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Getter.html b/javadoc/4.8/functionaljava/fj/data/optic/Getter.html new file mode 100644 index 0000000..2df3194 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Getter.html @@ -0,0 +1,457 @@ + + + + + +Getter (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class Getter<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Getter<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Getter
    +
    A - the target of a Getter
    +
    +
    +
    +
    public abstract class Getter<S,A>
+extends java.lang.Object
    +
    A Getter can be seen as a glorified get method between a type S and a type A. + + A Getter is also a valid Fold
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Iso.html b/javadoc/4.8/functionaljava/fj/data/optic/Iso.html new file mode 100644 index 0000000..de7baab --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Iso.html @@ -0,0 +1,624 @@ + + + + + +Iso (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Iso<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Iso<S,A>
+extends PIso<S,S,A,A>
    +
    PIso when S = T and A = B
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Iso

        +
        public Iso(PIso<S,S,A,A> pIso)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public A get(S s)
        +
        Description copied from class: PIso
        +
        get the target of a PIso
        +
        +
        Specified by:
        +
        get in class PIso<S,S,A,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public S reverseGet(A a)
        +
        Description copied from class: PIso
        +
        get the modified source of a PIso
        +
        +
        Specified by:
        +
        reverseGet in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Iso<A,S> reverse()
        +
        Description copied from class: PIso
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        +
        Specified by:
        +
        reverse in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public <S1,A1> Iso<P2<S,S1>,P2<A,A1>> product(Iso<S1,A1> other)
        +
        pair two disjoint Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composePrism

        +
        public <C> Prism<S,C> composePrism(Prism<A,C> other)
        +
        compose an Iso with a Prism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public <C> Lens<S,C> composeLens(Lens<A,C> other)
        +
        compose an Iso with a Lens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public <C> Iso<S,C> composeIso(Iso<A,C> other)
        +
        compose an Iso with an Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        iso

        +
        public static <S,A> Iso<S,A> iso(F<S,A> get,
+                                 F<A,S> reverseGet)
        +
        create an Iso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <S> Iso<S,S> id()
        +
        create an Iso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        +  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Lens.html b/javadoc/4.8/functionaljava/fj/data/optic/Lens.html new file mode 100644 index 0000000..0333468 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Lens.html @@ -0,0 +1,770 @@ + + + + + +Lens (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Lens<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Lens<S,A>
+extends PLens<S,S,A,A>
    +
    PLens with a monomorphic set function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Optional.html b/javadoc/4.8/functionaljava/fj/data/optic/Optional.html new file mode 100644 index 0000000..4f0c458 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Optional.html @@ -0,0 +1,817 @@ + + + + + +Optional (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Optional<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Optional<S,A>
+extends POptional<S,S,A,A>
    +
    POptional restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/PIso.html b/javadoc/4.8/functionaljava/fj/data/optic/PIso.html new file mode 100644 index 0000000..5f222b7 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/PIso.html @@ -0,0 +1,844 @@ + + + + + +PIso (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PIso<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PIso<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PIso
    +
    T - the modified source of a PIso
    +
    A - the target of a PIso
    +
    B - the modified target of a PIso
    +
    +
    +
    Direct Known Subclasses:
    +
    Iso
    +
    +
    +
    +
    public abstract class PIso<S,T,A,B>
+extends java.lang.Object
    +
    A PIso defines an isomorphism between types S, A and B, T: + + 
    +              get                           reverse.get
+     -------------------->             -------------------->
+   S                       A         T                       B
+     <--------------------             <--------------------
+       reverse.reverseGet                   reverseGet
+
    + + In addition, if f and g forms an isomorphism between `A` and `B`, i.e. if `f . g = id` and `g . f = id`, then a PIso + defines an isomorphism between `S` and `T`: + + 
    +     S           T                                   S           T
+     |           |                                   |           |
+     |           |                                   |           |
+ get |           | reverseGet     reverse.reverseGet |           | reverse.get
+     |           |                                   |           |
+     |     f     |                                   |     g     |
+     A --------> B                                   A <-------- B
+
    + + A PIso is also a valid Getter, Fold, PLens, PPrism, POptional, + PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PIso
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PIso
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public abstract PIso<B,A,T,S> reverse()
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PIso with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PIso with a value
        +
        • +
      + + + +
        +
      • +

        product

        +
        public final <S1,T1,A1,B1> PIso<P2<S,S1>,P2<T,T1>,P2<A,A1>,P2<B,B1>> product(PIso<S1,T1,A1,B1> other)
        +
        pair two disjoint PIso
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PIso with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PIso with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PIso<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PIso with a PIso
        +
        • +
      + + + +
        +
      • +

        asFold

        +
        public final Fold<S,A> asFold()
        +
        view a PIso as a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pIso

        +
        public static <S,T,A,B> PIso<S,T,A,B> pIso(F<S,A> get,
+                                           F<B,T> reverseGet)
        +
        create a PIso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        pId

        +
        public static <S,T> PIso<S,T,S,T> pId()
        +
        create a PIso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        +  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/PLens.html b/javadoc/4.8/functionaljava/fj/data/optic/PLens.html new file mode 100644 index 0000000..d13a9e9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/PLens.html @@ -0,0 +1,728 @@ + + + + + +PLens (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PLens<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PLens<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PLens
    +
    T - the modified source of a PLens
    +
    A - the target of a PLens
    +
    B - the modified target of a PLens
    +
    +
    +
    Direct Known Subclasses:
    +
    Lens
    +
    +
    +
    +
    public abstract class PLens<S,T,A,B>
+extends java.lang.Object
    +
    A PLens can be seen as a pair of functions: - `get: S => A` i.e. from an `S`, we can extract an `A` - `set: (B, S) => + T` i.e. if we replace an `A` by a `B` in an `S`, we obtain a `T` + + A PLens could also be defined as a weaker PIso where set requires an additional parameter than reverseGet. + + PLens stands for Polymorphic Lens as it set and modify methods change a type `A` to `B` and `S` to `T`. Lens + is a PLens restricted to monomoprhic updates. + + A PLens is also a valid Getter, Fold, POptional, PTraversal and PSetter + + Typically a PLens or Lens can be defined between a Product (e.g. case class, tuple, HList) and one of it is + component.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PLens
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public abstract F<S,T> set(B b)
        +
        set polymorphically the target of a PLens using a function
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public abstract <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public abstract F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PLens using a function
        +
        • +
      + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PLens with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PLens with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PLens<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PLens with an PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PLens<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pLens

        +
        public static <S,T,A,B> PLens<S,T,A,B> pLens(F<S,A> get,
+                                             F<B,F<S,T>> set)
        +
        create a PLens using a pair of functions: one to get the target, one to set the target.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/POptional.html b/javadoc/4.8/functionaljava/fj/data/optic/POptional.html new file mode 100644 index 0000000..fd15c89 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/POptional.html @@ -0,0 +1,788 @@ + + + + + +POptional (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class POptional<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.POptional<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a POptional
    +
    T - the modified source of a POptional
    +
    A - the target of a POptional
    +
    B - the modified target of a POptional
    +
    +
    +
    Direct Known Subclasses:
    +
    Optional
    +
    +
    +
    +
    public abstract class POptional<S,T,A,B>
+extends java.lang.Object
    +
    A POptional can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `set : (B, S) => T` + + A POptional could also be defined as a weaker PLens and weaker PPrism + + POptional stands for Polymorphic Optional as it set and modify methods change a type `A` to `B` and `S` to `T`. + Optional is a POptional restricted to monomoprhic updates: {{{ type Optional[S, A] = POptional[S, S, A, A] + }}}
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/PPrism.html b/javadoc/4.8/functionaljava/fj/data/optic/PPrism.html new file mode 100644 index 0000000..ffabdb5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/PPrism.html @@ -0,0 +1,799 @@ + + + + + +PPrism (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PPrism<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PPrism<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PPrism
    +
    T - the modified source of a PPrism
    +
    A - the target of a PPrism
    +
    B - the modified target of a PPrism
    +
    +
    +
    Direct Known Subclasses:
    +
    Prism
    +
    +
    +
    +
    public abstract class PPrism<S,T,A,B>
+extends java.lang.Object
    +
    A PPrism can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `reverseGet : B => T` + + A PPrism could also be defined as a weaker PIso where get can fail. + + Typically a PPrism or Prism encodes the relation between a Sum or CoProduct type (e.g. sealed trait) and one + of it is element. + + PPrism stands for Polymorphic Prism as it set and modify methods change a type `A` to `B` and `S` to `T`. + Prism is a PPrism where the type of target cannot be modified. + + A PPrism is also a valid Fold, POptional, PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        getOrModify

        +
        public abstract Either<T,A> getOrModify(S s)
        +
        get the target of a PPrism or modify the source in case there is no target
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PPrism
        +
        • +
      + + + + + +
        +
      • +

        getOption

        +
        public abstract Option<A> getOption(S s)
        +
        get the target of a PPrism or nothing if there is no target
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function
        +
        • +
      + + + +
        +
      • +

        modifyOption

        +
        public final F<S,Option<T>> modifyOption(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PPrism with a value
        +
        • +
      + + + + + +
        +
      • +

        setOption

        +
        public final F<S,Option<T>> setOption(B b)
        +
        set polymorphically the target of a PPrism with a value. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        isMatching

        +
        public final boolean isMatching(S s)
        +
        check if a PPrism has a target
        +
        • +
      + + + +
        +
      • +

        re

        +
        public final Getter<B,T> re()
        +
        create a Getter from the modified target to the modified source of a PPrism
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PPrism with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PPrism<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PPrism with a PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PPrism<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pPrism

        +
        public static <S,T,A,B> PPrism<S,T,A,B> pPrism(F<S,Either<T,A>> getOrModify,
+                                               F<B,T> reverseGet)
        +
        create a PPrism using the canonical functions: getOrModify and reverseGet
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/PSetter.html b/javadoc/4.8/functionaljava/fj/data/optic/PSetter.html new file mode 100644 index 0000000..01ef050 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/PSetter.html @@ -0,0 +1,424 @@ + + + + + +PSetter (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PSetter<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PSetter<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PSetter
    +
    T - the modified source of a PSetter
    +
    A - the target of a PSetter
    +
    B - the modified target of a PSetter
    +
    +
    +
    Direct Known Subclasses:
    +
    Setter
    +
    +
    +
    +
    public abstract class PSetter<S,T,A,B>
+extends java.lang.Object
    +
    A PSetter is a generalisation of Functor map: - `map: (A => B) => F[A] => F[B]` - `modify: (A => B) => S => + T` + + PSetter stands for Polymorphic Setter as it set and modify methods change a type `A` to `B` and `S` to `T`. + + PTraversal, POptional, PPrism, PLens and PIso are valid PSetter
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/PTraversal.html b/javadoc/4.8/functionaljava/fj/data/optic/PTraversal.html new file mode 100644 index 0000000..ef8f74d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/PTraversal.html @@ -0,0 +1,908 @@ + + + + + +PTraversal (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class PTraversal<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PTraversal<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PTraversal
    +
    T - the modified source of a PTraversal
    +
    A - the target of a PTraversal
    +
    B - the modified target of a PTraversal
    +
    +
    +
    Direct Known Subclasses:
    +
    Traversal
    +
    +
    +
    +
    public abstract class PTraversal<S,T,A,B>
+extends java.lang.Object
    +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite. + + PTraversal stands for Polymorphic Traversal as it set and modify methods change a type `A` to `B` and `S` to `T`. + Traversal is a PTraversal restricted to monomoprhic updates.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PTraversal

        +
        public PTraversal()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + + + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> monoid,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a PTraversal
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a PTraversal matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a PTraversal
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PTraversal with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PTraversal with a value
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PTraversal<S,T,S,T> pId()
        +
        • +
      + + + + + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F3<B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F4<B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F5<B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F6<B,B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F<S,A> get6,
+                                                       F7<B,B,B,B,B,B,S,T> set)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Prism.html b/javadoc/4.8/functionaljava/fj/data/optic/Prism.html new file mode 100644 index 0000000..c47fd4e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Prism.html @@ -0,0 +1,522 @@ + + + + + +Prism (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Prism<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Prism<S,A>
+extends PPrism<S,S,A,A>
    +
    PPrism restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Setter.html b/javadoc/4.8/functionaljava/fj/data/optic/Setter.html new file mode 100644 index 0000000..c8e5e67 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Setter.html @@ -0,0 +1,419 @@ + + + + + +Setter (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Setter<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Setter<S,A>
+extends PSetter<S,S,A,A>
    +
    PSetter with a monomorphic modify function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/Traversal.html b/javadoc/4.8/functionaljava/fj/data/optic/Traversal.html new file mode 100644 index 0000000..1f8853b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/Traversal.html @@ -0,0 +1,723 @@ + + + + + +Traversal (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Traversal<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Traversal<S,A>
+extends PTraversal<S,S,A,A>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/package-frame.html b/javadoc/4.8/functionaljava/fj/data/optic/package-frame.html new file mode 100644 index 0000000..f706f18 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/package-frame.html @@ -0,0 +1,33 @@ + + + + + +fj.data.optic (core 4.8 API) + + + + + +

fj.data.optic

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/package-summary.html b/javadoc/4.8/functionaljava/fj/data/optic/package-summary.html new file mode 100644 index 0000000..2a5e130 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/package-summary.html @@ -0,0 +1,246 @@ + + + + + +fj.data.optic (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.optic

+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Fold<S,A> +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
    +
    Getter<S,A> +
    A Getter can be seen as a glorified get method between a type S and a type A.
    +
    Iso<S,A> +
    PIso when S = T and A = B
    +
    Lens<S,A> +
    PLens with a monomorphic set function
    +
    Optional<S,A> +
    POptional restricted to monomorphic update
    +
    PIso<S,T,A,B> +
    A PIso defines an isomorphism between types S, A and B, T:
    +
    PLens<S,T,A,B> +
    A PLens can be seen as a pair of functions: - `get: S => A` i.e.
    +
    POptional<S,T,A,B> +
    A POptional can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `set : (B, S) => T` + + A POptional could also be defined as a weaker PLens and weaker PPrism + + POptional stands for Polymorphic Optional as it set and modify methods change a type `A` to `B` and `S` to `T`.
    +
    PPrism<S,T,A,B> +
    A PPrism can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `reverseGet : B => T` + + A PPrism could also be defined as a weaker PIso where get can fail.
    +
    Prism<S,A> +
    PPrism restricted to monomorphic update
    +
    PSetter<S,T,A,B> +
    A PSetter is a generalisation of Functor map: - `map: (A => B) => F[A] => F[B]` - `modify: (A => B) => S => + T` + + PSetter stands for Polymorphic Setter as it set and modify methods change a type `A` to `B` and `S` to `T`.
    +
    PTraversal<S,T,A,B> +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
    +
    Setter<S,A> +
    PSetter with a monomorphic modify function
    +
    Traversal<S,A> 
    +
    • +
+ + + +

Package fj.data.optic Description

+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library. See the Monocle Github + page for an overview of the package.
+
+
See Also:
+
Monocle
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/optic/package-tree.html b/javadoc/4.8/functionaljava/fj/data/optic/package-tree.html new file mode 100644 index 0000000..728bdd6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/optic/package-tree.html @@ -0,0 +1,166 @@ + + + + + +fj.data.optic Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.optic

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.optic.Fold<S,A>
      • +
    • fj.data.optic.Getter<S,A>
      • +
    • fj.data.optic.PIso<S,T,A,B> +
        +
      • fj.data.optic.Iso<S,A>
        • +
      +
      • +
    • fj.data.optic.PLens<S,T,A,B> +
        +
      • fj.data.optic.Lens<S,A>
        • +
      +
      • +
    • fj.data.optic.POptional<S,T,A,B> + +
      • +
    • fj.data.optic.PPrism<S,T,A,B> +
        +
      • fj.data.optic.Prism<S,A>
        • +
      +
      • +
    • fj.data.optic.PSetter<S,T,A,B> + +
      • +
    • fj.data.optic.PTraversal<S,T,A,B> + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/package-frame.html b/javadoc/4.8/functionaljava/fj/data/package-frame.html new file mode 100644 index 0000000..2817d48 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/package-frame.html @@ -0,0 +1,65 @@ + + + + + +fj.data (core 4.8 API) + + + + + +

fj.data

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/package-summary.html b/javadoc/4.8/functionaljava/fj/data/package-summary.html new file mode 100644 index 0000000..882c16f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/package-summary.html @@ -0,0 +1,413 @@ + + + + + +fj.data (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data

+
+
Common algebraic data types.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    IO<A> +
    IO monad for processing files
    +
    SafeIO<A> +
    Created by MarkPerry on 3/07/2014.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    $<A,B> +
    The constant arrow, for attaching a new name to an existing type.
    +
    Array<A> +
    Provides an interface to arrays.
    +
    Array.ImmutableProjection<A> +
    Projects an array by providing only operations which do not mutate.
    +
    Conversions +
    Functions that convert between data structure types.
    +
    DList<A> +
    Difference List.
    +
    Either<A,B> +
    The Either type represents a value of one of two possible types (a disjoint union).
    +
    Either.LeftProjection<A,B> +
    A left projection of an either value.
    +
    Either.RightProjection<A,B> +
    A right projection of an either value.
    +
    Enumerator<A> +
    Abstracts over a type that may have a successor and/or predecessor value.
    +
    Eval<A> +
    Eval is an abstraction over different models of evaluation.
    +
    HashMap<K,V> +
    A mutable hash map providing O(1) lookup.
    +
    HashSet<A> +
    A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
    +
    IOFunctions +
    IO monad for processing files, with main methods IOFunctions.enumFileLines(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.String, A>), + IOFunctions.enumFileChars(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.Character, A>) and IOFunctions.enumFileCharChunks(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<char[], A>) + (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee + without indirection in between).
    +
    IOW<A> +
    Created by MarkPerry on 9/06/2015.
    +
    IterableW<A> +
    A wrapper for Iterable that equips it with some useful functions.
    +
    Iteratee 
    Iteratee.Input<E> +
    The input to an iteratee.
    +
    Iteratee.IterV<E,A> +
    A pure iteratee computation which is either done or needs more input
    +
    Java +
    Functions that convert between types from the core Java API.
    +
    LazyString +
    A lazy (non-evaluated) immutable character string.
    +
    List<A> +
    Provides an in-memory, immutable, singly linked list.
    +
    List.Buffer<A> +
    A mutable, singly linked list.
    +
    List.Optic +
    Optic factory methods for a List
    +
    List.Unsafe 
    Natural +
    Represents a natural number (zero, one, two, etc.)
    +
    NonEmptyList<A> +
    Provides an in-memory, immutable, singly linked list with total head and tail.
    +
    Option<A> +
    An optional value that may be none (no value) or some (a value).
    +
    Option.Optic 
    PriorityQueue<K,A> +
    A priority queue implementation backed by a + FingerTree.
    +
    Reader<A,B> +
    The Reader monad (also called the function monad, so equivalent to the idea of F).
    +
    Seq<A> +
    Provides an immutable finite sequence, implemented as a finger tree.
    +
    Set<A> +
    Provides an in-memory, immutable set, implemented as a red/black tree.
    +
    State<S,A> +
    Created by MarkPerry on 7/07/2014.
    +
    Stream<A> +
    A lazy (not yet evaluated), immutable, singly linked list.
    +
    Tree<A> +
    Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
    +
    TreeMap<K,V> +
    An immutable, in-memory map, backed by a red-black tree.
    +
    TreeZipper<A> +
    Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.
    +
    Validation<E,T> +
    Isomorphic to Either but has renamed functions and represents failure on the left and success on the right.
    +
    Validation.FailProjection<E,T> +
    A failing projection of a validation.
    +
    Writer<W,A> +
    Created by MarkPerry on 7/07/2014.
    +
    Zipper<A> +
    Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream.
    +
    +
    • +
+ + + +

Package fj.data Description

+
Common algebraic data types.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/package-tree.html b/javadoc/4.8/functionaljava/fj/data/package-tree.html new file mode 100644 index 0000000..1e4eccf --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/package-tree.html @@ -0,0 +1,191 @@ + + + + + +fj.data Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+
    +
  • fj.data.IO<A> + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V.html b/javadoc/4.8/functionaljava/fj/data/vector/V.html new file mode 100644 index 0000000..348030d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V.html @@ -0,0 +1,547 @@ + + + + + +V (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class V
+extends java.lang.Object
    +
    Functions across vectors.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> V2<A>v(A a1, + A a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(A a1, + A a2, + A a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(A a1, + A a2, + A a3, + A a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(A a1, + A a2, + A a3, + A a4, + A a5) +
      Puts elements in a vector-5.
      +
      static <A> V2<A>v(F0<A> a1, + F0<A> a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(P1<A> a1, + F0<A> a2, + F0<A> a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(P1<A> a1, + P1<A> a2, + F0<A> a3, + F0<A> a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(P1<A> a1, + P1<A> a2, + P1<A> a3, + F0<A> a4, + F0<A> a5) +
      Puts elements in a vector-5.
      +
      static <A> F2<A,A,V2<A>>v2() +
      Returns a function that puts elements in a vector-2.
      +
      static <A> F3<A,A,A,V3<A>>v3() +
      Returns a function that puts elements in a vector-3.
      +
      static <A> F4<A,A,A,A,V4<A>>v4() +
      Returns a function that puts elements in a vector-4.
      +
      static <A> F5<A,A,A,A,A,V5<A>>v5() +
      Returns a function that puts elements in a vector-5.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(A a1,
+                          A a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(F0<A> a1,
+                          F0<A> a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v2

        +
        public static <A> F2<A,A,V2<A>> v2()
        +
        Returns a function that puts elements in a vector-2.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(A a1,
+                          A a2,
+                          A a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(P1<A> a1,
+                          F0<A> a2,
+                          F0<A> a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v3

        +
        public static <A> F3<A,A,A,V3<A>> v3()
        +
        Returns a function that puts elements in a vector-3.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(P1<A> a1,
+                          P1<A> a2,
+                          F0<A> a3,
+                          F0<A> a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v4

        +
        public static <A> F4<A,A,A,A,V4<A>> v4()
        +
        Returns a function that puts elements in a vector-4.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4,
+                          A a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(P1<A> a1,
+                          P1<A> a2,
+                          P1<A> a3,
+                          F0<A> a4,
+                          F0<A> a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v5

        +
        public static <A> F5<A,A,A,A,A,V5<A>> v5()
        +
        Returns a function that puts elements in a vector-5.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-5.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V2.html b/javadoc/4.8/functionaljava/fj/data/vector/V2.html new file mode 100644 index 0000000..699e5d4 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V2.html @@ -0,0 +1,647 @@ + + + + + +V2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V2<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V2<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V2<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V2<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V2<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      <B> V2<B>apply(V2<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Return the first element of this vector as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V2<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V2<A>,P2<A,A>>p_() +
      Returns a function that transforms a vector-2 to the equivalent product-2.
      +
      P2<A,A>p() +
      Returns a homogeneous product-2 equivalent to this vector.
      +
      static <A> V2<A>p(P2<A,A> p) +
      Creates a vector-2 from a homogeneous product-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V2<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-2 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V2<V2<A>>vzip(V2<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V2<P2<A,B>>zip(V2<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V2<C>zipWith(F<A,F<B,C>> f, + V2<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V2<A> p(P2<A,A> p)
        +
        Creates a vector-2 from a homogeneous product-2.
        +
        +
        Parameters:
        +
        p - The product-2 from which to create a vector.
        +
        Returns:
        +
        A new vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V2<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V2<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P2<A,A> p()
        +
        Returns a homogeneous product-2 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-2 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V2<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-2 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V2<A>,P2<A,A>> p_()
        +
        Returns a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V2<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V2<B> apply(V2<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V2<C> zipWith(F<A,F<B,C>> f,
+                           V2<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V2<P2<A,B>> zip(V2<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V2<V2<A>> vzip(V2<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Return the first element of this vector as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector as a product-1.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V3.html b/javadoc/4.8/functionaljava/fj/data/vector/V3.html new file mode 100644 index 0000000..0a83b7a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V3.html @@ -0,0 +1,732 @@ + + + + + +V3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V3<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V3<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V3<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V3<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V3<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V3<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      <B> V3<B>apply(V3<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V3<A>cons(P1<A> head, + V2<A> tail) +
      Creates a vector-3 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V3<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V3<A>,P3<A,A,A>>p_() +
      Returns a function that transforms a vector-3 to the equivalent product-3.
      +
      P3<A,A,A>p() +
      Returns a homogeneous product-3 equivalent to this vector.
      +
      static <A> V3<A>p(P3<A,A,A> p) +
      Creates a vector-3 from a homogeneous product-3.
      +
      V2<A>tail() +
      Returns all but the first element of this vector, as a vector-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V3<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-3 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V3<V2<A>>vzip(V3<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V3<P2<A,B>>zip(V3<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V3<C>zipWith(F<A,F<B,C>> f, + V3<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V3<A> p(P3<A,A,A> p)
        +
        Creates a vector-3 from a homogeneous product-3.
        +
        +
        Parameters:
        +
        p - The product-3 from which to create a vector.
        +
        Returns:
        +
        A new vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V3<A> cons(P1<A> head,
+                             V2<A> tail)
        +
        Creates a vector-3 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V2<A> tail()
        +
        Returns all but the first element of this vector, as a vector-2.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<A,A,A> p()
        +
        Returns a homogeneous product-3 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-3 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V3<B> apply(V3<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V3<C> zipWith(F<A,F<B,C>> f,
+                           V3<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V3<P2<A,B>> zip(V3<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V3<V2<A>> vzip(V3<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V3<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V3<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-3 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V3<A>,P3<A,A,A>> p_()
        +
        Returns a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V3<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V3<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V3<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V4.html b/javadoc/4.8/functionaljava/fj/data/vector/V4.html new file mode 100644 index 0000000..915b45e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V4.html @@ -0,0 +1,772 @@ + + + + + +V4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V4<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V4<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V4<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V4<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V4<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V4<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V4<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      <B> V4<B>apply(V4<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V4<A>cons(P1<A> head, + V3<A> tail) +
      Creates a vector-4 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V4<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V4<A>,P4<A,A,A,A>>p_() +
      Returns a function that transforms a vector-4 to the equivalent product-4.
      +
      P4<A,A,A,A>p() +
      Returns a homogeneous product-4 equivalent to this vector.
      +
      static <A> V4<A>p(P4<A,A,A,A> p) +
      Creates a vector-4 from a homogeneous product-4.
      +
      V3<A>tail() +
      Returns all but the first element of this vector, as a vector-3.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V4<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-4 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V4<V2<A>>vzip(V4<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V4<P2<A,B>>zip(V4<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V4<C>zipWith(F<A,F<B,C>> f, + V4<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V4<A> p(P4<A,A,A,A> p)
        +
        Creates a vector-4 from a homogeneous product-4.
        +
        +
        Parameters:
        +
        p - The product-4 from which to create a vector.
        +
        Returns:
        +
        A new vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V4<A> cons(P1<A> head,
+                             V3<A> tail)
        +
        Creates a vector-4 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V3<A> tail()
        +
        Returns all but the first element of this vector, as a vector-3.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P4<A,A,A,A> p()
        +
        Returns a homogeneous product-4 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-4 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V4<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V4<B> apply(V4<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V4<C> zipWith(F<A,F<B,C>> f,
+                           V4<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V4<P2<A,B>> zip(V4<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V4<V2<A>> vzip(V4<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V4<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-4 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V4<A>,P4<A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V4<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V4<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V4<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V4<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V5.html b/javadoc/4.8/functionaljava/fj/data/vector/V5.html new file mode 100644 index 0000000..540ca2c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V5.html @@ -0,0 +1,812 @@ + + + + + +V5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V5<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V5<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V5<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V5<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V5<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V5<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V5<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V5<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      <B> V5<B>apply(V5<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V5<A>cons(P1<A> head, + V4<A> tail) +
      Creates a vector-5 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V5<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V5<A>,P5<A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-5 to the equivalent product-5.
      +
      P5<A,A,A,A,A>p() +
      Returns a homogeneous product-5 equivalent to this vector.
      +
      static <A> V5<A>p(P5<A,A,A,A,A> p) +
      Creates a vector-5 from a homogeneous product-5.
      +
      V4<A>tail() +
      Returns all but the first element of this vector, as a vector-4.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V5<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-5 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V5<V2<A>>vzip(V5<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V5<P2<A,B>>zip(V5<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V5<C>zipWith(F<A,F<B,C>> f, + V5<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V5<A> p(P5<A,A,A,A,A> p)
        +
        Creates a vector-5 from a homogeneous product-5.
        +
        +
        Parameters:
        +
        p - The product-5 from which to create a vector.
        +
        Returns:
        +
        A new vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V5<A> cons(P1<A> head,
+                             V4<A> tail)
        +
        Creates a vector-5 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V4<A> tail()
        +
        Returns all but the first element of this vector, as a vector-4.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P5<A,A,A,A,A> p()
        +
        Returns a homogeneous product-5 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-5 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V5<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V5<B> apply(V5<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V5<C> zipWith(F<A,F<B,C>> f,
+                           V5<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V5<P2<A,B>> zip(V5<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V5<V2<A>> vzip(V5<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V5<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-5 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V5<A>,P5<A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V5<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V5<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V5<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V5<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V5<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V6.html b/javadoc/4.8/functionaljava/fj/data/vector/V6.html new file mode 100644 index 0000000..41719da --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V6.html @@ -0,0 +1,852 @@ + + + + + +V6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V6<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V6<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V6<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V6<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V6<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V6<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V6<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V6<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V6<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      <B> V6<B>apply(V6<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V6<A>cons(P1<A> head, + V5<A> tail) +
      Creates a vector-6 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V6<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V6<A>,P6<A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-6 to the equivalent product-6.
      +
      P6<A,A,A,A,A,A>p() +
      Returns a homogeneous product-6 equivalent to this vector.
      +
      static <A> V6<A>p(P6<A,A,A,A,A,A> p) +
      Creates a vector-6 from a homogeneous product-6.
      +
      V5<A>tail() +
      Returns all but the first element of this vector, as a vector-5.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V6<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-6 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V6<V2<A>>vzip(V6<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V6<P2<A,B>>zip(V6<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V6<C>zipWith(F<A,F<B,C>> f, + V6<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V6<A> p(P6<A,A,A,A,A,A> p)
        +
        Creates a vector-6 from a homogeneous product-6.
        +
        +
        Parameters:
        +
        p - The product-6 from which to create a vector.
        +
        Returns:
        +
        A new vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V6<A> cons(P1<A> head,
+                             V5<A> tail)
        +
        Creates a vector-6 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V5<A> tail()
        +
        Returns all but the first element of this vector, as a vector-5.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P6<A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-6 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-6 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V6<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V6<B> apply(V6<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V6<C> zipWith(F<A,F<B,C>> f,
+                           V6<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V6<P2<A,B>> zip(V6<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V6<V2<A>> vzip(V6<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V6<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-6 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V6<A>,P6<A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V6<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V6<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V6<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V6<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V6<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V6<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V7.html b/javadoc/4.8/functionaljava/fj/data/vector/V7.html new file mode 100644 index 0000000..d01503e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V7.html @@ -0,0 +1,892 @@ + + + + + +V7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V7<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V7<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V7<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V7<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V7<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V7<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V7<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V7<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V7<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V7<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      <B> V7<B>apply(V7<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V7<A>cons(P1<A> head, + V6<A> tail) +
      Creates a vector-7 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V7<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V7<A>,P7<A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-7 to the equivalent product-7.
      +
      P7<A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-7 equivalent to this vector.
      +
      static <A> V7<A>p(P7<A,A,A,A,A,A,A> p) +
      Creates a vector-7 from a homogeneous product-7.
      +
      V6<A>tail() +
      Returns all but the first element of this vector, as a vector-6.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V7<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-7 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V7<V2<A>>vzip(V7<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V7<P2<A,B>>zip(V7<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V7<C>zipWith(F<A,F<B,C>> f, + V7<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V7<A> p(P7<A,A,A,A,A,A,A> p)
        +
        Creates a vector-7 from a homogeneous product-7.
        +
        +
        Parameters:
        +
        p - The product-7 from which to create a vector.
        +
        Returns:
        +
        A new vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V7<A> cons(P1<A> head,
+                             V6<A> tail)
        +
        Creates a vector-7 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V6<A> tail()
        +
        Returns all but the first element of this vector, as a vector-6.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P7<A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-7 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-7 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V7<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V7<B> apply(V7<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V7<C> zipWith(F<A,F<B,C>> f,
+                           V7<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V7<P2<A,B>> zip(V7<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V7<V2<A>> vzip(V7<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V7<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-7 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V7<A>,P7<A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V7<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V7<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V7<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V7<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V7<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V7<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V7<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/V8.html b/javadoc/4.8/functionaljava/fj/data/vector/V8.html new file mode 100644 index 0000000..3b5accc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/V8.html @@ -0,0 +1,932 @@ + + + + + +V8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V8<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V8<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V8<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V8<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V8<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V8<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V8<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V8<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V8<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V8<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      static <A> F<V8<A>,A>__8() +
      A first-class function to get the eighth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      A_8() +
      Returns the eighth element of this vector.
      +
      <B> V8<B>apply(V8<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V8<A>cons(P1<A> head, + V7<A> tail) +
      Creates a vector-8 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V8<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-8 to the equivalent product-8.
      +
      P8<A,A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-8 equivalent to this vector.
      +
      static <A> V8<A>p(P8<A,A,A,A,A,A,A,A> p) +
      Creates a vector-8 from a homogeneous product-8.
      +
      V7<A>tail() +
      Returns all but the first element of this vector, as a vector-7.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V8<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-8 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V8<V2<A>>vzip(V8<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V8<P2<A,B>>zip(V8<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V8<C>zipWith(F<A,F<B,C>> f, + V8<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V8<A> p(P8<A,A,A,A,A,A,A,A> p)
        +
        Creates a vector-8 from a homogeneous product-8.
        +
        +
        Parameters:
        +
        p - The product-8 from which to create a vector.
        +
        Returns:
        +
        A new vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V8<A> cons(P1<A> head,
+                             V7<A> tail)
        +
        Creates a vector-8 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public A _8()
        +
        Returns the eighth element of this vector.
        +
        +
        Returns:
        +
        the eighth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V7<A> tail()
        +
        Returns all but the first element of this vector, as a vector-7.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P8<A,A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-8 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-8 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V8<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V8<B> apply(V8<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V8<C> zipWith(F<A,F<B,C>> f,
+                           V8<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V8<P2<A,B>> zip(V8<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V8<V2<A>> vzip(V8<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V8<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-8 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V8<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V8<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V8<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V8<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V8<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V8<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V8<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A> F<V8<A>,A> __8()
        +
        A first-class function to get the eighth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the eighth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/package-frame.html b/javadoc/4.8/functionaljava/fj/data/vector/package-frame.html new file mode 100644 index 0000000..d125a9c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/package-frame.html @@ -0,0 +1,27 @@ + + + + + +fj.data.vector (core 4.8 API) + + + + + +

fj.data.vector

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/package-summary.html b/javadoc/4.8/functionaljava/fj/data/vector/package-summary.html new file mode 100644 index 0000000..6e60e0e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/package-summary.html @@ -0,0 +1,193 @@ + + + + + +fj.data.vector (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.vector

+
+
Fixed-length vectors
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    V +
    Functions across vectors.
    +
    V2<A> +
    A vector-2.
    +
    V3<A> +
    A vector-3.
    +
    V4<A> +
    A vector-4.
    +
    V5<A> +
    A vector-5.
    +
    V6<A> +
    A vector-6.
    +
    V7<A> +
    A vector-7.
    +
    V8<A> +
    A vector-8.
    +
    +
    • +
+ + + +

Package fj.data.vector Description

+
Fixed-length vectors
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/data/vector/package-tree.html b/javadoc/4.8/functionaljava/fj/data/vector/package-tree.html new file mode 100644 index 0000000..a6beff8 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/data/vector/package-tree.html @@ -0,0 +1,142 @@ + + + + + +fj.data.vector Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.vector

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.vector.V
      • +
    • fj.data.vector.V2<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V3<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V4<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V5<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V6<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V7<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V8<A> (implements java.lang.Iterable<T>)
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/BigIntegers.html b/javadoc/4.8/functionaljava/fj/function/BigIntegers.html new file mode 100644 index 0000000..e20850c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/BigIntegers.html @@ -0,0 +1,402 @@ + + + + + +BigIntegers (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class BigIntegers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.BigIntegers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BigIntegers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.math.BigInteger,java.math.BigInteger>abs +
      Absolute value.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>add +
      Curried Integer addition.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>multiply +
      Curried Integer multiplication.
      +
      static F<java.math.BigInteger,java.math.BigInteger>negate +
      Negation.
      +
      static F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>>power +
      Power.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>remainder +
      Remainder.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.math.BigIntegerproduct(List<java.math.BigInteger> ints) +
      Returns the product of a list of big integers.
      +
      static java.math.BigIntegersum(List<java.math.BigInteger> ints) +
      Sums a list of big integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>> power
        +
        Power.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static java.math.BigInteger sum(List<java.math.BigInteger> ints)
        +
        Sums a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to sum.
        +
        Returns:
        +
        The sum of the big integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static java.math.BigInteger product(List<java.math.BigInteger> ints)
        +
        Returns the product of a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to multiply together.
        +
        Returns:
        +
        The product of the big integers in the list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Booleans.html b/javadoc/4.8/functionaljava/fj/function/Booleans.html new file mode 100644 index 0000000..4a3411f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Booleans.html @@ -0,0 +1,775 @@ + + + + + +Booleans (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Booleans

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Booleans
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Booleans
+extends java.lang.Object
    +
    Curried logical functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>and +
      Curried form of logical "and" (conjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>if_ +
      Curried form of logical "if" (reverse material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>iff +
      Curried form of logical "if and only if" (biconditional, equivalence).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>implies +
      Curried form of logical "only if" (material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nif +
      Curried form of logical "not if" (reverse nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nimp +
      Curried form of logical "not implies" (nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nor +
      Curried form of logical "not or".
      +
      static F<java.lang.Boolean,java.lang.Boolean>not +
      Logical negation.
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>or +
      Curried form of logical "inclusive or" (disjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>xor +
      Curried form of logical xor (nonequivalence).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<A,java.lang.Boolean>and(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using conjunction
      +
      static booleanand(List<java.lang.Boolean> l) +
      Returns true if all the elements of the given list are true.
      +
      static booleanand(Stream<java.lang.Boolean> l) +
      Returns true if all the elements of the given stream are true.
      +
      static <A> F<A,java.lang.Boolean>andAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>andAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns composed predicate
      +
      static <A> F<java.lang.Boolean,F<A,F<A,A>>>cond() +
      Curried form of conditional.
      +
      static <A,B> F<B,java.lang.Boolean>contramap(F<B,A> f, + F<A,java.lang.Boolean> p) +
      maps given function to the predicate function
      +
      static <A,B> F<B,java.lang.Boolean>is(F<B,A> f, + F<A,java.lang.Boolean> p) +
      alias for contramap
      +
      static <A,B> F<B,java.lang.Boolean>isnot(F<B,A> f, + F<A,java.lang.Boolean> p) +
      returns inverse of contramap
      +
      static <A> F<A,java.lang.Boolean>not(F<A,java.lang.Boolean> p) +
      Negates the given predicate.
      +
      static <A> F<A,java.lang.Boolean>or(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      returns composed predicate using disjunction
      +
      static booleanor(List<java.lang.Boolean> l) +
      Returns true if any element of the given list is true.
      +
      static booleanor(Stream<java.lang.Boolean> l) +
      Returns true if any element of the given stream is true.
      +
      static <A> F<A,java.lang.Boolean>orAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>orAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given Stream of predicates
      +
      static <A> F<A,java.lang.Boolean>xor(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using exclusive disjunction
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        or

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> or
        +
        Curried form of logical "inclusive or" (disjunction).
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> and
        +
        Curried form of logical "and" (conjunction).
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> xor
        +
        Curried form of logical xor (nonequivalence).
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static final F<java.lang.Boolean,java.lang.Boolean> not
        +
        Logical negation.
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> implies
        +
        Curried form of logical "only if" (material implication).
        +
        • +
      + + + +
        +
      • +

        if_

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> if_
        +
        Curried form of logical "if" (reverse material implication).
        +
        • +
      + + + +
        +
      • +

        iff

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> iff
        +
        Curried form of logical "if and only if" (biconditional, equivalence).
        +
        • +
      + + + +
        +
      • +

        nimp

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nimp
        +
        Curried form of logical "not implies" (nonimplication).
        +
        • +
      + + + +
        +
      • +

        nif

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nif
        +
        Curried form of logical "not if" (reverse nonimplication).
        +
        • +
      + + + +
        +
      • +

        nor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nor
        +
        Curried form of logical "not or".
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public static boolean and(List<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given list are true.
        +
        +
        Parameters:
        +
        l - A list to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given list are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> F<B,java.lang.Boolean> contramap(F<B,A> f,
+                                                     F<A,java.lang.Boolean> p)
        +
        maps given function to the predicate function
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        is

        +
        public static <A,B> F<B,java.lang.Boolean> is(F<B,A> f,
+                                              F<A,java.lang.Boolean> p)
        +
        alias for contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        isnot

        +
        public static <A,B> F<B,java.lang.Boolean> isnot(F<B,A> f,
+                                                 F<A,java.lang.Boolean> p)
        +
        returns inverse of contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static <A> F<A,java.lang.Boolean> and(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using conjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static <A> F<A,java.lang.Boolean> xor(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using exclusive disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static <A> F<A,java.lang.Boolean> or(F<A,java.lang.Boolean> p1,
+                                            F<A,java.lang.Boolean> p2)
        +
        returns composed predicate using disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static boolean and(Stream<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given stream are true.
        +
        +
        Parameters:
        +
        l - A stream to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given stream are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns composed predicate
        +
        +
        Parameters:
        +
        l - A stream of predicates
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given Stream of predicates
        +
        +
        Parameters:
        +
        l - A stream of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(List<java.lang.Boolean> l)
        +
        Returns true if any element of the given list is true.
        +
        +
        Parameters:
        +
        l - A list to check for any element being true.
        +
        Returns:
        +
        true if any element of the given list is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(Stream<java.lang.Boolean> l)
        +
        Returns true if any element of the given stream is true.
        +
        +
        Parameters:
        +
        l - A stream to check for any element being true.
        +
        Returns:
        +
        true if any element of the given stream is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static <A> F<A,java.lang.Boolean> not(F<A,java.lang.Boolean> p)
        +
        Negates the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to negate.
        +
        Returns:
        +
        The negation of the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        cond

        +
        public static <A> F<java.lang.Boolean,F<A,F<A,A>>> cond()
        +
        Curried form of conditional. If the first argument is true, returns the second argument, + otherwise the third argument.
        +
        +
        Returns:
        +
        A function that returns its second argument if the first argument is true, otherwise the third argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Characters.html b/javadoc/4.8/functionaljava/fj/function/Characters.html new file mode 100644 index 0000000..467bc06 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Characters.html @@ -0,0 +1,563 @@ + + + + + +Characters (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Characters

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Characters
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Characters
+extends java.lang.Object
    +
    First-class functions on Characters.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>>digit 
      static F<java.lang.Character,java.lang.Byte>getDirectionality 
      static F<java.lang.Character,java.lang.Integer>getNumericValue 
      static F<java.lang.Character,java.lang.Integer>getType 
      static F<java.lang.Character,java.lang.Boolean>isDefined 
      static F<java.lang.Character,java.lang.Boolean>isDigit 
      static F<java.lang.Character,java.lang.Boolean>isIdentifierIgnorable 
      static F<java.lang.Character,java.lang.Boolean>isISOControl 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isLetter 
      static F<java.lang.Character,java.lang.Boolean>isLetterOrDigit 
      static F<java.lang.Character,java.lang.Boolean>isLowerCase 
      static F<java.lang.Character,java.lang.Boolean>isMirrored 
      static F<java.lang.Character,java.lang.Boolean>isNewLine 
      static F<java.lang.Character,java.lang.Boolean>isSpaceChar 
      static F<java.lang.Character,java.lang.Boolean>isTitleCase 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isUpperCase 
      static F<java.lang.Character,java.lang.Boolean>isWhitespace 
      static F<java.lang.Character,java.lang.Character>reverseBytes 
      static F<java.lang.Character,java.lang.Character>toLowerCase 
      static F<java.lang.Character,java.lang.String>toString 
      static F<java.lang.Character,java.lang.Character>toTitleCase 
      static F<java.lang.Character,java.lang.Character>toUpperCase 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        toString

        +
        public static final F<java.lang.Character,java.lang.String> toString
        +
        • +
      + + + +
        +
      • +

        isLowerCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLowerCase
        +
        • +
      + + + +
        +
      • +

        isUpperCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUpperCase
        +
        • +
      + + + +
        +
      • +

        isTitleCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isTitleCase
        +
        • +
      + + + +
        +
      • +

        isDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDigit
        +
        • +
      + + + +
        +
      • +

        isDefined

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDefined
        +
        • +
      + + + +
        +
      • +

        isLetter

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetter
        +
        • +
      + + + +
        +
      • +

        isLetterOrDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetterOrDigit
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isIdentifierIgnorable

        +
        public static final F<java.lang.Character,java.lang.Boolean> isIdentifierIgnorable
        +
        • +
      + + + +
        +
      • +

        toLowerCase

        +
        public static final F<java.lang.Character,java.lang.Character> toLowerCase
        +
        • +
      + + + +
        +
      • +

        toUpperCase

        +
        public static final F<java.lang.Character,java.lang.Character> toUpperCase
        +
        • +
      + + + +
        +
      • +

        toTitleCase

        +
        public static final F<java.lang.Character,java.lang.Character> toTitleCase
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static final F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>> digit
        +
        • +
      + + + +
        +
      • +

        getNumericValue

        +
        public static final F<java.lang.Character,java.lang.Integer> getNumericValue
        +
        • +
      + + + +
        +
      • +

        isSpaceChar

        +
        public static final F<java.lang.Character,java.lang.Boolean> isSpaceChar
        +
        • +
      + + + +
        +
      • +

        isWhitespace

        +
        public static final F<java.lang.Character,java.lang.Boolean> isWhitespace
        +
        • +
      + + + +
        +
      • +

        isISOControl

        +
        public static final F<java.lang.Character,java.lang.Boolean> isISOControl
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public static final F<java.lang.Character,java.lang.Integer> getType
        +
        • +
      + + + +
        +
      • +

        getDirectionality

        +
        public static final F<java.lang.Character,java.lang.Byte> getDirectionality
        +
        • +
      + + + +
        +
      • +

        isMirrored

        +
        public static final F<java.lang.Character,java.lang.Boolean> isMirrored
        +
        • +
      + + + +
        +
      • +

        reverseBytes

        +
        public static final F<java.lang.Character,java.lang.Character> reverseBytes
        +
        • +
      + + + +
        +
      • +

        isNewLine

        +
        public static final F<java.lang.Character,java.lang.Boolean> isNewLine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Doubles.html b/javadoc/4.8/functionaljava/fj/function/Doubles.html new file mode 100644 index 0000000..58aca47 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Doubles.html @@ -0,0 +1,502 @@ + + + + + +Doubles (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Doubles

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Doubles
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Doubles
+extends java.lang.Object
    +
    Curried functions over Doubles.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Double,java.lang.Double>abs +
      Absolute value.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>add +
      Curried Double addition.
      +
      static F<java.lang.Double,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Double,java.lang.Boolean>gteZero +
      A function that returns true if the given double is greater than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>gtZero +
      A function that returns true if the given double is greater than zero.
      +
      static F<java.lang.Double,java.lang.Boolean>lteZero +
      A function that returns true if the given double is less than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>ltZero +
      A function that returns true if the given double is less than zero.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>multiply +
      Curried Double multiplication.
      +
      static F<java.lang.Double,java.lang.Double>negate +
      Negation.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>power +
      Power.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>remainder +
      Remainder.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>subtract +
      Curried Double subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Double>>fromString() +
      A function that converts strings to doubles.
      +
      static doubleproduct(List<java.lang.Double> doubles) +
      Returns the product of a list of doubles.
      +
      static doublesum(List<java.lang.Double> doubles) +
      Sums a list of doubles.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> add
        +
        Curried Double addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> multiply
        +
        Curried Double multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> subtract
        +
        Curried Double subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Double,java.lang.Double> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Double,java.lang.Double> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Double,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gtZero
        +
        A function that returns true if the given double is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gteZero
        +
        A function that returns true if the given double is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> ltZero
        +
        A function that returns true if the given double is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> lteZero
        +
        A function that returns true if the given double is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static double sum(List<java.lang.Double> doubles)
        +
        Sums a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to sum.
        +
        Returns:
        +
        The sum of the doubless in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static double product(List<java.lang.Double> doubles)
        +
        Returns the product of a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to multiply together.
        +
        Returns:
        +
        The product of the doubles in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Double>> fromString()
        +
        A function that converts strings to doubles.
        +
        +
        Returns:
        +
        A function that converts strings to doubles.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect0.html b/javadoc/4.8/functionaljava/fj/function/Effect0.html new file mode 100644 index 0000000..0dbd7d0 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect0.html @@ -0,0 +1,220 @@ + + + + + +Effect0 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect0

+
+
+
+
    +
  • +
    +
    +
    public interface Effect0
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect1.html b/javadoc/4.8/functionaljava/fj/function/Effect1.html new file mode 100644 index 0000000..02d0e3a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect1.html @@ -0,0 +1,222 @@ + + + + + +Effect1 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect1<A>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect1<A>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect2.html b/javadoc/4.8/functionaljava/fj/function/Effect2.html new file mode 100644 index 0000000..568dc61 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect2.html @@ -0,0 +1,224 @@ + + + + + +Effect2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect2<A,B>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect2<A,B>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect3.html b/javadoc/4.8/functionaljava/fj/function/Effect3.html new file mode 100644 index 0000000..a8d7f08 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect3.html @@ -0,0 +1,226 @@ + + + + + +Effect3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect3<A,B,C>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect3<A,B,C>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect4.html b/javadoc/4.8/functionaljava/fj/function/Effect4.html new file mode 100644 index 0000000..ca80266 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect4.html @@ -0,0 +1,228 @@ + + + + + +Effect4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect4<A,B,C,D>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect4<A,B,C,D>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect5.html b/javadoc/4.8/functionaljava/fj/function/Effect5.html new file mode 100644 index 0000000..f651746 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect5.html @@ -0,0 +1,230 @@ + + + + + +Effect5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect5<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect5<A,B,C,D,E>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect6.html b/javadoc/4.8/functionaljava/fj/function/Effect6.html new file mode 100644 index 0000000..128c873 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect6.html @@ -0,0 +1,232 @@ + + + + + +Effect6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect6<A,B,C,D,E,F>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect6<A,B,C,D,E,F>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect7.html b/javadoc/4.8/functionaljava/fj/function/Effect7.html new file mode 100644 index 0000000..4ca4bb5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect7.html @@ -0,0 +1,234 @@ + + + + + +Effect7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect7<A,B,C,D,E,F,G>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect7<A,B,C,D,E,F,G>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Effect8.html b/javadoc/4.8/functionaljava/fj/function/Effect8.html new file mode 100644 index 0000000..4f1c8b0 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Effect8.html @@ -0,0 +1,236 @@ + + + + + +Effect8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect8<A,B,C,D,E,F,G,H>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect8<A,B,C,D,E,F,G,H>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Integers.html b/javadoc/4.8/functionaljava/fj/function/Integers.html new file mode 100644 index 0000000..2962e80 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Integers.html @@ -0,0 +1,502 @@ + + + + + +Integers (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Integers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Integers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Integers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Integer,java.lang.Integer>abs +
      Absolute value.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>add +
      Curried Integer addition.
      +
      static F<java.lang.Integer,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Integer,java.lang.Boolean>gteZero +
      A function that returns true if the given integer is greater than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>gtZero +
      A function that returns true if the given integer is greater than zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>lteZero +
      A function that returns true if the given integer is less than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>ltZero +
      A function that returns true if the given integer is less than zero.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>multiply +
      Curried Integer multiplication.
      +
      static F<java.lang.Integer,java.lang.Integer>negate +
      Negation.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>power +
      Power.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>remainder +
      Remainder.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Integer>>fromString() +
      A function that converts strings to integers.
      +
      static intproduct(List<java.lang.Integer> ints) +
      Returns the product of a list of integers.
      +
      static intsum(List<java.lang.Integer> ints) +
      Sums a list of integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Integer,java.lang.Integer> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Integer,java.lang.Integer> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Integer,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gtZero
        +
        A function that returns true if the given integer is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gteZero
        +
        A function that returns true if the given integer is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> ltZero
        +
        A function that returns true if the given integer is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> lteZero
        +
        A function that returns true if the given integer is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static int sum(List<java.lang.Integer> ints)
        +
        Sums a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to sum.
        +
        Returns:
        +
        The sum of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static int product(List<java.lang.Integer> ints)
        +
        Returns the product of a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to multiply together.
        +
        Returns:
        +
        The product of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Integer>> fromString()
        +
        A function that converts strings to integers.
        +
        +
        Returns:
        +
        A function that converts strings to integers.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Longs.html b/javadoc/4.8/functionaljava/fj/function/Longs.html new file mode 100644 index 0000000..a897d76 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Longs.html @@ -0,0 +1,321 @@ + + + + + +Longs (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Longs

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Longs
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Longs
+extends java.lang.Object
    +
    Curried functions over Longs.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Long,java.lang.Long>abs +
      Absolute value.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>add +
      Curried Long addition.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>multiply +
      Curried Long multiplication.
      +
      static F<java.lang.Long,java.lang.Long>negate +
      Negation.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>remainder +
      Remainder.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>subtract +
      Curried Long subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> add
        +
        Curried Long addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> multiply
        +
        Curried Long multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> subtract
        +
        Curried Long subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Long,java.lang.Long> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Long,java.lang.Long> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> remainder
        +
        Remainder.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Strings.html b/javadoc/4.8/functionaljava/fj/function/Strings.html new file mode 100644 index 0000000..d0e7bf6 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Strings.html @@ -0,0 +1,467 @@ + + + + + +Strings (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Strings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Strings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strings
+extends java.lang.Object
    +
    Curried string functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>contains +
      A curried version of String.contains(CharSequence).
      +
      static F<java.lang.String,java.lang.Boolean>isEmpty +
      A curried version of String.isEmpty().
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrBlank +
      This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrEmpty +
      This function checks if a given String is neither null nor empty.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrBlank +
      This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrEmpty +
      This function checks if a given String is null or empty (String.isEmpty()).
      +
      static F<java.lang.String,java.lang.Integer>length +
      A curried version of String.length().
      +
      static java.lang.StringlineSeparator 
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>matches +
      A curried version of String.matches(String).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,List<java.lang.String>>lines() 
      static List<java.lang.String>lines(java.lang.String s) 
      static F<List<java.lang.String>,java.lang.String>unlines() 
      static java.lang.Stringunlines(List<java.lang.String> list) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        lineSeparator

        +
        public static final java.lang.String lineSeparator
        +
        • +
      + + + +
        +
      • +

        isNotNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrEmpty
        +
        This function checks if a given String is neither null nor empty.
        +
        +
        See Also:
        +
        isNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrEmpty
        +
        This function checks if a given String is null or empty (String.isEmpty()).
        +
        +
        See Also:
        +
        isNotNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNotNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrBlank
        +
        This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
        +
        +
        See Also:
        +
        isNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrBlank
        +
        This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
        +
        +
        See Also:
        +
        isNotNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isEmpty
        +
        A curried version of String.isEmpty().
        +
        • +
      + + + +
        +
      • +

        length

        +
        public static final F<java.lang.String,java.lang.Integer> length
        +
        A curried version of String.length().
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> contains
        +
        A curried version of String.contains(CharSequence). + The function returns true if the second argument contains the first.
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> matches
        +
        A curried version of String.matches(String). + The function returns true if the second argument matches the first.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lines

        +
        public static List<java.lang.String> lines(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public static F<java.lang.String,List<java.lang.String>> lines()
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static java.lang.String unlines(List<java.lang.String> list)
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static F<List<java.lang.String>,java.lang.String> unlines()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try0.html b/javadoc/4.8/functionaljava/fj/function/Try0.html new file mode 100644 index 0000000..642d84c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try0.html @@ -0,0 +1,231 @@ + + + + + +Try0 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try0<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try0<A,Z extends java.lang.Exception>
    +
    A product of A which may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to a P1.
    +
    +
    See Also:
    +
    Try.f(Try0)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try1.html b/javadoc/4.8/functionaljava/fj/function/Try1.html new file mode 100644 index 0000000..1c5ff98 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try1.html @@ -0,0 +1,233 @@ + + + + + +Try1 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try1<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try1<A,B,Z extends java.lang.Exception>
    +
    A transformation function from A to B that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F.
    +
    +
    See Also:
    +
    Try.f(Try1)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try2.html b/javadoc/4.8/functionaljava/fj/function/Try2.html new file mode 100644 index 0000000..8aca058 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try2.html @@ -0,0 +1,235 @@ + + + + + +Try2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try2<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try2<A,B,C,Z extends java.lang.Exception>
    +
    A transformation function of arity-2 from A and B to C that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F2.
    +
    +
    See Also:
    +
    Try.f(Try2)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try3.html b/javadoc/4.8/functionaljava/fj/function/Try3.html new file mode 100644 index 0000000..599c7f4 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try3.html @@ -0,0 +1,237 @@ + + + + + +Try3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try3<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try3<A,B,C,D,Z extends java.lang.Exception>
    +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F3.
    +
    +
    See Also:
    +
    Try.f(Try3)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try4.html b/javadoc/4.8/functionaljava/fj/function/Try4.html new file mode 100644 index 0000000..a5e78d5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try4.html @@ -0,0 +1,239 @@ + + + + + +Try4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try4<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try4<A,B,C,D,E,Z extends java.lang.Exception>
    +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F4.
    +
    +
    See Also:
    +
    Try.f(Try4)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try5.html b/javadoc/4.8/functionaljava/fj/function/Try5.html new file mode 100644 index 0000000..2fd845d --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try5.html @@ -0,0 +1,241 @@ + + + + + +Try5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F5.
    +
    +
    See Also:
    +
    Try.f(Try5)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F f(A a,
+    B b,
+    C c,
+    D d,
+    E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try6.html b/javadoc/4.8/functionaljava/fj/function/Try6.html new file mode 100644 index 0000000..75fe417 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try6.html @@ -0,0 +1,243 @@ + + + + + +Try6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F6.
    +
    +
    See Also:
    +
    Try.f(Try6)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try7.html b/javadoc/4.8/functionaljava/fj/function/Try7.html new file mode 100644 index 0000000..c1e92c5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try7.html @@ -0,0 +1,245 @@ + + + + + +Try7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F7.
    +
    +
    See Also:
    +
    Try.f(Try7)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Try8.html b/javadoc/4.8/functionaljava/fj/function/Try8.html new file mode 100644 index 0000000..672f4db --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Try8.html @@ -0,0 +1,247 @@ + + + + + +Try8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
    +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F8.
    +
    +
    See Also:
    +
    Try.f(Try8)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g,
+    H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect0.html b/javadoc/4.8/functionaljava/fj/function/TryEffect0.html new file mode 100644 index 0000000..b5d5ec9 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect0.html @@ -0,0 +1,225 @@ + + + + + +TryEffect0 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect0<Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect0<Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect1.html b/javadoc/4.8/functionaljava/fj/function/TryEffect1.html new file mode 100644 index 0000000..c7f397a --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect1.html @@ -0,0 +1,227 @@ + + + + + +TryEffect1 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect1<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect1<A,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect2.html b/javadoc/4.8/functionaljava/fj/function/TryEffect2.html new file mode 100644 index 0000000..7842ae0 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect2.html @@ -0,0 +1,229 @@ + + + + + +TryEffect2 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect2<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect2<A,B,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect3.html b/javadoc/4.8/functionaljava/fj/function/TryEffect3.html new file mode 100644 index 0000000..72aa1b5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect3.html @@ -0,0 +1,231 @@ + + + + + +TryEffect3 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect3<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect3<A,B,C,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect4.html b/javadoc/4.8/functionaljava/fj/function/TryEffect4.html new file mode 100644 index 0000000..36a707f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect4.html @@ -0,0 +1,233 @@ + + + + + +TryEffect4 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect5.html b/javadoc/4.8/functionaljava/fj/function/TryEffect5.html new file mode 100644 index 0000000..e9701dd --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect5.html @@ -0,0 +1,235 @@ + + + + + +TryEffect5 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect6.html b/javadoc/4.8/functionaljava/fj/function/TryEffect6.html new file mode 100644 index 0000000..54ad860 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect6.html @@ -0,0 +1,237 @@ + + + + + +TryEffect6 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect7.html b/javadoc/4.8/functionaljava/fj/function/TryEffect7.html new file mode 100644 index 0000000..22fa1b7 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect7.html @@ -0,0 +1,239 @@ + + + + + +TryEffect7 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/TryEffect8.html b/javadoc/4.8/functionaljava/fj/function/TryEffect8.html new file mode 100644 index 0000000..fe339d5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/TryEffect8.html @@ -0,0 +1,241 @@ + + + + + +TryEffect8 (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/Visitor.html b/javadoc/4.8/functionaljava/fj/function/Visitor.html new file mode 100644 index 0000000..5d2d2a5 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/Visitor.html @@ -0,0 +1,393 @@ + + + + + +Visitor (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Visitor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Visitor
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Visitor
+extends java.lang.Object
    +
    The essence of the visitor design pattern expressed polymorphically.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<B,F<A,B>>association(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <A,B> F<P1<B>,F<A,B>>associationLazy(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <X> XfindFirst(List<Option<X>> values, + F0<X> def) +
      Returns the first value available in the given list of optional values.
      +
      static <X> XnullablefindFirst(List<X> values, + F0<X> def) +
      Returns the first non-null value in the given list of optional values.
      +
      static <A,B> BnullableVisitor(List<F<A,B>> visitors, + F0<B> def, + A value) +
      Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
      +
      static <A,B> Bvisitor(List<F<A,Option<B>>> visitors, + F0<B> def, + A value) +
      Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        findFirst

        +
        public static <X> X findFirst(List<Option<X>> values,
+                              F0<X> def)
        +
        Returns the first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The optional values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + +
        +
      • +

        nullablefindFirst

        +
        public static <X> X nullablefindFirst(List<X> values,
+                                      F0<X> def)
        +
        Returns the first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The potentially null values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + + + +
        +
      • +

        visitor

        +
        public static <A,B> B visitor(List<F<A,Option<B>>> visitors,
+                              F0<B> def,
+                              A value)
        +
        Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply.
        +
        def - The default if none of the visitors yield a value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + + + +
        +
      • +

        nullableVisitor

        +
        public static <A,B> B nullableVisitor(List<F<A,B>> visitors,
+                                      F0<B> def,
+                                      A value)
        +
        Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply looking for a non-null.
        +
        def - The default if none of the visitors yield a non-null value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + +
        +
      • +

        association

        +
        public static <A,B> F<B,F<A,B>> association(List<P2<A,B>> x,
+                                            Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      + + + +
        +
      • +

        associationLazy

        +
        public static <A,B> F<P1<B>,F<A,B>> associationLazy(List<P2<A,B>> x,
+                                                    Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/package-frame.html b/javadoc/4.8/functionaljava/fj/function/package-frame.html new file mode 100644 index 0000000..d6dbd3f --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/package-frame.html @@ -0,0 +1,57 @@ + + + + + +fj.function (core 4.8 API) + + + + + +

fj.function

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/function/package-summary.html b/javadoc/4.8/functionaljava/fj/function/package-summary.html new file mode 100644 index 0000000..a2688cf --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/package-summary.html @@ -0,0 +1,366 @@ + + + + + +fj.function (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.function

+
+
A prelude of commonly used first-class functions
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Effect0 +
    Created by mperry on 28/08/2014.
    +
    Effect1<A> +
    Created by mperry on 28/08/2014.
    +
    Effect2<A,B> +
    Created by mperry on 28/08/2014.
    +
    Effect3<A,B,C> +
    Created by mperry on 28/08/2014.
    +
    Effect4<A,B,C,D> +
    Created by mperry on 28/08/2014.
    +
    Effect5<A,B,C,D,E> +
    Created by mperry on 28/08/2014.
    +
    Effect6<A,B,C,D,E,F> +
    Created by mperry on 28/08/2014.
    +
    Effect7<A,B,C,D,E,F,G> +
    Created by mperry on 28/08/2014.
    +
    Effect8<A,B,C,D,E,F,G,H> +
    Created by mperry on 28/08/2014.
    +
    Try0<A,Z extends java.lang.Exception> +
    A product of A which may throw an Exception.
    +
    Try1<A,B,Z extends java.lang.Exception> +
    A transformation function from A to B that may throw an Exception.
    +
    Try2<A,B,C,Z extends java.lang.Exception> +
    A transformation function of arity-2 from A and B to C that may throw an Exception.
    +
    Try3<A,B,C,D,Z extends java.lang.Exception> +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception.
    +
    Try4<A,B,C,D,E,Z extends java.lang.Exception> +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
    +
    Try5<A,B,C,D,E,F,Z extends java.lang.Exception> +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
    +
    Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
    +
    Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
    +
    Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
    +
    TryEffect0<Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect1<A,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect2<A,B,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect3<A,B,C,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect4<A,B,C,D,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BigIntegers +
    Curried functions over Integers.
    +
    Booleans +
    Curried logical functions.
    +
    Characters +
    First-class functions on Characters.
    +
    Doubles +
    Curried functions over Doubles.
    +
    Integers +
    Curried functions over Integers.
    +
    Longs +
    Curried functions over Longs.
    +
    Strings +
    Curried string functions.
    +
    Visitor +
    The essence of the visitor design pattern expressed polymorphically.
    +
    +
    • +
+ + + +

Package fj.function Description

+
A prelude of commonly used first-class functions
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/function/package-tree.html b/javadoc/4.8/functionaljava/fj/function/package-tree.html new file mode 100644 index 0000000..c718623 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/function/package-tree.html @@ -0,0 +1,172 @@ + + + + + +fj.function Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.function

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/package-frame.html b/javadoc/4.8/functionaljava/fj/package-frame.html new file mode 100644 index 0000000..3392ce3 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/package-frame.html @@ -0,0 +1,89 @@ + + + + + +fj (core 4.8 API) + + + + + +

fj

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/package-summary.html b/javadoc/4.8/functionaljava/fj/package-summary.html new file mode 100644 index 0000000..f835465 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/package-summary.html @@ -0,0 +1,555 @@ + + + + + +fj (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj

+
+
Types that set the premise for the existence of Functional Java.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Equal.AltDefinition<A> +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    Equal.Definition<A> +
    Primitives functions of Equal: minimal definition and overridable methods.
    +
    F<A,B> +
    A transformation or function from A to B.
    +
    F0<A> +
    Created by MarkPerry on 21/01/2015.
    +
    F2<A,B,C> +
    A transformation function of arity-2 from A and B to C.
    +
    F3<A,B,C,D> +
    A transformation function of arity-3 from A, B and C to + D.
    +
    F4<A,B,C,D,E> +
    A transformation function of arity-4 from A, B, C and + D to E.
    +
    F5<A,B,C,D,E,F$> +
    A transformation function of arity-5 from A, B, C, + D and E to F$.
    +
    F6<A,B,C,D,E,F$,G> +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
    +
    F7<A,B,C,D,E,F$,G,H> +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
    +
    F8<A,B,C,D,E,F$,G,H,I> +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
    +
    Monoid.AltDefinition<A> +
    Primitives functions of Monoid: alternative minimal definition and overridable methods.
    +
    Monoid.Definition<A> +
    Primitives functions of Monoid: minimal definition and overridable methods.
    +
    Ord.AltDefinition<A> +
    Primitives functions of Ord: alternative minimal definition and overridable methods.
    +
    Ord.Definition<A> +
    Primitives functions of Ord: minimal definition and overridable methods.
    +
    Semigroup.AltDefinition<A> +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    Semigroup.Definition<A> +
    Primitives functions of Semigroup: minimal definition and overridable methods.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Bottom +
    Represents the bottom _|_ value.
    +
    Class<T> +
    A wrapper for a Class that provides additional methods.
    +
    Effect +
    Represents a side-effect.
    +
    Equal<A> +
    Tests for equality between two objects.
    +
    F1Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F1W<A,B> +
    Created by MarkPerry on 22/01/2015.
    +
    F1W.F1WFunc<A,B> 
    F2Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F2W<A,B,C> +
    Created by MarkPerry on 22/01/2015.
    +
    F2W.F2WFunc<A,B,C> 
    F3Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F3W<A,B,C,D> +
    Created by MarkPerry on 22/01/2015.
    +
    F4Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F4W<A,B,C,D,E> +
    Created by MarkPerry on 22/01/2015.
    +
    F5Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F5W<A,B,C,D,E,$F> +
    Created by MarkPerry on 22/01/2015.
    +
    F6Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F6W<A,B,C,D,E,$F,G> +
    Created by MarkPerry on 22/01/2015.
    +
    F7Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F7W<A,B,C,D,E,$F,G,H> +
    Created by MarkPerry on 22/01/2015.
    +
    F8Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F8W<A,B,C,D,E,$F,G,H,I> +
    Created by MarkPerry on 22/01/2015.
    +
    Function +
    Transformations on functions.
    +
    Hash<A> +
    Produces a hash code for an object which should attempt uniqueness.
    +
    LcgRng +
    Created by MarkPerry on 7/07/2014.
    +
    Monoid<A> +
    A monoid abstraction to be defined across types of the given type argument.
    +
    Ord<A> +
    Tests for ordering between two objects.
    +
    P +
    Functions across products.
    +
    P1<A> 
    P2<A,B> +
    A product-2.
    +
    P2.Optic +
    Optic factory methods for a P2
    +
    P3<A,B,C> +
    A product-3.
    +
    P4<A,B,C,D> +
    A product-4.
    +
    P5<A,B,C,D,E> +
    A product-5.
    +
    P6<A,B,C,D,E,F> +
    A product-6.
    +
    P7<A,B,C,D,E,F,G> +
    A product-7.
    +
    P8<A,B,C,D,E,F,G,H> +
    A product-8.
    +
    Primitive +
    Functions that convert between Java primitive types.
    +
    Rng +
    Created by MarkPerry on 7/07/2014.
    +
    Semigroup<A> +
    Implementations must satisfy the law of associativity: + + Associativity; forall x.
    +
    Show<A> +
    Renders an object for display.
    +
    Try +
    Created by mperry on 24/07/2014.
    +
    TryEffect +
    Created by mperry on 29/08/2014.
    +
    Unit +
    The unit type which has only one value.
    +
    Void +
    A logically uninhabited data type.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    Digit +
    The digits zero to nine.
    +
    Ordering +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    +
    • +
+ + + +

Package fj Description

+
Types that set the premise for the existence of Functional Java.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/package-tree.html b/javadoc/4.8/functionaljava/fj/package-tree.html new file mode 100644 index 0000000..b722f5b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/package-tree.html @@ -0,0 +1,238 @@ + + + + + +fj Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/Parser.CharsParser.html b/javadoc/4.8/functionaljava/fj/parser/Parser.CharsParser.html new file mode 100644 index 0000000..080a593 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/Parser.CharsParser.html @@ -0,0 +1,1503 @@ + + + + + +Parser.CharsParser (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.CharsParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.CharsParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.CharsParser
+extends java.lang.Object
    +
    Parsers that accept Stream<Character> input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(E missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(F0<E> missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(F0<E> missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(E missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(F0<E> missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(E missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(F0<E> missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(E missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(F0<E> missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(E missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(E missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(F0<E> missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(E missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(E missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(F0<E> missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(E missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(F0<E> missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(E missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/Parser.StreamParser.html b/javadoc/4.8/functionaljava/fj/parser/Parser.StreamParser.html new file mode 100644 index 0000000..7993a7b --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/Parser.StreamParser.html @@ -0,0 +1,331 @@ + + + + + +Parser.StreamParser (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.StreamParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.StreamParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.StreamParser
+extends java.lang.Object
    +
    Parsers that accept Stream input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <I,E> Parser<Stream<I>,I,E>element(E e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>element(F0<E> e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(E missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(F0<E> missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(F0<E> e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(E e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(F0<E> missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      + + + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(E missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/Parser.html b/javadoc/4.8/functionaljava/fj/parser/Parser.html new file mode 100644 index 0000000..2b5e01c --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/Parser.html @@ -0,0 +1,949 @@ + + + + + +Parser (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser<I,A,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser<I,A,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Parser<I,A,E>
+extends java.lang.Object
    +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        parse

        +
        public Validation<E,Result<I,A>> parse(I i)
        +
        Parses the input to produce a result or error.
        +
        +
        Parameters:
        +
        i - The input to parse.
        +
        Returns:
        +
        A parse result with the remaining input or an error.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <Z> Parser<Z,A,E> xmap(F<I,Z> f,
+                              F<Z,I> g)
        +
        Maps the parse input type through an invariant functor.
        +
        +
        Parameters:
        +
        f - The function to covariant map.
        +
        g - The function to contra-variant map.
        +
        Returns:
        +
        A parser with the new input type.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Parser<I,B,E> map(F<A,B> f)
        +
        Maps the given result type across this parser.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A parser with the new result type.
        +
        +
        • +
      + + + + + +
        +
      • +

        filter

        +
        public Parser<I,A,E> filter(F<A,java.lang.Boolean> f,
+                            E e)
        +
        Returns a parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to filter on.
        +
        e - The error to in the event that the predicate is not met.
        +
        Returns:
        +
        A parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Parser<I,B,E> bind(F<A,Parser<I,B,E>> f)
        +
        Binds the given function across the parser with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this parser.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Parser<I,C,E> bind(Parser<I,B,E> pb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Parser<I,D,E> bind(Parser<I,B,E> pb,
+                                  Parser<I,C,E> pc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$> Parser<I,E$,E> bind(Parser<I,B,E> pb,
+                                      Parser<I,C,E> pc,
+                                      Parser<I,D,E> pd,
+                                      F<A,F<B,F<C,F<D,E$>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$> Parser<I,F$,E> bind(Parser<I,B,E> pb,
+                                         Parser<I,C,E> pc,
+                                         Parser<I,D,E> pd,
+                                         Parser<I,E$,E> pe,
+                                         F<A,F<B,F<C,F<D,F<E$,F$>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G> Parser<I,G,E> bind(Parser<I,B,E> pb,
+                                          Parser<I,C,E> pc,
+                                          Parser<I,D,E> pd,
+                                          Parser<I,E$,E> pe,
+                                          Parser<I,F$,E> pf,
+                                          F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H> Parser<I,H,E> bind(Parser<I,B,E> pb,
+                                            Parser<I,C,E> pc,
+                                            Parser<I,D,E> pd,
+                                            Parser<I,E$,E> pe,
+                                            Parser<I,F$,E> pf,
+                                            Parser<I,G,E> pg,
+                                            F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H,I$> Parser<I,I$,E> bind(Parser<I,B,E> pb,
+                                                Parser<I,C,E> pc,
+                                                Parser<I,D,E> pd,
+                                                Parser<I,E$,E> pe,
+                                                Parser<I,F$,E> pf,
+                                                Parser<I,G,E> pg,
+                                                Parser<I,H,E> ph,
+                                                F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,F<H,I$>>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        ph - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Parser<I,B,E> sequence(Parser<I,B,E> p)
        +
        Binds anonymously, ignoring the result value.
        +
        +
        Parameters:
        +
        p - The parser to bind with.
        +
        Returns:
        +
        A parser after binding anonymously.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Parser<I,B,E> apply(Parser<I,F<A,B>,E> p)
        +
        Performs function application within a parser.
        +
        +
        Parameters:
        +
        p - The parser returning a function value.
        +
        Returns:
        +
        A new parser after function application.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(F0<E> e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(E e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + +
        +
      • +

        repeat

        +
        public Parser<I,Stream<A>,E> repeat()
        +
        Returns a parser that repeats application of this parser zero or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser zero or many times.
        +
        +
        • +
      + + + +
        +
      • +

        repeat1

        +
        public Parser<I,Stream<A>,E> repeat1()
        +
        Returns a parser that repeats application of this parser one or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser one or many times.
        +
        +
        • +
      + + + +
        +
      • +

        mapError

        +
        public <K> Parser<I,A,K> mapError(F<E,K> f)
        +
        Maps the given function across this parser's error.
        +
        +
        Parameters:
        +
        f - The function to map this parser's error with.
        +
        Returns:
        +
        A new parser with a new error type.
        +
        +
        • +
      + + + +
        +
      • +

        parser

        +
        public static <I,A,E> Parser<I,A,E> parser(F<I,Validation<E,Result<I,A>>> f)
        +
        Returns a parser that computes using the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the parser with.
        +
        Returns:
        +
        A parser that computes using the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <I,A,E> Parser<I,A,E> value(A a)
        +
        Constructs a parser that always returns the given value. The unital for a parser.
        +
        +
        Parameters:
        +
        a - The value to consistently return from a parser.
        +
        Returns:
        +
        A parser that always returns the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <I,A,E> Parser<I,A,E> fail(E e)
        +
        Returns a parser that always fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with.
        +
        Returns:
        +
        A parser that always fails with the given error.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/Result.html b/javadoc/4.8/functionaljava/fj/parser/Result.html new file mode 100644 index 0000000..493f40e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/Result.html @@ -0,0 +1,524 @@ + + + + + +Result (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Result<I,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Result<I,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Result<I,A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>>bimap() +
      First-class bifunctor map.
      +
      <B,J> Result<J,B>bimap(F<I,J> f, + F<A,B> g) +
      A bifunctor map across both the remainder of the parse input and the parse value.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      java.util.Iterator<A>iterator() +
      Returns an iterator over the parse value.
      +
      <J> F<F<I,J>,Result<J,A>>mapRest() +
      First-class function mapping across the remainder of the parse input.
      +
      <J> Result<J,A>mapRest(F<I,J> f) +
      Maps the given function across the remainder of the parse input.
      +
      <B> F<F<A,B>,Result<I,B>>mapValue() +
      First-class function mapping across the parse value.
      +
      <B> Result<I,B>mapValue(F<A,B> f) +
      Maps the given function across the parse value.
      +
      Irest() +
      The remainder of the parse input.
      +
      static <A,I> F<I,F<A,Result<I,A>>>result() +
      First-class construction of a result.
      +
      static <A,I> Result<I,A>result(I i, + A a) +
      Construct a result with the given remainder of the parse input and parse value.
      +
      java.lang.StringtoString() 
      Avalue() +
      The parsed value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        rest

        +
        public I rest()
        +
        The remainder of the parse input.
        +
        +
        Returns:
        +
        The remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The parsed value.
        +
        +
        Returns:
        +
        The parsed value.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> Result<J,A> mapRest(F<I,J> f)
        +
        Maps the given function across the remainder of the parse input.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> F<F<I,J>,Result<J,A>> mapRest()
        +
        First-class function mapping across the remainder of the parse input.
        +
        +
        Returns:
        +
        A first-class function mapping across the remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> Result<I,B> mapValue(F<A,B> f)
        +
        Maps the given function across the parse value.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse value.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> F<F<A,B>,Result<I,B>> mapValue()
        +
        First-class function mapping across the parse value.
        +
        +
        Returns:
        +
        A first-class function mapping across the parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> Result<J,B> bimap(F<I,J> f,
+                               F<A,B> g)
        +
        A bifunctor map across both the remainder of the parse input and the parse value.
        +
        +
        Parameters:
        +
        f - The function to map the remainder of the parse input with.
        +
        g - The function to map the parse value with.
        +
        Returns:
        +
        A result with a different parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>> bimap()
        +
        First-class bifunctor map.
        +
        +
        Returns:
        +
        A first-class bifunctor map.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator over the parse value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        An iterator over the parse value.
        +
        +
        • +
      + + + + + +
        +
      • +

        result

        +
        public static <A,I> Result<I,A> result(I i,
+                                       A a)
        +
        Construct a result with the given remainder of the parse input and parse value.
        +
        +
        Parameters:
        +
        i - The remainder of the parse input.
        +
        a - The parse value.
        +
        Returns:
        +
        A result with the given remainder of the parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        result

        +
        public static <A,I> F<I,F<A,Result<I,A>>> result()
        +
        First-class construction of a result.
        +
        +
        Returns:
        +
        A first-class function for construction of a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/package-frame.html b/javadoc/4.8/functionaljava/fj/parser/package-frame.html new file mode 100644 index 0000000..2062a4e --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/package-frame.html @@ -0,0 +1,23 @@ + + + + + +fj.parser (core 4.8 API) + + + + + +

fj.parser

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8/functionaljava/fj/parser/package-summary.html b/javadoc/4.8/functionaljava/fj/parser/package-summary.html new file mode 100644 index 0000000..d40a8cc --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/package-summary.html @@ -0,0 +1,170 @@ + + + + + +fj.parser (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.parser

+
+
Parser combinators.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Parser<I,A,E> +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    Parser.CharsParser +
    Parsers that accept Stream<Character> input.
    +
    Parser.StreamParser +
    Parsers that accept Stream input.
    +
    Result<I,A> +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    +
    • +
+ + + +

Package fj.parser Description

+
Parser combinators.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/fj/parser/package-tree.html b/javadoc/4.8/functionaljava/fj/parser/package-tree.html new file mode 100644 index 0000000..70bb302 --- /dev/null +++ b/javadoc/4.8/functionaljava/fj/parser/package-tree.html @@ -0,0 +1,138 @@ + + + + + +fj.parser Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.parser

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/help-doc.html b/javadoc/4.8/functionaljava/help-doc.html new file mode 100644 index 0000000..7a3ee29 --- /dev/null +++ b/javadoc/4.8/functionaljava/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/index-all.html b/javadoc/4.8/functionaljava/index-all.html new file mode 100644 index 0000000..8f443be --- /dev/null +++ b/javadoc/4.8/functionaljava/index-all.html @@ -0,0 +1,15671 @@ + + + + + +Index (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _  + + +

$

+
+
$<A,B> - Class in fj.data
+
+
The constant arrow, for attaching a new name to an existing type.
+
+
+ + + +

A

+
+
abs - Static variable in class fj.function.BigIntegers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Doubles
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Integers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Longs
+
+
Absolute value.
+
+
absurd() - Method in class fj.Void
+
+
Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
+
+
accumapply(Semigroup<E>, Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F<T, F<A, B>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F2<T, A, B>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F<T, F<A, F<B, C>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F3<T, A, B, C>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F<T, F<A, F<B, F<C, D>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F4<T, A, B, C, D>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F<T, F<A, F<B, F<C, F<D, E$>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F5<T, A, B, C, D, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F<T, F<A, F<B, F<C, F<D, F<E$, F$>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F6<T, A, B, C, D, E$, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F7<T, A, B, C, D, E$, F$, G>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F8<T, A, B, C, D, E$, F$, G, H>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate() - Method in class fj.data.Validation
+
 
+
accumulate(F<T, B>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, F2<T, B, C>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, F3<T, B, C, D>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, F4<T, B, C, D, $E>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, F5<T, B, C, D, $E, $F>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, F6<T, B, C, D, $E, $F, G>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, F7<T, B, C, D, $E, $F, G, H>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, Validation<E, H>, F8<T, B, C, D, $E, $F, G, H, I>) - Method in class fj.data.Validation
+
 
+
act(A) - Method in class fj.control.parallel.Actor
+
+
Pass a message to this actor, applying its side-effect to the message.
+
+
Actor<A> - Class in fj.control.parallel
+
+
Light weight actors for Java.
+
+
actor(Strategy<Unit>, Effect1<A>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Strategy<Unit>, F<A, P1<Unit>>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a concurrent actor that is guaranteed to process only one message at a time.
+
+
actor() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of actors.
+
+
add(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HSucc<M>, H) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of numbers a and b is one greater than the sum of b and the predecessor of a.
+
+
add - Static variable in class fj.data.Natural
+
+
A function that adds two natural numbers.
+
+
add(Natural) - Method in class fj.data.Natural
+
+
Add two natural numbers together.
+
+
add - Static variable in class fj.function.BigIntegers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Doubles
+
+
Curried Double addition.
+
+
add - Static variable in class fj.function.Integers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Longs
+
+
Curried Long addition.
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if all targets satisfy the predicate
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if all targets satisfy the predicate
+
+
allEqual(Equal<A>) - Method in class fj.data.List
+
+
Returns whether or not all elements in the list are equal according to the given equality test.
+
+
alpha(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alpha(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alphaNum(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
alphaNum(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
always(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation without caching.
+
+
and(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
and - Static variable in class fj.function.Booleans
+
+
Curried form of logical "and" (conjunction).
+
+
and(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given list are true.
+
+
and(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using conjunction
+
+
and(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given stream are true.
+
+
andAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns composed predicate
+
+
andAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
andThen(F<B, C>) - Method in class fj.data.Reader
+
 
+
andThen(F<A, B>, F<B, C>) - Static method in class fj.F1Functions
+
+
Function composition flipped.
+
+
andThen(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class composition flipped.
+
+
andThen(F<B, C>) - Method in class fj.F1W
+
+
Function composition flipped.
+
+
andThen() - Method in class fj.F1W
+
+
First-class composition flipped.
+
+
andThen() - Static method in class fj.Function
+
+
Function composition flipped.
+
+
andThen(F<A, B>, F<B, C>) - Static method in class fj.Function
+
+
Function composition flipped.
+
+
anyEqual() - Static method in class fj.Equal
+
+
Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
+
+
anyHash() - Static method in class fj.Hash
+
+
A hash that uses Object.hashCode().
+
+
anyShow() - Static method in class fj.Show
+
+
Returns a show instance that uses Object.toString() to perform the display rendering.
+
+
append(Array<A>) - Method in class fj.data.Array
+
+
Appends the given array to this array.
+
+
append(Array<A>) - Method in class fj.data.Array.ImmutableProjection
+
+
Appends the given array to this array.
+
+
append(DList<A>) - Method in class fj.data.DList
+
+
Appends two DLists together to produce a new DList.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Deep
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Empty
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.FingerTree
+
+
Appends one finger tree to another.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Single
+
 
+
append() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for concatenating heterogeneous lists.
+
+
append(A, B) - Method in class fj.data.hlist.HList.HAppend
+
+
Append a given heterogeneous list to another.
+
+
append() - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for concatenating lists to the empty list.
+
+
append(H) - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for appending lists to a nonempty heterogeneous list.
+
+
append(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
append(IO<B>) - Method in class fj.data.IOW
+
 
+
append(LazyString) - Method in class fj.data.LazyString
+
+
Appends the given lazy string to the end of this lazy string.
+
+
append(String) - Method in class fj.data.LazyString
+
+
Appends the given String to the end of this lazy string.
+
+
append(List<A>) - Method in class fj.data.List
+
+
Appends the given list to this list.
+
+
append(List<A>) - Method in class fj.data.List.Buffer
+
+
Appends the given list to this buffer.
+
+
append(List<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(NonEmptyList<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(Seq<A>) - Method in class fj.data.Seq
+
+
Appends the given sequence to this sequence.
+
+
append(Stream<A>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(A, A) - Method in interface fj.Monoid.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Ord.Definition
+
 
+
append(C) - Method in class fj.P2
+
+
Creates a P3 by adding the given element to the current P2
+
+
append(P2<C, D>) - Method in class fj.P2
+
+
Creates a P4 by adding the given element to the current P2
+
+
append(P3<C, D, E>) - Method in class fj.P2
+
+
Creates a P5 by adding the given element to the current P2
+
+
append(P4<C, D, E, F>) - Method in class fj.P2
+
+
Creates a P6 by adding the given element to the current P2
+
+
append(P5<C, D, E, F, G>) - Method in class fj.P2
+
+
Creates a P7 by adding the given element to the current P2
+
+
append(P6<C, D, E, F, G, H>) - Method in class fj.P2
+
+
Creates a P8 by adding the given element to the current P2
+
+
append(D) - Method in class fj.P3
+
+
Creates a P4 by adding the given element to the current P3
+
+
append(P2<D, E>) - Method in class fj.P3
+
+
Creates a P5 by adding the given element to the current P3
+
+
append(P3<D, E, F>) - Method in class fj.P3
+
+
Creates a P6 by adding the given element to the current P3
+
+
append(P4<D, E, F, G>) - Method in class fj.P3
+
+
Creates a P7 by adding the given element to the current P3
+
+
append(P5<D, E, F, G, H>) - Method in class fj.P3
+
+
Creates a P8 by adding the given element to the current P3
+
+
append(E) - Method in class fj.P4
+
+
Creates a P5 by adding the given element to the current P4
+
+
append(P2<E, F>) - Method in class fj.P4
+
+
Creates a P6 by adding the given element to the current P4
+
+
append(P3<E, F, G>) - Method in class fj.P4
+
+
Creates a P7 by adding the given element to the current P4
+
+
append(P4<E, F, G, H>) - Method in class fj.P4
+
+
Creates a P8 by adding the given element to the current P4
+
+
append(F) - Method in class fj.P5
+
+
Creates a P6 by adding the given element to the current P5
+
+
append(P2<F, G>) - Method in class fj.P5
+
+
Creates a P7 by adding the given element to the current P5
+
+
append(P3<F, G, H>) - Method in class fj.P5
+
+
Creates a P8 by adding the given element to the current P5
+
+
append(G) - Method in class fj.P6
+
+
Creates a P7 by adding the given element to the current P6
+
+
append(P2<G, H>) - Method in class fj.P6
+
+
Creates a P8 by adding the given element to the current P6
+
+
append(H) - Method in class fj.P7
+
+
Creates a P8 by adding the given element to the current P7
+
+
append(A, A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Semigroup.Definition
+
 
+
apply(Callable<A>, Callable<F<A, B>>) - Static method in class fj.control.parallel.Callables
+
+
Performs function application within a callable (applicative functor pattern).
+
+
apply(Promise<F<A, B>>) - Method in class fj.control.parallel.Promise
+
+
Performs function application within a promise (applicative functor pattern).
+
+
apply(Trampoline<F<A, B>>) - Method in class fj.control.Trampoline
+
+
Performs function application within a Trampoline (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Either<F<A, X>, B>) - Method in class fj.data.Either.LeftProjection
+
+
Function application on this projection's value.
+
+
apply(Either<A, F<B, X>>) - Method in class fj.data.Either.RightProjection
+
+
Function application on this projection's value.
+
+
Apply() - Constructor for class fj.data.hlist.HList.Apply
+
 
+
apply(F$, A) - Method in class fj.data.hlist.HList.Apply
+
 
+
apply(IO<A>, IO<F<A, B>>) - Static method in class fj.data.IOFunctions
+
 
+
apply(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Performs function application within an iterable (applicative functor pattern).
+
+
apply(F0<Z>, F0<F<E, Z>>, F0<Z>) - Method in class fj.data.Iteratee.Input
+
 
+
apply(List<F<A, B>>) - Method in class fj.data.List
+
+
Performs function application within a list (applicative functor pattern).
+
+
apply(Option<F<A, B>>) - Method in class fj.data.Option
+
+
Performs function application within an optional value (applicative functor pattern).
+
+
apply(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Performs function application within a stream (applicative functor pattern).
+
+
apply(Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the success value.
+
+
apply(Validation<F<E, A>, T>) - Method in class fj.data.Validation.FailProjection
+
+
Function application on the failing value.
+
+
apply(V2<F<A, B>>) - Method in class fj.data.vector.V2
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V3<F<A, B>>) - Method in class fj.data.vector.V3
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V4<F<A, B>>) - Method in class fj.data.vector.V4
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V5<F<A, B>>) - Method in class fj.data.vector.V5
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V6<F<A, B>>) - Method in class fj.data.vector.V6
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V7<F<A, B>>) - Method in class fj.data.vector.V7
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V8<F<A, B>>) - Method in class fj.data.vector.V8
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(F<A, B>, F<A, F<B, C>>) - Static method in class fj.F1Functions
+
+
Function application in an environment (Applicative Functor).
+
+
apply(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function application in an environment.
+
+
apply(F<A, F<B, C>>) - Method in class fj.F1W
+
+
Function application in an environment (Applicative Functor).
+
+
apply() - Method in class fj.F1W
+
+
First-class function application in an environment.
+
+
apply(A) - Static method in class fj.Function
+
+
Function application with the arguments flipped.
+
+
apply(F<C, F<A, B>>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(F2<C, A, B>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(P1<F<A, B>>) - Method in class fj.P1
+
+
Performs function application within a P1 (applicative functor pattern).
+
+
apply(Parser<I, F<A, B>, E>) - Method in class fj.parser.Parser
+
+
Performs function application within a parser.
+
+
Array<A> - Class in fj.data
+
+
Provides an interface to arrays.
+
+
array(Class<A[]>) - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array() - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array(A...) - Static method in class fj.data.Array
+
+
Constructs an array from the given elements.
+
+
array(Class<A[]>) - Method in class fj.data.List
+
+
Returns an array from this list.
+
+
array(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array from this optional value.
+
+
array(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns an array from this stream.
+
+
Array.ImmutableProjection<A> - Class in fj.data
+
+
Projects an array by providing only operations which do not mutate.
+
+
Array_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to array blocking queues.
+
+
Array_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to array lists.
+
+
Array_BitSet - Static variable in class fj.data.Java
+
+
A function that converts arrays to bit sets.
+
+
Array_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to concurrent linked queues.
+
+
Array_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array lists.
+
+
Array_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array sets.
+
+
Array_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to delay queues.
+
+
Array_Either() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to eithers.
+
+
Array_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to enum sets.
+
+
Array_HashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to hash sets.
+
+
Array_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked blocking queues.
+
+
Array_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked hash sets.
+
+
Array_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked lists.
+
+
Array_List() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to lists.
+
+
Array_Option() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to options.
+
+
Array_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority blocking queues.
+
+
Array_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority queues.
+
+
Array_Stack() - Static method in class fj.data.Java
+
+
A function that converts arrays to stacks.
+
+
Array_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to streams.
+
+
Array_String - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to strings.
+
+
Array_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string buffers.
+
+
Array_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string builders.
+
+
Array_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to synchronous queues.
+
+
Array_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to tree sets.
+
+
Array_Vector() - Static method in class fj.data.Java
+
+
A function that converts arrays to vectors.
+
+
arrayArray(A...) - Static method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
ArrayBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts array blocking queues to lists.
+
+
arrayDList(A...) - Static method in class fj.data.DList
+
+
Creates a DList from an array
+
+
arrayEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Array type.
+
+
arrayHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Array type.
+
+
arrayHashMap(P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashMap(Equal<K>, Hash<K>, P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayHashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a Array.
+
+
arrayK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a Array.
+
+
arrayList(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
ArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts array lists to lists.
+
+
arrayM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Arrays.
+
+
arrayM() - Method in class fj.F2W
+
+
Promotes this function to a function on Arrays.
+
+
arrayMonoid() - Static method in class fj.Monoid
+
+
A monoid for arrays.
+
+
arrayOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Array type.
+
+
arraySemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for arrays.
+
+
arraySeq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the array.
+
+
arraySet(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
arrayShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Array type.
+
+
arrayStream(A...) - Static method in class fj.data.Stream
+
 
+
arrayTreeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
arrow() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a function to a Callable-valued function that is equivalent to it.
+
+
arrow() - Static method in class fj.data.IterableW
+
+
Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
+
+
as(IO<A>, B) - Static method in class fj.data.IOFunctions
+
 
+
asFold() - Method in class fj.data.optic.Getter
+
+
view a Getter with a Fold
+
+
asFold() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Fold
+
+
asFold() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Fold
+
+
asFold() - Method in class fj.data.optic.POptional
+
+
view a POptional as a Fold
+
+
asFold() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Fold
+
+
asFold() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a Fold
+
+
asFunction() - Method in class fj.control.db.DB
+
+
Returns the callable-valued function projection of this database action.
+
+
asGetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Getter
+
+
asGetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Getter
+
+
asJavaList() - Method in class fj.data.Array
+
+
Projects an unmodifiable list view of this array.
+
+
asLens() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Lens
+
+
asLens() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PLens
+
+
asOptional() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Optional
+
+
asOptional() - Method in class fj.data.optic.Lens
+
+
view a Lens as an Optional
+
+
asOptional() - Method in class fj.data.optic.PIso
+
+
view a PIso as a POptional
+
+
asOptional() - Method in class fj.data.optic.PLens
+
+
view a PLens as an POptional
+
+
asOptional() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a POptional
+
+
asOptional() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Optional
+
+
asPrism() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Prism
+
+
asPrism() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PPrism
+
+
asSetter() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Setter
+
+
asSetter() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Setter
+
+
asSetter() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Setter
+
+
asSetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Setter
+
+
asSetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PSetter
+
+
asSetter() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PSetter
+
+
asSetter() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Setter
+
+
asSetter() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Setter
+
+
asSetter() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a PSetter
+
+
asSetter() - Method in class fj.data.optic.Traversal
+
+
view a Traversal as a Setter
+
+
association(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
associationLazy(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
asString() - Method in class fj.data.hamt.BitSet
+
 
+
asString(List<Character>) - Static method in class fj.data.List
+
+
Returns a string from the given list of characters.
+
+
asString() - Static method in class fj.data.List
+
+
A first-class asString.
+
+
asString(Stream<Character>) - Static method in class fj.data.Stream
+
+
Returns a string from the given stream of characters.
+
+
asTraversal() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Traversal
+
+
atEnd() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the last element.
+
+
atStart() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the first element.
+
+
+ + + +

B

+
+
BASE_LONG - Static variable in class fj.data.hamt.BitSet
+
 
+
bigdecimalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big decimals.
+
+
bigdecimalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big decimals.
+
+
bigdecimalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigDecimal.
+
+
bigdecimalEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigDecimal type.
+
+
bigdecimalHash - Static variable in class fj.Hash
+
+
A hash instance for the BigDecimal type.
+
+
bigDecimalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big decimals.
+
+
bigDecimalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big decimals.
+
+
bigdecimalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big decimals.
+
+
bigdecimalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big decimals.
+
+
bigdecimalOrd - Static variable in class fj.Ord
+
+
An order instance for the BigDecimal type.
+
+
bigdecimalShow - Static variable in class fj.Show
+
+
A show instance for the BigDecimal type.
+
+
bigintAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big integers.
+
+
bigintAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big integers.
+
+
BigIntegers - Class in fj.function
+
+
Curried functions over Integers.
+
+
bigIntegerValue - Static variable in class fj.data.Natural
+
+
A function that returns the BigInteger value of a given Natural.
+
+
bigIntegerValue() - Method in class fj.data.Natural
+
+
Return the BigInteger value of this natural number.
+
+
bigintEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigInteger.
+
+
bigintEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigInteger type.
+
+
bigintHash - Static variable in class fj.Hash
+
+
A hash instance for the BigInteger type.
+
+
bigintMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big integers.
+
+
bigintMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big integers.
+
+
bigintMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big integers.
+
+
bigintMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big integers.
+
+
bigintOrd - Static variable in class fj.Ord
+
+
An order instance for the BigInteger type.
+
+
bigintShow - Static variable in class fj.Show
+
+
A show instance for the BigInteger type.
+
+
bimap(F<A, X>, F<B, Y>) - Method in class fj.data.Either
+
+
Map the given functions across the appropriate side.
+
+
bimap(F<I, J>, F<A, B>) - Method in class fj.parser.Result
+
+
A bifunctor map across both the remainder of the parse input and the parse value.
+
+
bimap() - Method in class fj.parser.Result
+
+
First-class bifunctor map.
+
+
bind(F<A, DB<B>>) - Method in class fj.control.db.DB
+
+
Binds the given action across the result of this database action.
+
+
bind(Callable<A>, F<A, Callable<B>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the value in a Callable with a final join.
+
+
bind(Callable<A>, Callable<B>, F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the values in the given callables with a final join.
+
+
bind(F<A, Promise<B>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function over this promise, with a final join.
+
+
bind(Promise<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(P1<Promise<B>>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(F<A, Trampoline<B>>) - Method in class fj.control.Trampoline
+
+
Binds the given continuation to the result of this trampoline.
+
+
bind(Trampoline<B>, F<A, F<B, C>>) - Method in class fj.control.Trampoline
+
+
Binds the given function across the result of this Trampoline and the given Trampoline.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(F<A, Either<X, B>>) - Method in class fj.data.Either.LeftProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<B, Either<A, X>>) - Method in class fj.data.Either.RightProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function that directly produces Eval.
+
+
bind(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
bind(F<A, IO<B>>) - Method in class fj.data.IOW
+
 
+
bind(F<A, T>) - Method in class fj.data.IterableW
+
+
Binds the given function across the wrapped Iterable with a final join.
+
+
bind(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Binds the given function to the values in the given iterables with a final join.
+
+
bind() - Static method in class fj.data.IterableW
+
+
The first-class bind function over Iterable.
+
+
bind(F<A, Iteratee.IterV<E, B>>) - Method in class fj.data.Iteratee.IterV
+
+
TODO more documentation
+
+
bind(F<Character, LazyString>) - Method in class fj.data.LazyString
+
 
+
bind(F<A, List<B>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, List<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, List<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(F<A, NonEmptyList<B>>) - Method in class fj.data.NonEmptyList
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(F<A, Option<B>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value with a final join.
+
+
bind(Option<B>, F<A, F<B, C>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind() - Static method in class fj.data.Option
+
+
First-class bind function.
+
+
bind(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
bind(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Set
+
+
Binds the given function across this set.
+
+
bind(F<A, Stream<B>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream with a final join.
+
+
bind(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, Stream<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, Stream<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(F<T, Validation<E, A>>) - Method in class fj.data.Validation
+
+
Binds the given function across this validation's success value if it has one.
+
+
bind(F<E, Validation<A, T>>) - Method in class fj.data.Validation.FailProjection
+
+
Binds the given function across this validation's failing value if it has one.
+
+
bind(F<A, B>, F<B, F<A, C>>) - Static method in class fj.F1Functions
+
+
Binds a given function across this function (Reader Monad).
+
+
bind(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function binding.
+
+
bind(F<B, F<A, C>>) - Method in class fj.F1W
+
+
Binds a given function across this function (Reader Monad).
+
+
bind() - Method in class fj.F1W
+
+
First-class function binding.
+
+
bind(F<C, A>, F<A, F<C, B>>) - Static method in class fj.Function
+
+
Binds the function in the second argument to the function in the first argument.
+
+
bind(F<D, A>, F<D, B>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Binds the given function f to the values of the given functions, with a final join.
+
+
bind(F<A, P1<B>>) - Method in class fj.P1
+
+
Binds the given function to the value in a product-1 with a final join.
+
+
bind(P1<B>, F<A, F<B, C>>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(F<A, Parser<I, B, E>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parser with a final join.
+
+
bind(Parser<I, B, E>, F<A, F<B, C>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, F<A, F<B, F<C, D>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, F<A, F<B, F<C, F<D, E$>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, F<A, F<B, F<C, F<D, F<E$, F$>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, Parser<I, H, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, F<H, I$>>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind_() - Static method in class fj.control.Trampoline
+
 
+
bind_() - Static method in class fj.data.List
+
+
Provides a first-class version of bind()
+
+
bind_() - Static method in class fj.data.Stream
+
+
A first-class version of the bind function.
+
+
bindProduct(Option<B>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>) - Method in class fj.data.Option
+
 
+
BITS_IN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
BitSet - Class in fj.data.hamt
+
+
A sequence of bits representing a value.
+
+
BitSet_List - Static variable in class fj.data.Java
+
+
A function that converts bit sets to lists.
+
+
bitSetSequal - Static variable in class fj.Equal
+
+
An equal instance for the BitSet type.
+
+
bitSetShow - Static variable in class fj.Show
+
 
+
bitsOn() - Method in class fj.data.hamt.BitSet
+
 
+
bitsToRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
bitsUsed() - Method in class fj.data.hamt.BitSet
+
 
+
Boolean_Byte - Static variable in class fj.Primitive
+
+
A function that converts booleans to bytes.
+
+
Boolean_Character - Static variable in class fj.Primitive
+
+
A function that converts booleans to characters.
+
+
Boolean_Double - Static variable in class fj.Primitive
+
+
A function that converts booleans to doubles.
+
+
Boolean_Float - Static variable in class fj.Primitive
+
+
A function that converts booleans to floats.
+
+
Boolean_Integer - Static variable in class fj.Primitive
+
+
A function that converts booleans to integers.
+
+
Boolean_Long - Static variable in class fj.Primitive
+
+
A function that converts booleans to longs.
+
+
Boolean_Short - Static variable in class fj.Primitive
+
+
A function that converts booleans to shorts.
+
+
booleanEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for boolean.
+
+
booleanEqual - Static variable in class fj.Equal
+
+
An equal instance for the boolean type.
+
+
booleanHash - Static variable in class fj.Hash
+
+
A hash instance for the boolean type.
+
+
booleanOrd - Static variable in class fj.Ord
+
+
An order instance for the boolean type.
+
+
Booleans - Class in fj.function
+
+
Curried logical functions.
+
+
booleanShow - Static variable in class fj.Show
+
+
A show instance for the boolean type.
+
+
Bottom - Class in fj
+
+
Represents the bottom _|_ value.
+
+
bottomUp(Tree<A>, F<P2<A, Stream<B>>, B>) - Static method in class fj.data.Tree
+
+
Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
+
+
bracket(IO<A>, F<A, IO<B>>, F<A, IO<C>>) - Static method in class fj.data.IOFunctions
+
 
+
breakk(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
+
+
Buffer() - Constructor for class fj.data.List.Buffer
+
 
+
bufferedReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
Byte_Boolean - Static variable in class fj.Primitive
+
+
A function that converts bytes to booleans.
+
+
Byte_Character - Static variable in class fj.Primitive
+
+
A function that converts bytes to characters.
+
+
Byte_Double - Static variable in class fj.Primitive
+
+
A function that converts bytes to doubles.
+
+
Byte_Float - Static variable in class fj.Primitive
+
+
A function that converts bytes to floats.
+
+
Byte_Integer - Static variable in class fj.Primitive
+
+
A function that converts bytes to integers.
+
+
Byte_Long - Static variable in class fj.Primitive
+
+
A function that converts bytes to longs.
+
+
Byte_Short - Static variable in class fj.Primitive
+
+
A function that converts bytes to shorts.
+
+
byteEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for byte.
+
+
byteEqual - Static variable in class fj.Equal
+
+
An equal instance for the byte type.
+
+
byteHash - Static variable in class fj.Hash
+
+
A hash instance for the byte type.
+
+
byteOrd - Static variable in class fj.Ord
+
+
An order instance for the byte type.
+
+
byteShow - Static variable in class fj.Show
+
+
A show instance for the byte type.
+
+
+ + + +

C

+
+
callable(A) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that completely preserves the argument.
+
+
callable(Exception) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that throws the given exception.
+
+
callable() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a value to a Callable that completely preserves that value.
+
+
callable(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Wraps a given function's return value in a Callable.
+
+
Callables - Class in fj.control.parallel
+
+
Monadic functions and conversion methods for java.util.concurrent.Callable.
+
+
callableStrategy(Strategy<Callable<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a normalising strategy that fully evaluates its Callable argument.
+
+
character(F0<E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(E) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(F0<E>, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
character(E, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
Character_Boolean - Static variable in class fj.Primitive
+
+
A function that converts characters to booleans.
+
+
Character_Byte - Static variable in class fj.Primitive
+
+
A function that converts characters to bytes.
+
+
Character_Double - Static variable in class fj.Primitive
+
+
A function that converts characters to doubles.
+
+
Character_Float - Static variable in class fj.Primitive
+
+
A function that converts characters to floats.
+
+
Character_Integer - Static variable in class fj.Primitive
+
+
A function that converts characters to integers.
+
+
Character_Long - Static variable in class fj.Primitive
+
+
A function that converts characters to longs.
+
+
Character_Short - Static variable in class fj.Primitive
+
+
A function that converts characters to shorts.
+
+
Characters - Class in fj.function
+
+
First-class functions on Characters.
+
+
characters(F0<E>, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(E, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(F0<E>, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
characters(E, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
charAt(int) - Method in class fj.data.LazyString
+
+
Returns the caracter at the specified index.
+
+
charChunkReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with character chunks read from a Reader + (char[] of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charChunkReader2() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for char.
+
+
charEqual - Static variable in class fj.Equal
+
+
An equal instance for the char type.
+
+
charHash - Static variable in class fj.Hash
+
+
A hash instance for the char type.
+
+
charOrd - Static variable in class fj.Ord
+
+
An order instance for the char type.
+
+
charShow - Static variable in class fj.Show
+
+
A show instance for the char type.
+
+
claim() - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
claim(long, TimeUnit) - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
clas() - Method in class fj.Class
+
+
Returns the underlying class.
+
+
clas(Class<T>) - Static method in class fj.Class
+
+
Constructs a class from the given argument.
+
+
Class<T> - Class in fj
+
+
A wrapper for a Class that provides additional methods.
+
+
classParameters() - Method in class fj.Class
+
+
Provides this class's type parameter information as a Tree of the type expression.
+
+
classShow() - Static method in class fj.Show
+
+
A show instance for the Class type.
+
+
clear(int) - Method in class fj.data.hamt.BitSet
+
 
+
clear() - Method in class fj.data.HashMap
+
+
Clear all entries from this hash map.
+
+
clear() - Method in class fj.data.HashSet
+
+
Clear all elements from this hash set.
+
+
closeReader - Static variable in class fj.data.IOFunctions
+
 
+
closeReader(Reader) - Static method in class fj.data.IOFunctions
+
 
+
cobind(F<Promise<A>, B>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function across a promise of this promise (Comonad pattern).
+
+
cobind(F<Stream<A>, B>) - Method in class fj.data.Stream
+
+
Binds the given function across the stream of substreams of this stream.
+
+
cobind(F<Tree<A>, B>) - Method in class fj.data.Tree
+
+
Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
+
+
cobind(F<TreeZipper<A>, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function over the tree of all positions for this zipper (comonad pattern).
+
+
cobind(F<Zipper<A>, B>) - Method in class fj.data.Zipper
+
+
Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
+
+
cobind(F<P2<A, B>, C>) - Method in class fj.P2
+
+
Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
+
+
codiagonal() - Static method in class fj.data.optic.Fold
+
 
+
codiagonal() - Static method in class fj.data.optic.Getter
+
 
+
codiagonal() - Static method in class fj.data.optic.Setter
+
 
+
codiagonal() - Static method in class fj.data.optic.Traversal
+
 
+
cojoin() - Method in class fj.control.parallel.Promise
+
+
Duplicates this promise to a promise of itself (Comonad pattern).
+
+
cojoin() - Method in class fj.data.Tree
+
+
Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
+
+
Collection_List(Collection<A>) - Static method in class fj.data.Java
+
 
+
Collection_List() - Static method in class fj.data.Java
+
 
+
comp() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for function composition.
+
+
comparableOrd() - Static method in class fj.Ord
+
+
An order instance for the Comparable interface.
+
+
compare(A, A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare(A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare() - Method in class fj.Ord
+
+
First-class ordering.
+
+
compare(A, A) - Method in class fj.Ord
+
+
Returns an ordering for the given arguments.
+
+
compare(A) - Method in interface fj.Ord.Definition
+
 
+
compare(A, A) - Method in interface fj.Ord.Definition
+
 
+
completionStrategy(CompletionService<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
+
+
compose() - Static method in class fj.Function
+
+
Function composition.
+
+
compose(F<B, C>, F<A, B>) - Static method in class fj.Function
+
+
Function composition.
+
+
compose(Monoid<B>) - Method in class fj.Monoid
+
+
Composes this monoid with another.
+
+
compose(Monoid<B>, F<C, A>, F<C, B>, F2<A, B, C>) - Method in class fj.Monoid
+
 
+
compose(Semigroup<B>, F<C, B>, F<C, A>, F2<A, B, C>) - Method in class fj.Semigroup
+
 
+
compose2(F<C, D>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function composition.
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Fold
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Fold
+
+
composeFold(Getter<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Getter
+
+
composeGetter(Getter<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Getter
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with an Iso
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PLens
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a POptional
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PPrism
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Setter
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Traversal
+
+
ConcurrentLinkedQueue_List() - Static method in class fj.data.Java
+
+
A function that converts concurrent linked queues to lists.
+
+
concurry(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a concurrent function.
+
+
concurry(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function of arity-2 to a concurrent function.
+
+
cond() - Static method in class fj.function.Booleans
+
+
Curried form of conditional.
+
+
condition(boolean, E, T) - Static method in class fj.data.Validation
+
+
Returns a validation based on a boolean condition.
+
+
conjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ANDs booleans.
+
+
conjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ANDs booleans.
+
+
connect() - Method in class fj.control.db.Connector
+
 
+
Connector - Class in fj.control.db
+
+
A method of connecting to the database.
+
+
Connector() - Constructor for class fj.control.db.Connector
+
 
+
cons(A) - Method in class fj.data.DList
+
+
Prepends a single element on the DList to produce a new DList.
+
+
cons(A) - Method in class fj.data.fingertrees.Deep
+
 
+
cons(A) - Method in class fj.data.fingertrees.Empty
+
 
+
cons(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the first element.
+
+
cons(A) - Method in class fj.data.fingertrees.Single
+
 
+
cons() - Static method in class fj.data.hlist.HList.Apply
+
+
An operator for the construction of heterogeneous lists.
+
+
cons(E, L) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of an element and another list.
+
+
cons(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
cons() - Static method in class fj.data.List
+
+
Returns a function that prepends (cons) an element to a list to produce a new list.
+
+
cons(List<A>) - Static method in class fj.data.List
+
+
Returns a function that prepends a value to the given list.
+
+
cons(A, List<A>) - Static method in class fj.data.List
+
+
Prepends the given head element to the given tail element to produce a new list.
+
+
cons() - Static method in class fj.data.List.Optic
+
+
Cons prism
+
+
cons(A) - Method in class fj.data.NonEmptyList
+
+
Prepend the given value to this list.
+
+
cons(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the front of this sequence.
+
+
cons(A) - Method in class fj.data.Stream
+
+
Prepends (cons) the given element to this stream to product a new stream.
+
+
cons() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
cons(A, F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Prepends the given head element to the given tail element to produce a new stream.
+
+
cons(P1<A>, V2<A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a head and a tail.
+
+
cons(P1<A>, V3<A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a head and a tail.
+
+
cons(P1<A>, V4<A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a head and a tail.
+
+
cons(P1<A>, V5<A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a head and a tail.
+
+
cons(P1<A>, V6<A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a head and a tail.
+
+
cons(P1<A>, V7<A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a head and a tail.
+
+
cons_() - Static method in class fj.data.List
+
 
+
cons_(A) - Static method in class fj.data.List
+
+
Returns a function that prepends the given value to a list.
+
+
cons_() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
conss(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
constant(B) - Static method in class fj.data.$
+
 
+
constant(B) - Static method in class fj.data.Reader
+
 
+
constant(A) - Static method in class fj.data.State
+
 
+
constant() - Static method in class fj.Function
+
+
Returns a function that given an argument, returns a function that ignores its argument.
+
+
constant(B) - Static method in class fj.Function
+
+
Returns a function that ignores its argument to constantly produce the given value.
+
+
constant() - Method in class fj.P1
+
+
Returns a constant function that always uses this value.
+
+
cont(F<Iteratee.Input<E>, Iteratee.IterV<E, A>>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that takes an element from an input to yield a new computation
+
+
contains(K) - Method in class fj.data.HashMap
+
+
Determines if the given key value exists in this hash map.
+
+
contains(A) - Method in class fj.data.HashSet
+
+
Determines if this hash set contains the given element.
+
+
contains(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a substring of this lazy string.
+
+
contains(K) - Method in class fj.data.PriorityQueue
+
+
Does the priority k exist already?
+
+
contains(K) - Method in class fj.data.TreeMap
+
+
Determines if the given key value exists in this tree map.
+
+
contains - Static variable in class fj.function.Strings
+
+
A curried version of String.contains(CharSequence).
+
+
contramap(F<B, A>) - Method in class fj.control.parallel.Actor
+
+
Contravariant functor pattern.
+
+
contramap(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
+
+
contramap(Effect1<A>, F<B, A>) - Static method in class fj.Effect
+
+
A contra-variant functor on effect.
+
+
contramap(F<B, A>) - Method in class fj.Equal
+
+
Maps the given function across this equal as a contra-variant functor.
+
+
contramap(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Static version of Equal.contramap(F)
+
+
contramap(F<A, B>, F<C, A>) - Static method in class fj.F1Functions
+
 
+
contramap(F<C, A>) - Method in class fj.F1W
+
 
+
contramap(F2<A, B, C>, F<X, A>, F<Y, B>) - Static method in class fj.F2Functions
+
 
+
contramap(F<X, A>, F<Y, B>) - Method in class fj.F2W
+
 
+
contramap(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
maps given function to the predicate function
+
+
contramap(F<B, A>) - Method in class fj.Hash
+
+
Maps the given function across this hash as a contra-variant functor.
+
+
contramap(F<B, A>) - Method in class fj.Ord
+
+
Maps the given function across this ord as a contra-variant functor.
+
+
contramap(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Static version of Ord.contramap(F)
+
+
contramap(F<B, A>) - Method in class fj.Show
+
+
Maps the given function across this show as a contra-variant functor.
+
+
contramapActor(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that contramaps over a given actor.
+
+
contramapActor() - Method in class fj.F1W
+
+
Returns a function that contramaps over a given actor.
+
+
contramapEqual(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over an Equal as a contravariant functor.
+
+
contramapEqual() - Method in class fj.F1W
+
+
Promotes this function to map over an Equal as a contravariant functor.
+
+
contramapFirst(F2<A, B, C>, F<Z, A>) - Static method in class fj.F2Functions
+
 
+
contramapFirst(F<Z, A>) - Method in class fj.F2W
+
 
+
contramapHash(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Hash as a contravariant functor.
+
+
contramapHash() - Method in class fj.F1W
+
+
Promotes this function to map over a Hash as a contravariant functor.
+
+
contramapSecond(F2<A, B, C>, F<Z, B>) - Static method in class fj.F2Functions
+
 
+
contramapSecond(F<Z, B>) - Method in class fj.F2W
+
 
+
contramapShow(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Show as a contravariant functor.
+
+
contramapShow() - Method in class fj.F1W
+
+
Promotes this function to map over a Show as a contravariant functor.
+
+
Conversions - Class in fj.data
+
+
Functions that convert between data structure types.
+
+
copyOf(U[], int, Class<? extends T[]>) - Static method in class fj.data.Array
+
 
+
copyOf(T[], int) - Static method in class fj.data.Array
+
 
+
copyOfRange(char[], int, int) - Static method in class fj.data.Array
+
 
+
CopyOnWriteArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array lists to lists.
+
+
CopyOnWriteArraySet_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array sets to lists.
+
+
curry(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
+
+
curry() - Method in class fj.F2W
+
+
Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
+
+
curry(F2<A, B, C>) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F2<A, B, C>, A) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F3<A, B, C, D>) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F4<A, B, C, D, E>) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F5<A, B, C, D, E, F$>) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F6<A, B, C, D, E, F$, G>) - Static method in class fj.Function
+
+
Curry a function of arity-6.
+
+
curry(F7<A, B, C, D, E, F$, G, H>) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$, G) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F<A, B>) - Static method in class fj.P1
+
+
Promotes the given function so that it returns its value in a P1.
+
+
cycle(Stream<A>) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given elements cycling.
+
+
cycleNext() - Method in class fj.data.Zipper
+
+
Move the focus to the next element.
+
+
cyclePrevious() - Method in class fj.data.Zipper
+
+
Move the focus to the previous element.
+
+
+ + + +

D

+
+
DB<A> - Class in fj.control.db
+
+
The DB monad represents a database action, or a value within the context of a database connection.
+
+
DB() - Constructor for class fj.control.db.DB
+
 
+
db(F<Connection, A>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
db(Try1<Connection, A, SQLException>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
DbState - Class in fj.control.db
+
+
Performs database I/O, in order to read or write the database state.
+
+
decons(A, Show<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
decons(Class<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
Deep<V,A> - Class in fj.data.fingertrees
+
+
A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
+
+
deep(Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree.
+
+
deep(V, Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree with the given annotation value.
+
+
defer(F0<Eval<A>>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation of an expression that produces Eval.
+
+
defined(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
defined(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
DelayQueue_List() - Static method in class fj.data.Java
+
+
A function that converts delay queues to lists.
+
+
delete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key.
+
+
delete(A) - Method in class fj.data.HashSet
+
+
Deletes the given element from this hash set.
+
+
delete(A, Equal<A>) - Method in class fj.data.List
+
+
Removes the first element that equals the given object.
+
+
delete(int) - Method in class fj.data.Seq
+
+
Delete the element at the given index.
+
+
delete(A) - Method in class fj.data.Set
+
+
Deletes the given element from this set.
+
+
delete() - Method in class fj.data.Set
+
+
First-class deletion function.
+
+
delete(K) - Method in class fj.data.TreeMap
+
+
Deletes the entry in the tree map that corresponds to the given key.
+
+
delete() - Method in class fj.data.TreeZipper
+
+
Removes the current node from the tree.
+
+
deleteLeft() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the left into focus.
+
+
deleteLeftCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the left into focus.
+
+
deleteOthers() - Method in class fj.data.Zipper
+
+
Deletes all elements in the zipper except the focus.
+
+
deleteRight() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the right into focus.
+
+
deleteRightCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the right into focus.
+
+
dequeue() - Method in class fj.data.PriorityQueue
+
+
Removes the node with the highest priority.
+
+
dequeue(int) - Method in class fj.data.PriorityQueue
+
+
Removes the top n elements with the highest priority.
+
+
Digit<V,A> - Class in fj.data.fingertrees
+
+
A digit is a vector of 1-4 elements.
+
+
Digit - Enum in fj
+
+
The digits zero to nine.
+
+
digit - Static variable in class fj.function.Characters
+
 
+
digit(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digit(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digitMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for digits.
+
+
digitShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
dimap(F<A, B>, F<C, A>, F<B, D>) - Static method in class fj.F1Functions
+
+
Both map (with g) and contramap (with f) the target function.
+
+
discard() - Static method in class fj.control.parallel.Strategy
+
+
Returns an Effect that waits for a given Future to obtain a value, discarding the value.
+
+
disjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ORs booleans.
+
+
disjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ORs booleans.
+
+
divide - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first.
+
+
divide(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another.
+
+
divmod - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first, yielding both the quotient and the remainder.
+
+
divmod(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another yielding both the quotient and the remainder.
+
+
DList<A> - Class in fj.data
+
+
Difference List.
+
+
dlist(F<List<A>, Trampoline<List<A>>>) - Static method in class fj.data.DList
+
+
Creates a DList from the function + + For alternatives functions to create a DList:
+
+
done(A, Iteratee.Input<E>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that has finished
+
+
Double_Boolean - Static variable in class fj.Primitive
+
+
A function that converts doubles to booleans.
+
+
Double_Byte - Static variable in class fj.Primitive
+
+
A function that converts doubles to bytes.
+
+
Double_Character - Static variable in class fj.Primitive
+
+
A function that converts doubles to characters.
+
+
Double_Float - Static variable in class fj.Primitive
+
+
A function that converts doubles to floats.
+
+
Double_Integer - Static variable in class fj.Primitive
+
+
A function that converts doubles to integers.
+
+
Double_Long - Static variable in class fj.Primitive
+
+
A function that converts doubles to longs.
+
+
Double_Short - Static variable in class fj.Primitive
+
+
A function that converts doubles to shorts.
+
+
doubleAdditionMonoid - Static variable in class fj.Monoid
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleAdditionSemigroup - Static variable in class fj.Semigroup
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for double.
+
+
doubleEqual - Static variable in class fj.Equal
+
+
An equal instance for the double type.
+
+
doubleHash - Static variable in class fj.Hash
+
+
A hash instance for the double type.
+
+
doubleMultiplicationMonoid - Static variable in class fj.Monoid
+
+
Deprecated. +
Since 4.7. Due to rounding errors, multiplication of doubles does not comply with monoid laws
+
+
+
doubleMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleOrd - Static variable in class fj.Ord
+
+
An order instance for the double type.
+
+
Doubles - Class in fj.function
+
+
Curried functions over Doubles.
+
+
doubleShow - Static variable in class fj.Show
+
+
A show instance for the double type.
+
+
doubleValue() - Method in class fj.data.Natural
+
+
Return the double value of this natural number.
+
+
draw(Show<A>) - Method in class fj.data.Tree
+
+
Draws a 2-dimensional representation of a tree.
+
+
driverManager(String) - Static method in class fj.control.db.DbState
+
+
A simple connector (the default) that gets connections to the given database URL from the driver manager.
+
+
drop(int) - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that skips the first n elements of the input
+
+
drop(int) - Method in class fj.data.List
+
+
Drops the given number of elements from the head of this list if they are available.
+
+
drop(int) - Method in class fj.data.Seq
+
+
Drops the given number of elements from the head of this sequence if they are available.
+
+
drop(int) - Method in class fj.data.Stream
+
+
Drops the given number of elements from the head of this stream if they are available.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
+
+
dual() - Method in interface fj.Monoid.Definition
+
 
+
dual() - Method in class fj.Monoid
+
+
Swaps the arguments when summing.
+
+
dual() - Method in interface fj.Ord.Definition
+
 
+
dual() - Method in interface fj.Semigroup.Definition
+
 
+
dual() - Method in class fj.Semigroup
+
+
Swaps the arguments when summing.
+
+
duplicate() - Method in class fj.P2
+
+
Duplicates this product into the first element (Comonad pattern).
+
+
+ + + +

E

+
+
effect(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
+
+
effect() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
+
+
Effect - Class in fj
+
+
Represents a side-effect.
+
+
Effect0 - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect0_P1() - Static method in class fj.data.Conversions
+
 
+
Effect0_P1(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect1<A> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect1_F(Effect1<A>) - Static method in class fj.data.Conversions
+
 
+
Effect1_F() - Static method in class fj.data.Conversions
+
 
+
Effect2<A,B> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect3<A,B,C> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect4<A,B,C,D> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect5<A,B,C,D,E> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect6<A,B,C,D,E,F> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect7<A,B,C,D,E,F,G> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect8<A,B,C,D,E,F,G,H> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect_IO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_IO() - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO() - Static method in class fj.data.Conversions
+
 
+
either(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into either an exception or the value in the Callable.
+
+
either() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an Either.
+
+
Either<A,B> - Class in fj.data
+
+
The Either type represents a value of one of two possible types (a disjoint union).
+
+
either(F<A, X>, F<B, X>) - Method in class fj.data.Either
+
+
The catamorphism for either.
+
+
either() - Method in class fj.data.Either.LeftProjection
+
+
The either value underlying this projection.
+
+
either() - Method in class fj.data.Either.RightProjection
+
+
The either value underlying this projection.
+
+
either() - Static method in class fj.data.Validation
+
+
Returns a function that constructs an either with a validation.
+
+
Either.LeftProjection<A,B> - Class in fj.data
+
+
A left projection of an either value.
+
+
Either.RightProjection<A,B> - Class in fj.data
+
+
A right projection of an either value.
+
+
either_(F<A, X>, F<B, X>) - Static method in class fj.data.Either
+
+
First class catamorphism for either.
+
+
Either_ArrayA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayBlockingQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayBlockingQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_ArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_BitSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_BitSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_ConcurrentLinkedQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_ConcurrentLinkedQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_CopyOnWriteArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArraySetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_CopyOnWriteArraySetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_DelayQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_DelayQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_EnumSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_EnumSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_HashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_HashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_LinkedBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedHashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedHashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_LinkedListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_ListA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_ListB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_OptionA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_OptionB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_PriorityBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_PriorityBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_StackA() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StackB() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StreamA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StreamB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StringA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringBufferA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBufferB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBuilderA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_StringBuilderB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_SynchronousQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_SynchronousQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_TreeSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_TreeSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_VectorA() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
Either_VectorB() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
eitherEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Either type.
+
+
eitherHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Either type.
+
+
eitherLeftK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the left side of an Either.
+
+
eitherLeftK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the left side of an Either.
+
+
eitherOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Either type.
+
+
eitherRightK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the right side of an Either.
+
+
eitherRightK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the right side of an Either.
+
+
eitherShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Either type.
+
+
el(E) - Static method in class fj.data.Iteratee.Input
+
+
Input that has a value available
+
+
element(F0<E>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
element(E) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
elementIndex(Equal<A>, A) - Method in class fj.data.List
+
+
Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
+
+
eMessage() - Static method in class fj.Bottom
+
+
A function that returns the getMessage for a throwable.
+
+
empty() - Static method in class fj.data.Array
+
+
Returns an empty array.
+
+
Empty<V,A> - Class in fj.data.fingertrees
+
+
The empty tree.
+
+
empty(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Creates an empty finger tree with elements of type A and node annotations + of type V.
+
+
empty() - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs an empty tree.
+
+
EMPTY - Static variable in class fj.data.hamt.BitSet
+
 
+
empty() - Static method in class fj.data.hamt.BitSet
+
 
+
empty(Equal<K>, Hash<K>) - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Creates an empty trie.
+
+
empty(Equal<A>, Hash<A>) - Static method in class fj.data.HashSet
+
+
Creates a new HashSet using the given Equal and Hash
+
+
empty() - Static method in class fj.data.HashSet
+
+
Creates an empty HashSet
+
+
empty() - Static method in class fj.data.Iteratee.Input
+
+
Input that has no values available
+
+
empty - Static variable in class fj.data.LazyString
+
+
The empty string.
+
+
empty() - Static method in class fj.data.List.Buffer
+
+
An empty buffer.
+
+
empty(Monoid<K>, Equal<K>) - Static method in class fj.data.PriorityQueue
+
+
Creates an empty priority queue.
+
+
empty() - Static method in class fj.data.Seq
+
+
The empty sequence.
+
+
empty(Ord<A>) - Static method in class fj.data.Set
+
+
The empty set.
+
+
empty(Ord<K>) - Static method in class fj.data.TreeMap
+
+
Constructs an empty tree map.
+
+
empty() - Method in interface fj.Monoid.Definition
+
 
+
emptyInt() - Static method in class fj.data.PriorityQueue
+
+
An empty priority queue with integer priorities.
+
+
emptyIntAddition() - Static method in class fj.data.fingertrees.FingerTree
+
 
+
emptyIntMax() - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a finger tree which combines the integer node annotations with the + maximum function.
+
+
emptyKeyInteger() - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Create and empty trie keyed by integer.
+
+
endsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a suffix of this lazy string.
+
+
enqueue(K, A) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enqueue(List<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the list of products with priority k and value a.
+
+
enqueue(Iterable<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the iterable of products with priority k and value a.
+
+
enqueue(P2<K, A>) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enumerationStream(Enumeration<A>) - Static method in class fj.data.Stream
+
 
+
Enumerator<A> - Class in fj.data
+
+
Abstracts over a type that may have a successor and/or predecessor value.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>, F<A, F<Long, Option<A>>>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumFileCharChunks(File, Option<Charset>, Iteratee.IterV<char[], A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes them to the given iteratee.
+
+
enumFileChars(File, Option<Charset>, Iteratee.IterV<Character, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
+
+
enumFileLines(File, Option<Charset>, Iteratee.IterV<String, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads lines from the given file (using a BufferedReader) and passes + lines to the provided iteratee.
+
+
EnumSet_List() - Static method in class fj.data.Java
+
+
A function that converts enum sets to lists.
+
+
eof() - Static method in class fj.data.Iteratee.Input
+
+
Input that is exhausted
+
+
eq(K, K) - Method in class fj.data.HashMap
+
+
Compare two key values for equality using the underlying equality strategy.
+
+
eq(A, A) - Method in class fj.data.HashSet
+
+
Compare two values for equality using the underlying equality strategy.
+
+
eq(HPre.HZero, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is equal to itself.
+
+
eq(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HSucc<NN>, E) - Static method in class fj.data.hlist.HPre.HEq
+
+
A number is equal to another if their predecessors are equal.
+
+
eq(Equal<A>) - Static method in class fj.data.TreeZipper
+
+
An Equal instance for tree zippers.
+
+
eq(Equal<A>) - Static method in class fj.data.Zipper
+
+
An Equal instance for Zippers.
+
+
eq - Static variable in class fj.Equal
+
+
An equal instance for lazy strings.
+
+
eq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are equal, false otherwise.
+
+
eq() - Method in class fj.Equal
+
+
First-class equality check.
+
+
eq(A) - Method in class fj.Equal
+
+
Partially applied equality check.
+
+
eq(A, A) - Method in class fj.Ord
+
+
Returns true if the given arguments are equal, false otherwise.
+
+
Equal<A> - Class in fj
+
+
Tests for equality between two objects.
+
+
equal(A, A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.Definition
+
 
+
equal(A, A) - Method in interface fj.Equal.Definition
+
 
+
equal() - Method in interface fj.Equal.Definition
+
+
Build an equal instance from this definition.
+
+
equal(F<A, F<A, Boolean>>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(F2<A, A, Boolean>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(A, A) - Method in interface fj.Ord.Definition
+
 
+
equal(A) - Method in interface fj.Ord.Definition
+
 
+
equal() - Method in class fj.Ord
+
+
Returns an Equal for this order.
+
+
Equal.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Equal: alternative minimal definition and overridable methods.
+
+
Equal.Definition<A> - Interface in fj
+
+
Primitives functions of Equal: minimal definition and overridable methods.
+
+
equalDef(Equal.Definition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given definition.
+
+
equalDef(Equal.AltDefinition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given (alternative) definition.
+
+
equals(Object) - Method in class fj.data.Array
+
 
+
equals(Object) - Method in class fj.data.Either
+
 
+
equals(Object) - Method in class fj.data.hamt.BitSet
+
 
+
equals(Object) - Method in class fj.data.List
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Natural
+
 
+
equals(Object) - Method in class fj.data.NonEmptyList
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Option
+
 
+
equals(Object) - Method in class fj.data.Seq
+
 
+
equals(Object) - Method in class fj.data.Set
+
 
+
equals(Object) - Method in class fj.data.Stream
+
 
+
equals(Object) - Method in class fj.data.Tree
+
 
+
equals(Object) - Method in class fj.data.TreeMap
+
 
+
equals(Object) - Method in class fj.data.TreeZipper
+
 
+
equals(Object) - Method in class fj.data.Validation
+
 
+
equals(Object) - Method in class fj.data.vector.V2
+
 
+
equals(Object) - Method in class fj.data.vector.V3
+
 
+
equals(Object) - Method in class fj.data.vector.V4
+
 
+
equals(Object) - Method in class fj.data.vector.V5
+
 
+
equals(Object) - Method in class fj.data.vector.V6
+
 
+
equals(Object) - Method in class fj.data.vector.V7
+
 
+
equals(Object) - Method in class fj.data.vector.V8
+
 
+
equals(Object) - Method in class fj.data.Zipper
+
 
+
equals(Object) - Method in class fj.P1
+
 
+
equals(Object) - Method in class fj.P2
+
 
+
equals(Object) - Method in class fj.P3
+
 
+
equals(Object) - Method in class fj.P4
+
 
+
equals(Object) - Method in class fj.P5
+
 
+
equals(Object) - Method in class fj.P6
+
 
+
equals(Object) - Method in class fj.P7
+
 
+
equals(Object) - Method in class fj.P8
+
 
+
equals(Object) - Method in class fj.parser.Result
+
 
+
equals0(Class<? super A>, A, Object, Equal<A>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
equals0(Class<? super A>, A, Object, F0<Equal<A>>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
error(String) - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation with early failure using the given + message.
+
+
error_(String) - Static method in class fj.Bottom
+
+
Provides a thunk that throws an error using the given message when evaluated.
+
+
errorF(String) - Static method in class fj.Bottom
+
+
Provides a function that throws an error using the given message, ignoring its argument.
+
+
errorStrategy(Effect1<Error>) - Method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
errorStrategy(Strategy<A>, Effect1<Error>) - Static method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
eToString() - Static method in class fj.Bottom
+
+
A function that returns the toString for a throwable.
+
+
Eval<A> - Class in fj.data
+
+
Eval is an abstraction over different models of evaluation.
+
+
Eval() - Constructor for class fj.data.Eval
+
 
+
eval() - Method in class fj.data.LazyString
+
 
+
eval(S) - Method in class fj.data.State
+
 
+
even - Static variable in class fj.function.Doubles
+
+
Evenness.
+
+
even - Static variable in class fj.function.Integers
+
+
Evenness.
+
+
exclusiveDisjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that XORs booleans.
+
+
exclusiveDisjunctionSemiGroup - Static variable in class fj.Semigroup
+
+
A semigroup that XORs booleans.
+
+
exec(S) - Method in class fj.data.State
+
 
+
executorStrategy(ExecutorService) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if at least one target satisfies the predicate
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if at least one target satisfies the predicate
+
+
exists(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
+
+
exists(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
+
+
exists(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns false if this is a failure or returns the result of the application of the given + function to the success value.
+
+
exists(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns false if this is a success or returns the result of the application of the given + function to the failing value.
+
+
extend(E) - Method in class fj.data.hlist.HList
+
+
Extends (cons) this list by prepending the given element, returning a new list.
+
+
extend(X) - Method in class fj.data.hlist.HList.HCons
+
 
+
extend(E) - Method in class fj.data.hlist.HList.HNil
+
 
+
extender() - Method in class fj.data.hlist.HList
+
 
+
extender() - Method in class fj.data.hlist.HList.HCons
+
 
+
extender() - Method in class fj.data.hlist.HList.HNil
+
 
+
+ + + +

F

+
+
f() - Method in class fj.control.parallel.Strategy
+
+
Returns the functional representation of this Strategy, a function that evaluates a product-1.
+
+
f() - Static method in class fj.data.hlist.HList.Apply
+
+
Function application operator.
+
+
f(A) - Method in class fj.data.Reader
+
 
+
f() - Method in class fj.data.Validation
+
+
Returns a failing projection of this validation.
+
+
f(Effect0) - Static method in class fj.Effect
+
 
+
f(Effect1<A>) - Static method in class fj.Effect
+
+
Returns a function for the given effect.
+
+
f(Effect2<A, B>) - Static method in class fj.Effect
+
 
+
f(Effect3<A, B, C>) - Static method in class fj.Effect
+
 
+
f(Effect4<A, B, C, D>) - Static method in class fj.Effect
+
 
+
f(Effect5<A, B, C, D, E>) - Static method in class fj.Effect
+
 
+
f(Effect6<A, B, C, D, E, $F>) - Static method in class fj.Effect
+
 
+
f(Effect7<A, B, C, D, E, $F, G>) - Static method in class fj.Effect
+
 
+
f(Effect8<A, B, C, D, E, $F, G, H>) - Static method in class fj.Effect
+
 
+
F<A,B> - Interface in fj
+
+
A transformation or function from A to B.
+
+
f(A) - Method in interface fj.F
+
+
Transform A to B.
+
+
f() - Method in interface fj.F0
+
 
+
f(F<A, B>, A) - Static method in class fj.F1Functions
+
+
Partial application.
+
+
f(A) - Method in class fj.F1W.F1WFunc
+
 
+
f(A, B) - Method in interface fj.F2
+
+
Transform A and B to C.
+
+
f(F2<A, B, C>, A) - Static method in class fj.F2Functions
+
+
Partial application.
+
+
f(A) - Method in class fj.F2W
+
+
Partial application.
+
+
f(A, B) - Method in class fj.F2W.F2WFunc
+
 
+
f(A, B, C) - Method in interface fj.F3
+
+
Transform A, B and C to D.
+
+
f(F3<A, B, C, D>, A) - Static method in class fj.F3Functions
+
+
Partial application.
+
+
f(A, B, C, D) - Method in interface fj.F4
+
+
Transform A, B, C and D to E.
+
+
f(F4<A, B, C, D, E>, A) - Static method in class fj.F4Functions
+
+
Partial application.
+
+
f(A, B, C, D, E) - Method in interface fj.F5
+
+
Transform A, B, C, D and E to + F$.
+
+
f(F5<A, B, C, D, E, F$>, A) - Static method in class fj.F5Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$) - Method in interface fj.F6
+
+
Transform A, B, C, D, E and + F$ to G.
+
+
f(F6<A, B, C, D, E, F$, G>, A) - Static method in class fj.F6Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$, G) - Method in interface fj.F7
+
+
Transform A, B, C, D, E, + F$ and G to H.
+
+
f(F7<A, B, C, D, E, F$, G, H>, A) - Static method in class fj.F7Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$, G, H) - Method in interface fj.F8
+
+
Transform A, B, C, D, E, + F$, G and H to I.
+
+
f(F8<A, B, C, D, E, F$, G, H, I>, A) - Static method in class fj.F8Functions
+
+
Partial application.
+
+
f() - Method in interface fj.function.Effect0
+
 
+
f(A) - Method in interface fj.function.Effect1
+
 
+
f(A, B) - Method in interface fj.function.Effect2
+
 
+
f(A, B, C) - Method in interface fj.function.Effect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Effect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Effect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Effect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Effect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Effect8
+
 
+
f() - Method in interface fj.function.Try0
+
 
+
f(A) - Method in interface fj.function.Try1
+
 
+
f(A, B) - Method in interface fj.function.Try2
+
 
+
f(A, B, C) - Method in interface fj.function.Try3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Try4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Try5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Try6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Try7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Try8
+
 
+
f() - Method in interface fj.function.TryEffect0
+
 
+
f(A) - Method in interface fj.function.TryEffect1
+
 
+
f(A, B) - Method in interface fj.function.TryEffect2
+
 
+
f(A, B, C) - Method in interface fj.function.TryEffect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.TryEffect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.TryEffect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.TryEffect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.TryEffect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.TryEffect8
+
 
+
f() - Method in class fj.P1
+
 
+
f(Try0<A, E>) - Static method in class fj.Try
+
+
Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try1<A, B, E>) - Static method in class fj.Try
+
+
Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try2<A, B, C, E>) - Static method in class fj.Try
+
+
Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try3<A, B, C, D, E>) - Static method in class fj.Try
+
+
Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try4<A, B, C, D, E, Z>) - Static method in class fj.Try
+
+
Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try5<A, B, C, D, E, F, Z>) - Static method in class fj.Try
+
+
Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try6<A, B, C, D, E, F, G, Z>) - Static method in class fj.Try
+
+
Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try7<A, B, C, D, E, F, G, H, Z>) - Static method in class fj.Try
+
+
Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try8<A, B, C, D, E, F, G, H, I, Z>) - Static method in class fj.Try
+
+
Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(TryEffect0<Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect1<A, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect2<A, B, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect3<A, B, C, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect4<A, B, C, D, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect5<A, B, C, D, E, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect6<A, B, C, D, E, $F, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect7<A, B, C, D, E, $F, G, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect8<A, B, C, D, E, $F, G, H, Z>) - Static method in class fj.TryEffect
+
 
+
F0<A> - Interface in fj
+
+
Created by MarkPerry on 21/01/2015.
+
+
F1Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F1W<A,B> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F1W() - Constructor for class fj.F1W
+
 
+
F1W.F1WFunc<A,B> - Class in fj
+
 
+
F1WFunc(F<A, B>) - Constructor for class fj.F1W.F1WFunc
+
 
+
F2<A,B,C> - Interface in fj
+
+
A transformation function of arity-2 from A and B to C.
+
+
F2Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F2W<A,B,C> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F2W() - Constructor for class fj.F2W
+
 
+
F2W.F2WFunc<A,B,C> - Class in fj
+
 
+
F2WFunc(F2<A, B, C>) - Constructor for class fj.F2W.F2WFunc
+
 
+
F3<A,B,C,D> - Interface in fj
+
+
A transformation function of arity-3 from A, B and C to + D.
+
+
F3Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F3W<A,B,C,D> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F3W() - Constructor for class fj.F3W
+
 
+
F4<A,B,C,D,E> - Interface in fj
+
+
A transformation function of arity-4 from A, B, C and + D to E.
+
+
F4Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F4W<A,B,C,D,E> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F4W() - Constructor for class fj.F4W
+
 
+
F5<A,B,C,D,E,F$> - Interface in fj
+
+
A transformation function of arity-5 from A, B, C, + D and E to F$.
+
+
F5Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F5W<A,B,C,D,E,$F> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F5W() - Constructor for class fj.F5W
+
 
+
F6<A,B,C,D,E,F$,G> - Interface in fj
+
+
A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
+
+
F6Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F6W<A,B,C,D,E,$F,G> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F6W() - Constructor for class fj.F6W
+
 
+
F7<A,B,C,D,E,F$,G,H> - Interface in fj
+
+
A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
+
+
F7Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F7W<A,B,C,D,E,$F,G,H> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F7W() - Constructor for class fj.F7W
+
 
+
F8<A,B,C,D,E,F$,G,H,I> - Interface in fj
+
+
A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
+
+
F8Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F8W<A,B,C,D,E,$F,G,H,I> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F8W() - Constructor for class fj.F8W
+
 
+
F_SafeIO(F<Unit, A>) - Static method in class fj.data.Conversions
+
 
+
F_SafeIO() - Static method in class fj.data.Conversions
+
 
+
fail() - Method in class fj.data.Validation
+
+
Returns the failing value, or throws an error if there is no failing value.
+
+
fail(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing the given value.
+
+
fail(E) - Static method in class fj.parser.Parser
+
+
Returns a parser that always fails with the given error.
+
+
failE(F0<String>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failE(String) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the failure side of a Validation.
+
+
failK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the failure side of a Validation.
+
+
failNEL(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing a non-empty list that contains the given value.
+
+
fails(List<Validation<E, ?>>) - Static method in class fj.data.Validation
+
 
+
FALSE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
fanout(F<B, C>, F<B, D>, B) - Static method in class fj.P2
+
+
Sends the given input value to both argument functions and combines their output.
+
+
fileReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Array
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Array.ImmutableProjection
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
+
+
filter(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
+
+
filter(F<A, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Option
+
+
Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Seq
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Set
+
+
Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
+
+
filter() - Static method in class fj.data.Stream
+
+
Returns a first-class version of the filter function.
+
+
filter(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
+
+
filter(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
+
+
filter(F<A, Boolean>, E) - Method in class fj.parser.Parser
+
+
Returns a parser that fails with the given error if the result value does not meet the given predicate.
+
+
filterKeys(F<K, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters the nodes based on the annotation of each node.
+
+
filterValues(F<A, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters nodes based on the value inside each node.
+
+
find(F<A, Boolean>) - Method in class fj.data.Array
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(K) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k.
+
+
find(K, int, int) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
+
+
find(F<A, Boolean>) - Method in class fj.data.List
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
find the first target of a Fold matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
find the first target of a PTraversal matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.Zipper
+
+
Moves the focus to the element matching the given predicate, if present.
+
+
findChild(F<Tree<A>, Boolean>) - Method in class fj.data.TreeZipper
+
+
Navigates to the first child of the current location, that satisfies the given predicate.
+
+
findChild() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the findChild function.
+
+
findFirst(List<Option<X>>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first value available in the given list of optional values.
+
+
FingerTree<V,A> - Class in fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fingerTreeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
first() - Method in class fj.data.optic.Getter
+
 
+
first() - Method in class fj.data.optic.Iso
+
 
+
first() - Method in class fj.data.optic.Optional
+
 
+
first() - Method in class fj.data.optic.PIso
+
 
+
first() - Method in class fj.data.optic.POptional
+
 
+
firstChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the first child of the current location.
+
+
firstOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the first available value.
+
+
firstOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the first available value.
+
+
firstSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "first" (left-hand side) value.
+
+
fj - package fj
+
+
Types that set the premise for the existence of Functional Java.
+
+
fj.control - package fj.control
+
+
Functional control abstractions.
+
+
fj.control.db - package fj.control.db
+
+
Abstractions for JDBC connections.
+
+
fj.control.parallel - package fj.control.parallel
+
+
Parallelization strategies.
+
+
fj.data - package fj.data
+
+
Common algebraic data types.
+
+
fj.data.fingertrees - package fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fj.data.hamt - package fj.data.hamt
+
 
+
fj.data.hlist - package fj.data.hlist
+
+
Type-safe, extensible, heterogeneous lists
+
+
fj.data.optic - package fj.data.optic
+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+
fj.data.vector - package fj.data.vector
+
+
Fixed-length vectors
+
+
fj.function - package fj.function
+
+
A prelude of commonly used first-class functions
+
+
fj.parser - package fj.parser
+
+
Parser combinators.
+
+
flatMap(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Alias for Eval.bind(F).
+
+
flatMap(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
flatMap(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
flatMap(State<S, A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
 
+
flatMap(F<A, State<S, B>>) - Method in class fj.data.State
+
 
+
flatMap(F<A, Writer<W, B>>) - Method in class fj.data.Writer
+
 
+
flatten() - Method in class fj.data.Tree
+
+
Puts the elements of the tree into a Stream, in pre-order.
+
+
flatten_() - Static method in class fj.data.Tree
+
+
flatten :: Tree a -> [a] + flatten t = squish t [] + where squish (Node x ts) xs = x:Prelude.foldr squish xs ts + Puts the elements of the tree into a Stream, in pre-order.
+
+
flip(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Flips the arguments of this function.
+
+
flip() - Method in class fj.F2W
+
+
Flips the arguments of this function.
+
+
flip() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F2<A, B, C>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip2() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
Float_Boolean - Static variable in class fj.Primitive
+
+
A function that converts floats to booleans.
+
+
Float_Byte - Static variable in class fj.Primitive
+
+
A function that converts floats to bytes.
+
+
Float_Character - Static variable in class fj.Primitive
+
+
A function that converts floats to characters.
+
+
Float_Double - Static variable in class fj.Primitive
+
+
A function that converts floats to doubles.
+
+
Float_Integer - Static variable in class fj.Primitive
+
+
A function that converts floats to integers.
+
+
Float_Long - Static variable in class fj.Primitive
+
+
A function that converts floats to longs.
+
+
Float_Short - Static variable in class fj.Primitive
+
+
A function that converts floats to shorts.
+
+
floatEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for float.
+
+
floatEqual - Static variable in class fj.Equal
+
+
An equal instance for the float type.
+
+
floatHash - Static variable in class fj.Hash
+
+
A hash instance for the float type.
+
+
floatOrd - Static variable in class fj.Ord
+
+
An order instance for the float type.
+
+
floatShow - Static variable in class fj.Show
+
+
A show instance for the float type.
+
+
floatValue() - Method in class fj.data.Natural
+
+
Return the float value of this natural number.
+
+
fmap(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Lifts any function to a function on Callables.
+
+
fmap(F<A, B>) - Method in class fj.control.parallel.Promise
+
+
Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
+
+
fmap(F<A, B>) - Method in class fj.data.Tree
+
+
Maps the given function over this tree.
+
+
fmap(F<A, B>) - Static method in class fj.P1
+
+
Deprecated. +
As of release 4.5, use P1.map_(fj.F<A, B>)
+
+
+
fmap_(F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Promotes any function to a transformation between promises (covariant functor pattern).
+
+
fmap_() - Static method in class fj.data.Tree
+
+
Provides a transformation to lift any function so that it maps over Trees.
+
+
focus() - Method in class fj.data.TreeZipper
+
+
Returns the tree at the currently focused node.
+
+
focus() - Method in class fj.data.Zipper
+
+
Returns the focus element of this zipper.
+
+
fold(F<Trampoline.Normal<A>, R>, F<Trampoline.Codense<A>, R>) - Method in class fj.control.Trampoline
+
 
+
fold(F<P2<A, Iteratee.Input<E>>, Z>, F<F<Iteratee.Input<E>, Iteratee.IterV<E, A>>, Z>) - Method in class fj.data.Iteratee.IterV
+
 
+
Fold<S,A> - Class in fj.data.optic
+
+
A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
+
+
Fold() - Constructor for class fj.data.optic.Fold
+
 
+
fold(Monoid<A>) - Method in class fj.data.optic.Fold
+
+
combine all targets using a target's Monoid
+
+
fold(Monoid<A>) - Method in class fj.data.optic.PTraversal
+
+
combine all targets using a target's Monoid
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the left using the given function and the given initial value.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function and the given initial element.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldLeft(F2<A, Boolean, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldLeft(F2<B, P2<K, V>, B>, F2<B, HashArrayMappedTrie<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F2<B, P2<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a left fold.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft() - Static method in class fj.data.List
+
+
Provides a first-class version of foldLeft.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Seq
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft_(F<B, F<A, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldLeftOnNode(F2<B, Node<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Fold
+
+
map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.PTraversal
+
+
map each target to a Monoid and combine the results
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Traversal
+
 
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set using the given monoid.
+
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Tree
+
+
Folds this tree using the given monoid.
+
+
foldMap_(F<A, B>, Monoid<B>) - Static method in class fj.data.Tree
+
+
Provides a function that folds a tree with the given monoid.
+
+
foldMapRight(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set from the right using the given monoid.
+
+
foldMapTree(F<A, B>, Monoid<B>) - Static method in class fj.F1Functions
+
+
Returns a function that maps this function over a tree and folds it with the given monoid.
+
+
foldMapTree(Monoid<B>) - Method in class fj.F1W
+
+
Returns a function that maps this function over a tree and folds it with the given monoid.
+
+
foldRight(Strategy<Unit>, F<A, F<B, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a list in constant stack space.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function and the given initial value.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function and the given initial element.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldRight(F2<Boolean, A, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldRight(G, V, L) - Method in class fj.data.hlist.HList.HFoldr
+
+
Folds a non-empty heterogeneous list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a right fold.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Seq
+
 
+
foldRight(F<A, F<P1<B>, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight(F2<A, P1<B>, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight() - Static method in class fj.data.Stream
+
+
A first-class version of the foldRight function.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Zipper
+
+
Performs a right-fold reduction across this zipper.
+
+
foldRight1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F<A, F<B, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight1(F2<A, B, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight_(F<A, F<B, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldRightC(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list in O(1) stack space.
+
+
foldRightS(Strategy<Unit>, F<A, F<P1<B>, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a Stream in constant stack space.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
+
+
forall(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns true if this is a success or returns the result of the application of the given + function to the failing value.
+
+
forall(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns true if this is a failure or returns the result of the application of the given + function to the success value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<B, Unit>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<P2<K, V>, Unit>) - Method in class fj.data.HashMap
+
 
+
foreach(F<A, Unit>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreach(F<E, Unit>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreach(F<T, Unit>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<B>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<P2<K, V>>) - Method in class fj.data.HashMap
+
 
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreachDoEffect(Effect1<E>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreachDoEffect(Effect1<T>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
forever(Enumerator<A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
+
+
forever(Enumerator<A>, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
+
+
Four<V,A> - Class in fj.data.fingertrees
+
+
A four-element prefix or suffix of a finger tree.
+
+
four(A, A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of four elements.
+
+
from(Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Deprecated. +
As of release 4.5, use HashMap.iterableHashMap(Iterable)
+
+
+
from(Iterable<P2<K, V>>, Equal<K>, Hash<K>) - Static method in class fj.data.HashMap
+
+
Deprecated. +
As of release 4.5, use HashMap.iterableHashMap(fj.Equal<K>, fj.Hash<K>, java.lang.Iterable<fj.P2<K, V>>)
+
+
+
fromBigInt - Static variable in class fj.data.Natural
+
+
A function that returns the natural number equal to a given BigInteger
+
+
fromChar - Static variable in enum fj.Digit
+
+
First-class conversion from a character to a digit.
+
+
fromChar(char) - Static method in enum fj.Digit
+
+
Converts the given character in the given long value to a digit.
+
+
fromEither(F0<Either<Exception, A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a given Either value into the equivalent Callable.
+
+
fromEither() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an Either to a Callable.
+
+
fromF(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
fromForest(Stream<Tree<A>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the first element of the given forest.
+
+
fromFunction(F<Natural, A>) - Static method in class fj.data.Stream
+
+
Converts a function of natural numbers to a stream.
+
+
fromFunction(Enumerator<B>, F<B, A>, B) - Static method in class fj.data.Stream
+
+
Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
+
+
fromInt(int) - Static method in enum fj.Ordering
+
 
+
fromIterator(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
fromJavaList(List<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.List.Buffer
+
+
Constructs a buffer from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.NonEmptyList
+
+
Returns a potential non-empty list from the given list.
+
+
fromList(Ord<A>, List<A>) - Static method in class fj.data.Set
+
+
Deprecated. +
As of release 4.5, use Set.iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
+
+
+
fromLong - Static variable in enum fj.Digit
+
+
First-class conversion from a long to a digit.
+
+
fromLong(long) - Static method in enum fj.Digit
+
+
Converts the right-most digit in the given long value to a digit.
+
+
fromMap(Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMap(Equal<K>, Hash<K>, Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMutableMap(Ord<K>, Map<K, V>) - Static method in class fj.data.TreeMap
+
+
An immutable projection of the given mutable map.
+
+
fromNull(T) - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromNull() - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromOption(F0<Option<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns an optional value into a Callable.
+
+
fromOption() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an optional value to a Callable
+
+
fromSet(Set<A>) - Static method in class fj.data.HashSet
+
 
+
fromSome() - Static method in class fj.data.Option
+
+
Returns a function that takes an optional value to a value or errors if there is no value.
+
+
fromStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from character streams to lazy strings.
+
+
fromStream(Stream<Character>) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a stream of characters.
+
+
fromStream(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromStreamEnd(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromString(String) - Static method in class fj.data.List
+
+
Returns a list of characters from the given string.
+
+
fromString() - Static method in class fj.data.List
+
+
A first-class fromString.
+
+
fromString(String) - Static method in class fj.data.Option
+
+
Returns an optional non-empty string, or no value if the given string is empty.
+
+
fromString() - Static method in class fj.data.Option
+
+
Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
+
+
fromString(String) - Static method in class fj.data.Stream
+
+
Returns a stream of characters from the given string.
+
+
fromString() - Static method in class fj.function.Doubles
+
+
A function that converts strings to doubles.
+
+
fromString() - Static method in class fj.function.Integers
+
+
A function that converts strings to integers.
+
+
fromTree(Tree<A>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the root of the given tree.
+
+
fromTree() - Static method in class fj.data.TreeZipper
+
+
First-class conversion of a Tree to the corresponding tree zipper.
+
+
fromTry(Try0<A, ? extends IOException>) - Static method in class fj.data.IOFunctions
+
 
+
Function - Class in fj
+
+
Transformations on functions.
+
+
functionMonoid(Monoid<B>) - Static method in class fj.Monoid
+
+
A monoid for functions.
+
+
functionSemigroup(Semigroup<B>) - Static method in class fj.Semigroup
+
+
A semigroup for functions.
+
+
Future_P1() - Static method in class fj.data.Java
+
 
+
+ + + +

G

+
+
get(int) - Method in class fj.data.Array
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(int) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(K) - Method in class fj.data.HashMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.HashMap
+
+
A curried version of HashMap.get(Object).
+
+
get(S) - Method in class fj.data.optic.Getter
+
+
get the target of a Getter
+
+
get(S) - Method in class fj.data.optic.Iso
+
 
+
get(S) - Method in class fj.data.optic.Lens
+
 
+
get(S) - Method in class fj.data.optic.PIso
+
+
get the target of a PIso
+
+
get(S) - Method in class fj.data.optic.PLens
+
+
get the target of a PLens
+
+
get(K) - Method in class fj.data.TreeMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.TreeMap
+
+
Returns a first-class version of the get method for this TreeMap.
+
+
getAll(S) - Method in class fj.data.optic.Fold
+
+
get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
+
+
getAll(S) - Method in class fj.data.optic.PTraversal
+
+
get all the targets of a PTraversal
+
+
getBitSet() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
getChild(int) - Method in class fj.data.TreeZipper
+
+
Navigates to the given child of the current location, starting at index 0.
+
+
getContents() - Static method in class fj.data.IOFunctions
+
 
+
getContents() - Static method in class fj.data.IOW
+
 
+
getDelete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
+
+
getDirectionality - Static variable in class fj.function.Characters
+
 
+
getFunction() - Method in class fj.data.Reader
+
 
+
getLabel() - Method in class fj.data.TreeZipper
+
+
Returns the label at the current node.
+
+
getNumericValue - Static variable in class fj.function.Characters
+
 
+
getOption(S) - Method in class fj.data.optic.Optional
+
 
+
getOption(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.Prism
+
 
+
getOrModify(S) - Method in class fj.data.optic.Optional
+
 
+
getOrModify(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.Prism
+
 
+
gets(F<S, A>) - Static method in class fj.data.State
+
 
+
gets() - Method in class fj.data.State
+
 
+
getSeed() - Method in class fj.LcgRng
+
 
+
getSeq() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
Getter<S,A> - Class in fj.data.optic
+
+
A Getter can be seen as a glorified get method between a type S and a type A.
+
+
getter(F<S, A>) - Static method in class fj.data.optic.Getter
+
 
+
getType - Static variable in class fj.function.Characters
+
 
+
group(Equal<A>) - Method in class fj.data.List
+
+
Groups elements according to the given equality implementation by longest + sequence of equal elements.
+
+
groupBy(F<A, B>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.7, use List.groupBy(F, Ord)
+
+
+
groupBy(F<A, B>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap.
+
+
groupBy(F<A, B>, F<A, C>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.7, use List.groupBy(F, F, Ord)
+
+
+
groupBy(F<A, B>, F<A, C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, Monoid<C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, D, F2<C, D, D>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
+
+
gteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than or equal to zero.
+
+
gteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than or equal to zero.
+
+
gtZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than zero.
+
+
gtZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than zero.
+
+
+ + + +

H

+
+
hamtNode(HashArrayMappedTrie<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
hamtNodeShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hamtShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hAnd(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hardMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
+
+
hardMemo() - Method in class fj.P1
+
+
Returns a P1 that remembers its value.
+
+
hasChildren() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node has any child nodes.
+
+
hash(K) - Method in class fj.data.HashMap
+
+
Compute the hash of the given key value using the underlying hashing strategy.
+
+
hash(A) - Method in class fj.data.HashSet
+
+
Compute the hash of the given value using the underlying hashing strategy.
+
+
Hash<A> - Class in fj
+
+
Produces a hash code for an object which should attempt uniqueness.
+
+
hash(A) - Method in class fj.Hash
+
+
Compute the hash of the given value.
+
+
hash(F<A, Integer>) - Static method in class fj.Hash
+
+
Construct a hash with the given hash function.
+
+
HashArrayMappedTrie<K,V> - Class in fj.data.hamt
+
+
A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
+
+
hashCode() - Method in class fj.data.Array
+
 
+
hashCode() - Method in class fj.data.Either
+
 
+
hashCode() - Method in class fj.data.List
+
+
Compute the hash code from this list as a function of the hash codes of its members.
+
+
hashCode() - Method in class fj.data.Natural
+
 
+
hashCode() - Method in class fj.data.NonEmptyList
+
 
+
hashCode() - Method in class fj.data.Option
+
 
+
hashCode() - Method in class fj.data.Seq
+
 
+
hashCode() - Method in class fj.data.Set
+
 
+
hashCode() - Method in class fj.data.Stream
+
 
+
hashCode() - Method in class fj.data.Tree
+
 
+
hashCode() - Method in class fj.data.TreeMap
+
 
+
hashCode() - Method in class fj.data.TreeZipper
+
 
+
hashCode() - Method in class fj.data.Validation
+
 
+
hashCode() - Method in class fj.data.vector.V2
+
 
+
hashCode() - Method in class fj.data.vector.V3
+
 
+
hashCode() - Method in class fj.data.vector.V4
+
 
+
hashCode() - Method in class fj.data.vector.V5
+
 
+
hashCode() - Method in class fj.data.vector.V6
+
 
+
hashCode() - Method in class fj.data.vector.V7
+
 
+
hashCode() - Method in class fj.data.vector.V8
+
 
+
hashCode() - Method in class fj.data.Zipper
+
 
+
hashCode() - Method in class fj.P1
+
 
+
hashCode() - Method in class fj.P2
+
 
+
hashCode() - Method in class fj.P3
+
 
+
hashCode() - Method in class fj.P4
+
 
+
hashCode() - Method in class fj.P5
+
 
+
hashCode() - Method in class fj.P6
+
 
+
hashCode() - Method in class fj.P7
+
 
+
hashCode() - Method in class fj.P8
+
 
+
hashCode() - Method in class fj.parser.Result
+
 
+
hashEqualsOrd() - Static method in class fj.Ord
+
+
Deprecated. +
As of release 4.7.
+
+
+
HashMap<K,V> - Class in fj.data
+
+
A mutable hash map providing O(1) lookup.
+
+
HashMap(Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>, Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int, float) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
hashMap() - Static method in class fj.data.HashMap
+
+
Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
+
+
hashMap(Equal<K>, Hash<K>) - Static method in class fj.data.HashMap
+
+
Construct a hash map.
+
+
hashOrd() - Static method in class fj.Ord
+
+
Deprecated. +
As of release 4.7.
+
+
+
HashSet<A> - Class in fj.data
+
+
A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
+
+
HashSet(Equal<A>, Hash<A>) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int, float) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
hashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
hashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
HashSet_List() - Static method in class fj.data.Java
+
+
A function that converts hash sets to lists.
+
+
hCond(HPre.HFalse, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
hCond(HPre.HTrue, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
head() - Method in class fj.data.fingertrees.Deep
+
 
+
head() - Method in class fj.data.fingertrees.Empty
+
 
+
head() - Method in class fj.data.fingertrees.FingerTree
+
+
The first element of this tree.
+
+
head() - Method in class fj.data.fingertrees.Single
+
 
+
head() - Method in class fj.data.hlist.HList.HCons
+
 
+
head() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the head of the input
+
+
head() - Method in class fj.data.LazyString
+
+
Returns the first character of this string.
+
+
head() - Method in class fj.data.List
+
+
The first element of the linked list or fails for the empty list.
+
+
head() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons head.
+
+
head() - Method in class fj.data.NonEmptyList
+
+
The first element of this linked list.
+
+
head() - Method in class fj.data.Seq
+
+
The first element of this sequence.
+
+
head() - Method in class fj.data.Stream
+
+
The first element of the stream or fails for the empty stream.
+
+
head() - Method in class fj.data.vector.V2
+
+
Return the first element of this vector as a product-1.
+
+
head() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector, as a product-1.
+
+
head_() - Static method in class fj.data.List
+
+
First-class head function.
+
+
headOption() - Method in class fj.data.fingertrees.FingerTree
+
 
+
headOption() - Method in class fj.data.List
+
+
Returns the head of the list, if any.
+
+
headOption(S) - Method in class fj.data.optic.Fold
+
+
get the first target of a Fold
+
+
headOption(S) - Method in class fj.data.optic.PTraversal
+
+
get the first target of a PTraversal
+
+
headOption() - Method in class fj.data.Seq
+
 
+
hFalse() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents falsehood.
+
+
hFoldr() - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for the empty list.
+
+
hFoldr(PP, H) - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for a non-empty heterogeneous list
+
+
highSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
highSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
HList<A extends HList<A>> - Class in fj.data.hlist
+
+
Type-safe heterogeneous lists.
+
+
HList.Apply<F$,A,R> - Class in fj.data.hlist
+
+
Type-level function application operators.
+
+
HList.HAppend<A,B,C> - Class in fj.data.hlist
+
+
The concatenation of two heterogeneous lists.
+
+
HList.HCons<E,L extends HList<L>> - Class in fj.data.hlist
+
+
The nonempty list
+
+
HList.HFoldr<G,V,L,R> - Class in fj.data.hlist
+
+
The catamorphism over heterogeneous lists.
+
+
HList.HNil - Class in fj.data.hlist
+
+
The empty list
+
+
hListEqual - Static variable in class fj.Equal
+
+
An equal instance for the empty heterogeneous list.
+
+
hListEqual(Equal<E>, Equal<L>) - Static method in class fj.Equal
+
+
An equal instance for heterogeneous lists.
+
+
HListShow - Static variable in class fj.Show
+
+
A show instance for the empty heterogeneous Stream.
+
+
HListShow(Show<E>, Show<L>) - Static method in class fj.Show
+
+
A show instance for heterogeneous Streams.
+
+
HNat() - Constructor for class fj.data.hlist.HPre.HNat
+
 
+
hOr(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
HPre - Class in fj.data.hlist
+
+
A basic prelude of values lifted into the type system.
+
+
HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>> - Class in fj.data.hlist
+
+
Type-level integer arithmetic
+
+
HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean conjunction.
+
+
HPre.HBool - Class in fj.data.hlist
+
+
A type-level Boolean
+
+
HPre.HCond<T,X,Y,Z> - Class in fj.data.hlist
+
+
A type-level conditional.
+
+
HPre.HEq<X,Y,B extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level equality.
+
+
HPre.HFalse - Class in fj.data.hlist
+
+
Boolean false
+
+
HPre.HNat<A extends HPre.HNat<A>> - Class in fj.data.hlist
+
+
Type-level natural numbers.
+
+
HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean disjunction.
+
+
HPre.HSucc<N extends HPre.HNat<N>> - Class in fj.data.hlist
+
+
A natural number N + 1
+
+
HPre.HTrue - Class in fj.data.hlist
+
+
Boolean true
+
+
HPre.HZero - Class in fj.data.hlist
+
+
Type-level zero
+
+
hPred(HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hSucc(N) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hTrue() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents truth.
+
+
hZero() - Static method in class fj.data.hlist.HPre.HNat
+
 
+
+ + + +

I

+
+
id() - Static method in class fj.data.hlist.HList.Apply
+
+
Identity operator
+
+
id() - Static method in class fj.data.optic.Fold
+
 
+
id() - Static method in class fj.data.optic.Getter
+
 
+
id() - Static method in class fj.data.optic.Iso
+
+
create an Iso between any type and itself.
+
+
id() - Static method in class fj.data.optic.Lens
+
 
+
id() - Static method in class fj.data.optic.Optional
+
 
+
id() - Static method in class fj.data.optic.Prism
+
 
+
id() - Static method in class fj.data.optic.Setter
+
 
+
id() - Static method in class fj.data.optic.Traversal
+
 
+
identifierIgnorable(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identifierIgnorable(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identity() - Static method in class fj.Function
+
+
The identity transformation.
+
+
idStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs no evaluation of its argument.
+
+
if_ - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if" (reverse material implication).
+
+
iff - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if and only if" (biconditional, equivalence).
+
+
ignored() - Static method in class fj.data.optic.Optional
+
 
+
iif(boolean, F0<B>, F0<A>) - Static method in class fj.data.Either
+
+
If the condition satisfies, return the given A in left, otherwise, return the given B in right.
+
+
iif(F<A, Boolean>, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
+
+
iif(boolean, F0<A>) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif(boolean, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif() - Static method in class fj.data.Option
+
+
First-class version of the iif function.
+
+
immutable() - Method in class fj.data.Array
+
 
+
implies - Static variable in class fj.function.Booleans
+
+
Curried form of logical "only if" (material implication).
+
+
index(int) - Method in class fj.data.List
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index(int) - Method in class fj.data.Seq
+
+
Returns the element at the given index.
+
+
index(int) - Method in class fj.data.Stream
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index() - Method in class fj.data.Zipper
+
+
Returns the index of the focus.
+
+
indexOf(char) - Method in class fj.data.LazyString
+
+
Returns the first index of the given character in this lazy string, if present.
+
+
indexOf(LazyString) - Method in class fj.data.LazyString
+
+
Returns the first index of the given substring in this lazy string, if present.
+
+
indexOf(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the position of the first element matching the given predicate, if any.
+
+
inheritance() - Method in class fj.Class
+
+
Returns the inheritance hierarchy of this class.
+
+
init() - Method in class fj.data.fingertrees.Deep
+
 
+
init() - Method in class fj.data.fingertrees.Empty
+
 
+
init() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the last element.
+
+
init() - Method in class fj.data.fingertrees.Single
+
 
+
init() - Method in class fj.data.List
+
+
Returns all but the last element of this list.
+
+
init() - Method in class fj.data.Seq
+
+
The sequence without the last element.
+
+
init() - Static method in class fj.data.State
+
 
+
inits() - Method in class fj.data.List
+
+
Returns the list of initial segments of this list, shortest first.
+
+
inits() - Method in class fj.data.Stream
+
+
Returns a stream of all prefixes of this stream.
+
+
inject(C) - Method in class fj.P2
+
+
Replaces the first element of this product with the given value.
+
+
insert(int, A) - Method in class fj.data.Seq
+
+
Inserts the element at the given index.
+
+
insert(A) - Method in class fj.data.Set
+
+
Inserts the given element into this set.
+
+
insert() - Static method in class fj.data.Set
+
+
First-class insertion function.
+
+
insertBy(F<A, F<A, Ordering>>, A) - Method in class fj.data.List
+
+
Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
+
+
insertDownAt(int, Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree at the specified location in the current node's stream of children.
+
+
insertDownFirst(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the first child of the current node.
+
+
insertDownLast(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the last child of the current node.
+
+
insertLeft(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the left of the current position.
+
+
insertLeft(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the left of the focus, then moves the focus to the new element.
+
+
insertRight(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the right of the current position.
+
+
insertRight(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the right of the focus, then moves the focus to the new element.
+
+
intAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds integers.
+
+
intAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds integers.
+
+
Integer_Boolean - Static variable in class fj.Primitive
+
+
A function that converts integers to booleans.
+
+
Integer_Byte - Static variable in class fj.Primitive
+
+
A function that converts integers to bytes.
+
+
Integer_Character - Static variable in class fj.Primitive
+
+
A function that converts integers to characters.
+
+
Integer_Double - Static variable in class fj.Primitive
+
+
A function that converts integers to doubles.
+
+
Integer_Float - Static variable in class fj.Primitive
+
+
A function that converts integers to floats.
+
+
Integer_Long - Static variable in class fj.Primitive
+
+
A function that converts integers to longs.
+
+
Integer_Short - Static variable in class fj.Primitive
+
+
A function that converts integers to shorts.
+
+
Integers - Class in fj.function
+
+
Curried functions over Integers.
+
+
intEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for int.
+
+
intEqual - Static variable in class fj.Equal
+
+
An equal instance for the int type.
+
+
interact(F<LazyString, LazyString>) - Static method in class fj.data.IOFunctions
+
 
+
interact(F<LazyString, LazyString>) - Static method in class fj.data.IOW
+
 
+
interactWhile(F<String, Boolean>, F<String, String>) - Static method in class fj.data.IOFunctions
+
+
Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
+
+
intercalate(List<List<A>>) - Method in class fj.data.List
+
+
Intersperses this list through the given list then joins the results.
+
+
interfaceParameters() - Method in class fj.Class
+
+
Provides this class's interface type parameter information as a list of trees.
+
+
interleave(Stream<A>) - Method in class fj.data.Stream
+
+
Interleaves the given stream with this stream to produce a new stream.
+
+
intersect(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that do not occur in the given set.
+
+
intersect() - Static method in class fj.data.Set
+
+
A first class function for Set.intersect(Set).
+
+
intersperse(A) - Method in class fj.data.List
+
+
Intersperses the given argument between each element of this list.
+
+
intersperse(A) - Method in class fj.data.NonEmptyList
+
+
Intersperses the given argument between each element of this non empty list.
+
+
intersperse(A) - Method in class fj.data.Stream
+
+
Intersperses the given value between each two elements of the stream.
+
+
intHash - Static variable in class fj.Hash
+
+
A hash instance for the int type.
+
+
intMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of integers.
+
+
intMaxMonoid - Static variable in class fj.Monoid
+
+
A monoid for the maximum of two integers.
+
+
intMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of integers.
+
+
intMinMonoid - Static variable in class fj.Monoid
+
+
A monoid for the minimum of two integers.
+
+
intMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies integers.
+
+
intMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies integers.
+
+
intOrd - Static variable in class fj.Ord
+
+
An order instance for the int type.
+
+
intShow - Static variable in class fj.Show
+
+
A show instance for the int type.
+
+
intValue() - Method in class fj.data.Natural
+
+
Return the int value of this natural number.
+
+
IO<A> - Interface in fj.data
+
+
IO monad for processing files
+
+
io(Try0<A, ? extends IOException>) - Static method in class fj.Try
+
 
+
IOFunctions - Class in fj.data
+
+
IO monad for processing files, with main methods IOFunctions.enumFileLines(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.String, A>), + IOFunctions.enumFileChars(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.Character, A>) and IOFunctions.enumFileCharChunks(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<char[], A>) + (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee + without indirection in between).
+
+
ioMonoid(Monoid<A>) - Static method in class fj.Monoid
+
+
A monoid for IO values.
+
+
ioSemigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A semigroup for IO values.
+
+
ioUnit - Static variable in class fj.data.IOFunctions
+
 
+
IOW<A> - Class in fj.data
+
+
Created by MarkPerry on 9/06/2015.
+
+
is(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
alias for contramap
+
+
isChild() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is a child node of another node.
+
+
isDefined - Static variable in class fj.function.Characters
+
 
+
isDigit - Static variable in class fj.function.Characters
+
 
+
isEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.Array
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.fingertrees.FingerTree
+
+
Indicates whether this tree is empty.
+
+
isEmpty() - Method in class fj.data.hamt.BitSet
+
 
+
isEmpty() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns if the trie is empty.
+
+
isEmpty() - Method in class fj.data.HashMap
+
+
Determines if this hash map has any entries.
+
+
isEmpty() - Method in class fj.data.HashSet
+
+
Determines if this hash set contains any elements.
+
+
isEmpty() - Method in class fj.data.LazyString
+
+
Checks if this string is empty.
+
+
isEmpty() - Method in class fj.data.List.Buffer
+
+
Returns true if this buffer is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.List
+
+
Returns true if this list is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.PriorityQueue
+
+
Is the tree empty?
+
+
isEmpty() - Method in class fj.data.Seq
+
+
Checks if this is the empty sequence.
+
+
isEmpty() - Method in class fj.data.Set
+
 
+
isEmpty() - Method in class fj.data.Stream
+
+
Returns true if this stream is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.TreeMap
+
+
Determines if this tree map has any entries.
+
+
isEmpty - Static variable in class fj.function.Strings
+
+
A curried version of String.isEmpty().
+
+
isEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is empty.
+
+
isEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is empty.
+
+
isEqual(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isFail() - Method in class fj.data.Validation
+
+
Returns true if this is a failure, false otherwise.
+
+
isFirst() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the leftmost tree in the current forest.
+
+
isFulfilled() - Method in class fj.control.parallel.Promise
+
+
Returns true if this promise has been fulfilled.
+
+
isGreaterThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isGreaterThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is greater than the second given + argument, false otherwise.
+
+
isGreaterThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is greater than than the argument to this method.
+
+
isIdentifierIgnorable - Static variable in class fj.function.Characters
+
 
+
isISOControl - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isLast() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the rightmost tree in the current forest.
+
+
isLeaf() - Method in class fj.data.Tree
+
 
+
isLeaf() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the bottom of the tree.
+
+
isLeft() - Method in class fj.data.Either
+
+
Returns true if this either is a left, false otherwise.
+
+
isLessThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
+
Does the top of the queue have lower priority than k?
+
+
isLessThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than the second given argument, + false otherwise.
+
+
isLessThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is less than the argument to this method.
+
+
isLessThanOrEqualTo(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
+
+
isLetter - Static variable in class fj.function.Characters
+
 
+
isLetterOrDigit - Static variable in class fj.function.Characters
+
 
+
isLowerCase - Static variable in class fj.function.Characters
+
 
+
isMatching(S) - Method in class fj.data.optic.POptional
+
+
check if a POptional has a target
+
+
isMatching(S) - Method in class fj.data.optic.PPrism
+
+
check if a PPrism has a target
+
+
isMirrored - Static variable in class fj.function.Characters
+
 
+
isNewLine - Static variable in class fj.function.Characters
+
 
+
isNone() - Method in class fj.data.Option
+
+
Returns false if this optional value has a value, true otherwise.
+
+
isNone_() - Static method in class fj.data.Option
+
+
A first-class version of the isNone method.
+
+
isnot(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns inverse of contramap
+
+
isNotEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Array
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.List
+
+
Returns false if this list is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Seq
+
+
Checks if this sequence is not empty.
+
+
isNotEmpty() - Method in class fj.data.Stream
+
+
Returns false if this stream is empty, true otherwise.
+
+
isNotEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is not empty.
+
+
isNotEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is not empty.
+
+
isNotNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
+
+
isNotNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is neither null nor empty.
+
+
isNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
+
+
isNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is null or empty (String.isEmpty()).
+
+
Iso<S,A> - Class in fj.data.optic
+
+
PIso when S = T and A = B
+
+
Iso(PIso<S, S, A, A>) - Constructor for class fj.data.optic.Iso
+
 
+
iso(F<S, A>, F<A, S>) - Static method in class fj.data.optic.Iso
+
+
create an Iso using a pair of functions: one to get the target and one to get the source.
+
+
isoControl(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isoControl(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isPrefixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isRight() - Method in class fj.data.Either
+
+
Returns true if this either is a right, false otherwise.
+
+
isRoot() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the top of the tree.
+
+
isSet(int) - Method in class fj.data.hamt.BitSet
+
 
+
isSingle() - Method in class fj.data.List
+
+
True if and only if the list has one element.
+
+
isSome() - Method in class fj.data.Option
+
+
Returns true if this optional value has a value, false otherwise.
+
+
isSome_() - Static method in class fj.data.Option
+
+
A first-class version of the isSome method.
+
+
isSpaceChar - Static variable in class fj.function.Characters
+
 
+
isSuccess() - Method in class fj.data.Validation
+
+
Returns true if this is a success, false otherwise.
+
+
isSuffixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isTitleCase - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isUpperCase - Static variable in class fj.function.Characters
+
 
+
isWhitespace - Static variable in class fj.function.Characters
+
 
+
iterable(A) - Static method in class fj.data.IterableW
+
+
Returns an Iterable that completely preserves the argument.
+
+
iterable(F<A, B>) - Static method in class fj.data.IterableW
+
+
Wraps a given function's return value in a Iterable.
+
+
iterableArray(Iterable<A>) - Static method in class fj.data.Array
+
+
Takes the given iterable to an array.
+
+
iterableBuffer(Iterable<A>) - Static method in class fj.data.List.Buffer
+
+
Takes the given iterable to a buffer.
+
+
iterableDList(Iterable<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterable
+
+
iterableHashMap(Equal<K>, Hash<K>, Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashMap(Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashSet(Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableHashSet(Equal<A>, Hash<A>, Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in an Iterable.
+
+
iterableK() - Method in class fj.F1W
+
+
Promotes this function to return its value in an Iterable.
+
+
iterableList(Iterable<A>) - Static method in class fj.data.List
+
+
Takes the given iterable to a list.
+
+
iterableM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Iterables.
+
+
iterableM() - Method in class fj.F2W
+
+
Promotes this function to a function on Iterables.
+
+
iterableSeq(Iterable<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterable.
+
+
iterableSet(Ord<A>, Iterable<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterable as a set.
+
+
iterableStream(Iterable<A>) - Static method in class fj.data.Stream
+
+
Takes the given iterable to a stream.
+
+
iterableTreeMap(Ord<K>, Iterable<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
IterableW<A> - Class in fj.data
+
+
A wrapper for Iterable that equips it with some useful functions.
+
+
iterate(F<A, A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream constructed by applying the given iteration function starting at the given value.
+
+
iterate() - Static method in class fj.data.Stream
+
+
A first-class version of the iterate function.
+
+
Iteratee - Class in fj.data
+
 
+
Iteratee.Input<E> - Class in fj.data
+
+
The input to an iteratee.
+
+
Iteratee.IterV<E,A> - Class in fj.data
+
+
A pure iteratee computation which is either done or needs more input
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.List
+
+
Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.Stream
+
+
Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterator() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Array
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Either.LeftProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Either.RightProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.HashMap
+
+
Returns an iterator for this map's keys.
+
+
iterator() - Method in class fj.data.HashSet
+
+
Returns an iterator for this hash set.
+
+
iterator() - Method in class fj.data.IterableW
+
+
Returns an iterator for this iterable.
+
+
iterator() - Method in class fj.data.List.Buffer
+
+
Returns an iterator for this buffer.
+
+
iterator() - Method in class fj.data.List
+
+
Returns an iterator for this list.
+
+
iterator() - Method in class fj.data.NonEmptyList
+
+
Returns an iterator for this non-empty list.
+
+
iterator() - Method in class fj.data.Option
+
+
Returns an iterator for this optional value.
+
+
iterator() - Method in class fj.data.Seq
+
+
Returns an iterator for this seq.
+
+
iterator() - Method in class fj.data.Set
+
+
Returns an iterator over this set.
+
+
iterator() - Method in class fj.data.Stream
+
+
Returns an iterator for this stream.
+
+
iterator() - Method in class fj.data.Tree
+
+
Returns an iterator for this tree.
+
+
iterator() - Method in class fj.data.TreeMap
+
+
Returns an iterator for this map's key-value pairs.
+
+
iterator() - Method in class fj.data.TreeZipper
+
+
Returns an iterator of all the positions of this TreeZipper.
+
+
iterator() - Method in class fj.data.Validation.FailProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Validation
+
+
Returns an iterator for this validation.
+
+
iterator() - Method in class fj.data.vector.V2
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V3
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V4
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V5
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V6
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V7
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V8
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.Zipper
+
+
Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
+
+
iterator() - Method in class fj.parser.Result
+
+
Returns an iterator over the parse value.
+
+
iteratorArray(Iterator<A>) - Static method in class fj.data.Array
+
+
Creates an Array from the iterator.
+
+
iteratorDList(Iterator<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterator
+
+
iteratorHashMap(Equal<K>, Hash<K>, Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashMap(Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashSet(Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorHashSet(Equal<A>, Hash<A>, Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorList(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
iteratorSeq(Iterator<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterator.
+
+
iteratorSet(Ord<A>, Iterator<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
iteratorStream(Iterator<A>) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements in the Iterator.
+
+
iteratorTreeMap(Ord<K>, Iterator<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
+ + + +

J

+
+
Java - Class in fj.data
+
+
Functions that convert between types from the core Java API.
+
+
javaIdentifierPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
javaIdentifierStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
JavaList_List() - Static method in class fj.data.Java
+
 
+
JavaList_List(List<A>) - Static method in class fj.data.Java
+
 
+
join(DB<DB<A>>) - Static method in class fj.control.db.DB
+
+
Removes one layer of monadic structure.
+
+
join(Callable<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Joins a Callable of a Callable with a bind operation.
+
+
join(Promise<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a promise of a promise into just a promise.
+
+
join(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a product of a promise into just a promise.
+
+
join(Array<Array<A>>) - Static method in class fj.data.Array
+
+
Joins the given array of arrays using a bind operation.
+
+
join() - Static method in class fj.data.Array
+
+
A first-class version of join
+
+
join(IO<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
join(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Joins an Iterable of Iterables into a single Iterable.
+
+
join() - Static method in class fj.data.IterableW
+
+
Returns a function that joins an Iterable of Iterables into a single Iterable.
+
+
join(List<List<A>>) - Static method in class fj.data.List
+
+
Joins the given list of lists using a bind operation.
+
+
join() - Static method in class fj.data.List
+
+
A first-class version of join
+
+
join(NonEmptyList<NonEmptyList<A>>) - Static method in class fj.data.NonEmptyList
+
+
Concatenate (join) a non empty list of non empty lists.
+
+
join(Option<Option<A>>) - Static method in class fj.data.Option
+
+
Joins the given optional value of optional value using a bind operation.
+
+
join() - Static method in class fj.data.Option
+
+
First-class join function.
+
+
join(Ord<A>, Set<Set<A>>) - Static method in class fj.data.Set
+
+
Join a set of sets into a single set.
+
+
join(Stream<Stream<A>>) - Static method in class fj.data.Stream
+
+
Joins the given stream of streams by concatenation.
+
+
join() - Static method in class fj.data.Stream
+
+
A first-class version of join
+
+
join(F<B, F<B, A>>) - Static method in class fj.Function
+
+
Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
+
+
join(Iterable<A>, A) - Method in class fj.Monoid
+
+
Intersperses the given value between each two elements of the iterable, and sums the result.
+
+
join(P1<P1<A>>) - Static method in class fj.P1
+
+
Joins a P1 of a P1 with a bind operation.
+
+
joinLeft(Either<Either<A, B>, B>) - Static method in class fj.data.Either
+
+
Joins an either through left.
+
+
joinRight(Either<A, Either<A, B>>) - Static method in class fj.data.Either
+
+
Joins an either through right.
+
+
JUList_List() - Static method in class fj.data.Java
+
+
Deprecated. +
As of 4.3, use Java.JavaList_List()
+
+
+
+ + + +

K

+
+
keys() - Method in class fj.data.HashMap
+
+
Returns all key entries in this hash map.
+
+
keys() - Method in class fj.data.TreeMap
+
+
Returns all keys in this tree map.
+
+
+ + + +

L

+
+
last() - Method in class fj.data.fingertrees.Deep
+
 
+
last() - Method in class fj.data.fingertrees.Empty
+
 
+
last() - Method in class fj.data.fingertrees.FingerTree
+
+
The last element of this tree.
+
+
last() - Method in class fj.data.fingertrees.Single
+
 
+
last() - Method in class fj.data.List
+
+
Returns the last element of this list.
+
+
last() - Method in class fj.data.Seq
+
+
The last element of this sequence.
+
+
last() - Method in class fj.data.Stream
+
+
Get the last element of this stream.
+
+
lastChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the last child of the current location.
+
+
lastOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the last available value.
+
+
lastOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the last available value.
+
+
lastSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "last" (right-hand side) value.
+
+
later(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation with caching.
+
+
lazy(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<A, Unit>) - Static method in class fj.Effect
+
 
+
lazy(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a product-1.
+
+
lazy() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a product-1.
+
+
lazy(A) - Method in class fj.F1W
+
+
Partial application.
+
+
lazy(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
+
+
lazy(F0<A>, F0<B>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>, F0<H>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>, F<Unit, H>) - Static method in class fj.P
+
 
+
lazyProduct(F0<P2<A, B>>) - Static method in class fj.P
+
 
+
lazySafe(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazySafe(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
LazyString - Class in fj.data
+
+
A lazy (non-evaluated) immutable character string.
+
+
lazyStringShow - Static variable in class fj.Show
+
+
A show instance for lazy strings.
+
+
LcgRng - Class in fj
+
+
Created by MarkPerry on 7/07/2014.
+
+
LcgRng() - Constructor for class fj.LcgRng
+
 
+
LcgRng(long) - Constructor for class fj.LcgRng
+
 
+
leaf(A) - Static method in class fj.data.Tree
+
+
Creates a nullary tree.
+
+
left() - Method in class fj.data.Either
+
+
Projects this either as a left.
+
+
left(A) - Static method in class fj.data.Either
+
+
Construct a left value of either.
+
+
left(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
left() - Method in class fj.data.TreeZipper
+
+
Navigates to the left sibling of the current location.
+
+
left_() - Static method in class fj.data.Either
+
+
A function that constructs a left value of either.
+
+
left_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the left() function.
+
+
leftMap_() - Static method in class fj.data.Either
+
 
+
lefts(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the left values in the given list.
+
+
lefts() - Method in class fj.data.TreeZipper
+
+
Returns the left siblings of the currently focused node.
+
+
lefts() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the left of focus.
+
+
length() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.Array
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.fingertrees.Deep
+
 
+
length() - Method in class fj.data.fingertrees.Digit
+
 
+
length() - Method in class fj.data.fingertrees.Empty
+
 
+
length() - Method in class fj.data.fingertrees.FingerTree
+
 
+
length() - Method in class fj.data.fingertrees.Four
+
 
+
length() - Method in class fj.data.fingertrees.Node
+
 
+
length() - Method in class fj.data.fingertrees.Node2
+
 
+
length() - Method in class fj.data.fingertrees.Node3
+
 
+
length() - Method in class fj.data.fingertrees.One
+
 
+
length() - Method in class fj.data.fingertrees.Single
+
 
+
length() - Method in class fj.data.fingertrees.Three
+
 
+
length() - Method in class fj.data.fingertrees.Two
+
 
+
length() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the number of elements in the trie.
+
+
length() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that counts and consumes the elements of the input
+
+
length() - Method in class fj.data.LazyString
+
+
The length of the lazy string.
+
+
length() - Method in class fj.data.List
+
+
The length of this list.
+
+
length() - Method in class fj.data.NonEmptyList
+
+
The length of this list.
+
+
length() - Method in class fj.data.Option
+
+
Returns the length of this optional value; 1 if there is a value, 0 otherwise.
+
+
length() - Method in class fj.data.Seq
+
+
Returns the number of elements in this sequence.
+
+
length() - Method in class fj.data.Stream
+
+
The length of this stream.
+
+
length() - Method in class fj.data.Tree
+
 
+
length() - Method in class fj.data.Zipper
+
+
Returns the length of this zipper.
+
+
length - Static variable in class fj.function.Strings
+
+
A curried version of String.length().
+
+
length_() - Static method in class fj.data.List
+
+
First-class length.
+
+
Lens<S,A> - Class in fj.data.optic
+
+
PLens with a monomorphic set function
+
+
Lens(PLens<S, S, A, A>) - Constructor for class fj.data.optic.Lens
+
 
+
lens(F<S, A>, F<A, F<S, S>>) - Static method in class fj.data.optic.Lens
+
+
create a Lens using a pair of functions: one to get the target, one to set the target.
+
+
levels() - Method in class fj.data.Tree
+
+
Provides a stream of the elements of the tree at each level, in level order.
+
+
lift(IO<A>) - Static method in class fj.data.IOW
+
 
+
lift(F<A, B>) - Static method in class fj.F1W
+
+
Lifts the function into the fully featured function wrapper
+
+
lift(F2<A, B, C>) - Static method in class fj.F2W
+
+
Lifts the function into the fully featured function wrapper
+
+
lift(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Promotes a function of arity-2 to a higher-order function.
+
+
lift() - Method in class fj.Semigroup
+
+
Lifts the semigroup to obtain a trivial monoid.
+
+
liftM(F<A, B>) - Static method in class fj.control.db.DB
+
+
Promotes any given function so that it transforms between values in the database.
+
+
liftM(F<A, B>, Measured<V, B>) - Static method in class fj.data.fingertrees.Node
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Promotes a function of arity-2 to a function on callables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Promise
+
+
Promotes a function of arity-2 to a function on promises.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.Trampoline
+
+
Promotes the given function of arity-2 to a function on Trampolines.
+
+
liftM2(IO<A>, IO<B>, F2<A, B, C>) - Static method in class fj.data.IOFunctions
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Promotes a function of arity-2 to a function on iterables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.List
+
+
Promotes the given function of arity-2 to a function on lists.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.Option
+
+
Promotes a function of arity-2 so that it operates over options.
+
+
liftM2(Option<B>, F2<A, B, C>) - Method in class fj.data.Option
+
+
Lift the function of arity-2 through options.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.P1
+
+
Promotes a function of arity-2 to a function on P1s.
+
+
liftM2(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
 
+
lineReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with lines read from a BufferedReader.
+
+
lines() - Method in class fj.data.LazyString
+
+
Splits this lazy string into lines.
+
+
lines(String) - Static method in class fj.function.Strings
+
 
+
lines() - Static method in class fj.function.Strings
+
 
+
lines_() - Static method in class fj.data.LazyString
+
 
+
lineSeparator - Static variable in class fj.function.Strings
+
 
+
LinkedBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts linked blocking queues to lists.
+
+
LinkedHashSet_List() - Static method in class fj.data.Java
+
+
A function that converts linked hash sets to lists.
+
+
LinkedList_List() - Static method in class fj.data.Java
+
+
A function that converts linked lists to lists.
+
+
list() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the input elements and returns them as a list in reverse order, + so that the last line is the first element.
+
+
List<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list.
+
+
list(B, F<A, F<List<A>, B>>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.uncons(fj.F2<A, fj.data.List<A>, B>, B)
+
+
+
list(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
list(Iterable<A>) - Static method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.iterableList(Iterable)
+
+
+
list(Iterator<A>) - Static method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.iteratorList(Iterator)
+
+
+
List.Buffer<A> - Class in fj.data
+
+
A mutable, singly linked list.
+
+
List.Optic - Class in fj.data
+
+
Optic factory methods for a List
+
+
List.Unsafe - Class in fj.data
+
 
+
List_Array() - Static method in class fj.data.Conversions
+
+
A function that converts lists to arrays.
+
+
List_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to array blocking queue.
+
+
List_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to array lists.
+
+
List_BitSet - Static variable in class fj.data.Java
+
+
A function that converts lists to bit sets.
+
+
List_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to concurrent linked queues.
+
+
List_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array lists.
+
+
List_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array sets.
+
+
List_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to delay queues.
+
+
List_Either() - Static method in class fj.data.Conversions
+
+
A function that converts lists to eithers.
+
+
List_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts lists to array enum sets.
+
+
List_HashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to hash sets.
+
+
List_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to linked blocking queues.
+
+
List_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to linked hash sets.
+
+
List_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts lists to linked lists.
+
+
List_Option() - Static method in class fj.data.Conversions
+
+
A function that converts lists to options.
+
+
List_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority blocking queues.
+
+
List_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority queues.
+
+
List_Stack() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts lists to streams.
+
+
List_String - Static variable in class fj.data.Conversions
+
+
A function that converts lists to strings.
+
+
List_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string buffers.
+
+
List_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string builders.
+
+
List_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to synchronous queues.
+
+
List_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Vector() - Static method in class fj.data.Java
+
+
A function that converts lists to vectors.
+
+
listBitSet(List<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
listDList(List<A>) - Static method in class fj.data.DList
+
+
Creates a DList from a List
+
+
listEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the List type.
+
+
listHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the List type.
+
+
listK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a List.
+
+
listK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a List.
+
+
listM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Lists.
+
+
listM() - Method in class fj.F2W
+
+
Promotes this function to a function on Lists.
+
+
listMonoid() - Static method in class fj.Monoid
+
+
A monoid for lists.
+
+
listOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the List type.
+
+
listSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for lists.
+
+
listSeq(List<A>) - Static method in class fj.data.Seq
+
+
Deprecated. +
As of release 4.5, use Seq.iterableSeq(java.lang.Iterable<A>)
+
+
+
listShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
log() - Method in class fj.data.Writer
+
 
+
Long_Boolean - Static variable in class fj.Primitive
+
+
A function that converts longs to booleans.
+
+
Long_Byte - Static variable in class fj.Primitive
+
+
A function that converts longs to bytes.
+
+
Long_Character - Static variable in class fj.Primitive
+
+
A function that converts longs to characters.
+
+
Long_Double - Static variable in class fj.Primitive
+
+
A function that converts longs to doubles.
+
+
Long_Float - Static variable in class fj.Primitive
+
+
A function that converts longs to floats.
+
+
Long_Integer - Static variable in class fj.Primitive
+
+
A function that converts longs to integers.
+
+
Long_Short - Static variable in class fj.Primitive
+
+
A function that converts longs to shorts.
+
+
longAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds longs.
+
+
longAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds longs.
+
+
longBitSet(long) - Static method in class fj.data.hamt.BitSet
+
 
+
longEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for long.
+
+
longEqual - Static variable in class fj.Equal
+
+
An equal instance for the long type.
+
+
longHash - Static variable in class fj.Hash
+
+
A hash instance for the long type.
+
+
longMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of longs.
+
+
longMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of longs.
+
+
longMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies longs.
+
+
longMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies longs.
+
+
longOrd - Static variable in class fj.Ord
+
+
An order instance for the long type.
+
+
Longs - Class in fj.function
+
+
Curried functions over Longs.
+
+
longShow - Static variable in class fj.Show
+
+
A show instance for the long type.
+
+
longValue() - Method in class fj.data.hamt.BitSet
+
 
+
longValue() - Method in class fj.data.Natural
+
+
Return the long value of this natural number.
+
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Deep
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Digit
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Empty
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.FingerTree
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Four
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node2
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node3
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.One
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Single
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Three
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Two
+
 
+
lookup(Equal<A>, List<P2<A, B>>, A) - Static method in class fj.data.List
+
+
Returns an associated value with the given key in the list of pairs.
+
+
lookup(Equal<A>) - Static method in class fj.data.List
+
+
Returns a partially applied version of List.lookup(Equal, List, Object).
+
+
lookup(A) - Method in class fj.data.Set
+
+
Find element equal to the given one.
+
+
lookupGE(A) - Method in class fj.data.Set
+
+
Find smallest element greater or equal to the given one.
+
+
lookupGT(A) - Method in class fj.data.Set
+
+
Find smallest element greater than the given one.
+
+
lookupLE(A) - Method in class fj.data.Set
+
+
Find largest element smaller or equal to the given one.
+
+
lookupLT(A) - Method in class fj.data.Set
+
+
Find largest element smaller than the given one.
+
+
lower(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lower(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lowSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lowSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than or equal to zero.
+
+
lteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than or equal to zero.
+
+
ltZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than zero.
+
+
ltZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than zero.
+
+
+ + + +

M

+
+
MakeTree<V,A> - Class in fj.data.fingertrees
+
+
A builder of trees and tree components, supplied with a particular monoid and measuring function.
+
+
map(F<A, B>) - Method in class fj.control.db.DB
+
+
Map a function over the result of this action.
+
+
map(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's domain (Invariant Functor pattern).
+
+
map(F<A, B>) - Method in class fj.control.Trampoline
+
+
Maps the given function across the result of this trampoline.
+
+
map(F<A, B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Maps the given function across this array.
+
+
map(F<A, B>) - Method in class fj.data.Array
+
+
Maps the given function across this array.
+
+
map() - Static method in class fj.data.Array
+
+
First-class map function for Arrays.
+
+
map(F<A, X>) - Method in class fj.data.Either.LeftProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<B, X>) - Method in class fj.data.Either.RightProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<A, B>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Deep
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Digit
+
+
Maps a function across the elements of this digit, measuring with the given measurement.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Empty
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Maps the given function across this tree, measuring with the given Measured instance.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Node
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Single
+
 
+
map(F<K, A>, F<V, B>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<K, A>, F<V, B>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>) - Method in class fj.data.HashMap
+
 
+
map(IO<A>, F<A, B>) - Static method in class fj.data.IOFunctions
+
 
+
map(F<A, B>) - Method in class fj.data.IOW
+
 
+
map(F<A, B>) - Method in class fj.data.IterableW
+
+
Maps a given function across the wrapped Iterable.
+
+
map() - Static method in class fj.data.IterableW
+
+
Returns a function that promotes any function so that it operates on Iterables.
+
+
map(F<Character, Character>) - Method in class fj.data.LazyString
+
 
+
map(F<A, B>) - Method in class fj.data.List
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.Option
+
+
Maps the given function across this optional value.
+
+
map() - Static method in class fj.data.Option
+
+
A first-class map function.
+
+
map(F<A, B>) - Method in class fj.data.PriorityQueue
+
+
Maps the values in each node with function f.
+
+
map(F<B, C>) - Method in class fj.data.Reader
+
 
+
map(F<A, B>) - Method in class fj.data.Seq
+
 
+
map(Ord<B>, F<A, B>) - Method in class fj.data.Set
+
+
Maps the given function across this set.
+
+
map(F<A, B>) - Method in class fj.data.State
+
 
+
map(F<A, B>) - Method in class fj.data.Stream
+
+
Maps the given function across this stream.
+
+
map(F<V, W>) - Method in class fj.data.TreeMap
+
+
Maps the given function across the values of this TreeMap.
+
+
map(F<A, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function across this zipper (covariant functor pattern).
+
+
map(F<E, A>) - Method in class fj.data.Validation.FailProjection
+
+
Maps the given function across the failing side of this validation.
+
+
map(F<T, A>) - Method in class fj.data.Validation
+
+
Maps the given function across the success side of this validation.
+
+
map(F<A, B>) - Method in class fj.data.vector.V2
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V3
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V4
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V5
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V6
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V7
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V8
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.Writer
+
 
+
map(F<A, B>) - Method in class fj.data.Zipper
+
+
Maps the given function across the elements of this zipper (covariant functor pattern).
+
+
map(F<A, B>, F<B, C>) - Static method in class fj.F1Functions
+
 
+
map(F<B, C>) - Method in class fj.F1W
+
 
+
map(F2<A, B, C>, F<C, Z>) - Static method in class fj.F2Functions
+
 
+
map(F<C, Z>) - Method in class fj.F2W
+
 
+
map(F<A, B>) - Method in class fj.P1
+
+
Map the element of the product.
+
+
map(F<A, B>, P2<A, A>) - Static method in class fj.P2
+
+
Maps the given function across both the elements of the given product.
+
+
map(F<A, B>) - Method in class fj.parser.Parser
+
+
Maps the given result type across this parser.
+
+
map1(F<A, X>) - Method in class fj.P2
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P3
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P4
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P5
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P6
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P7
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P8
+
+
Map the first element of the product.
+
+
map1_(F<A, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the first element of a product.
+
+
map2(F<B, X>) - Method in class fj.P2
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P3
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P4
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P5
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P6
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P7
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P8
+
+
Map the second element of the product.
+
+
map2_(F<B, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the second element of a product.
+
+
map3(F<C, X>) - Method in class fj.P3
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P4
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P5
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P6
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P7
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P8
+
+
Map the third element of the product.
+
+
map4(F<D, X>) - Method in class fj.P4
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P5
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P6
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P7
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P8
+
+
Map the fourth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P5
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P6
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P7
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P8
+
+
Map the fifth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P6
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P7
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P8
+
+
Map the sixth element of the product.
+
+
map7(F<G, X>) - Method in class fj.P7
+
+
Map the seventh element of the product.
+
+
map7(F<G, X>) - Method in class fj.P8
+
+
Map the seventh element of the product.
+
+
map8(F<H, X>) - Method in class fj.P8
+
+
Map the eighth element of the product.
+
+
map_() - Static method in class fj.control.Trampoline
+
 
+
map_() - Static method in class fj.data.List
+
+
Provides a first-class version of map()
+
+
map_() - Static method in class fj.data.Stream
+
+
Provides a first-class version of the map function.
+
+
map_(F<A, B>) - Static method in class fj.P1
+
+
Promote any function to a transformation between P1s.
+
+
mapArray(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Array.
+
+
mapArray() - Method in class fj.F1W
+
+
Promotes this function to map over a Array.
+
+
mapBoth(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over both elements of a pair.
+
+
mapBoth() - Method in class fj.F1W
+
+
Promotes this function to map over both elements of a pair.
+
+
mapError(F<E, K>) - Method in class fj.parser.Parser
+
+
Maps the given function across this parser's error.
+
+
mapFail(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the failure side of a Validation.
+
+
mapFail() - Method in class fj.F1W
+
+
Promotes this function to map over the failure side of a Validation.
+
+
mapFst(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the first element of a pair.
+
+
mapFst() - Method in class fj.F1W
+
+
Promotes this function to map over the first element of a pair.
+
+
mapIterable(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over Iterables.
+
+
mapIterable() - Method in class fj.F1W
+
+
Promotes this function to map over Iterables.
+
+
mapJ(F<A, B>, SynchronousQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a SynchronousQueue.
+
+
mapJ(F<A, B>, PriorityBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a PriorityBlockingQueue.
+
+
mapJ(F<A, B>, LinkedBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a LinkedBlockingQueue.
+
+
mapJ(F<A, B>, CopyOnWriteArraySet<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a CopyOnWriteArraySet.
+
+
mapJ(F<A, B>, CopyOnWriteArrayList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a CopyOnWriteArrayList.
+
+
mapJ(F<A, B>, ConcurrentLinkedQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a ConcurrentLinkedQueue.
+
+
mapJ(F<A, B>, ArrayBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over an ArrayBlockingQueue.
+
+
mapJ(F<A, B>, TreeSet<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a TreeSet.
+
+
mapJ(F<A, B>, PriorityQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a PriorityQueue.
+
+
mapJ(F<A, B>, LinkedList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a LinkedList.
+
+
mapJ(F<A, B>, ArrayList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over an ArrayList.
+
+
mapJ(SynchronousQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a SynchronousQueue.
+
+
mapJ(PriorityBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a PriorityBlockingQueue.
+
+
mapJ(LinkedBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a LinkedBlockingQueue.
+
+
mapJ(CopyOnWriteArraySet<A>) - Method in class fj.F1W
+
+
Maps this function over a CopyOnWriteArraySet.
+
+
mapJ(CopyOnWriteArrayList<A>) - Method in class fj.F1W
+
+
Maps this function over a CopyOnWriteArrayList.
+
+
mapJ(ConcurrentLinkedQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a ConcurrentLinkedQueue.
+
+
mapJ(ArrayBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over an ArrayBlockingQueue.
+
+
mapJ(TreeSet<A>) - Method in class fj.F1W
+
+
Maps this function over a TreeSet.
+
+
mapJ(PriorityQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a PriorityQueue.
+
+
mapJ(LinkedList<A>) - Method in class fj.F1W
+
+
Maps this function over a LinkedList.
+
+
mapJ(ArrayList<A>) - Method in class fj.F1W
+
+
Maps this function over an ArrayList.
+
+
mapKeys(F<K, A>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
mapKeys(F<K, A>) - Method in class fj.data.HashMap
+
 
+
mapLeft(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the left side of an Either.
+
+
mapLeft() - Method in class fj.F1W
+
+
Promotes this function to map over the left side of an Either.
+
+
mapList() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a List inside a promise.
+
+
mapList(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a List.
+
+
mapList() - Method in class fj.F1W
+
+
Promotes this function to map over a List.
+
+
mapM(List<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
+
+
mapM(Stream<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
+
+
mapM(P1<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Maps a concurrent function over a Product-1 inside a Promise.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.List
+
+
Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
+
+
mapMOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Option monad.
+
+
mapMTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Trampoline monad.
+
+
mapNel(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a NonEmptyList.
+
+
mapNel() - Method in class fj.F1W
+
+
Promotes this function to map over a NonEmptyList.
+
+
mapOption(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over an optional value.
+
+
mapOption() - Method in class fj.F1W
+
+
Promotes this function to map over an optional value.
+
+
mapP1(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a product-1.
+
+
mapP1() - Method in class fj.F1W
+
+
Promotes this function to map over a product-1.
+
+
mapPromise(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Promise.
+
+
mapPromise() - Method in class fj.F1W
+
+
Promotes this function to map over a Promise.
+
+
mapRest(F<I, J>) - Method in class fj.parser.Result
+
+
Maps the given function across the remainder of the parse input.
+
+
mapRest() - Method in class fj.parser.Result
+
+
First-class function mapping across the remainder of the parse input.
+
+
mapRight(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the right side of an Either.
+
+
mapRight() - Method in class fj.F1W
+
+
Promotes this function to map over the right side of an Either.
+
+
mapSet(F<A, B>, Ord<B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Set.
+
+
mapSet(Ord<B>) - Method in class fj.F1W
+
+
Promotes this function to map over a Set.
+
+
mapSnd(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the second element of a pair.
+
+
mapSnd() - Method in class fj.F1W
+
+
Promotes this function to map over the second element of a pair.
+
+
mapState(F<P2<S, A>, P2<S, B>>) - Method in class fj.data.State
+
 
+
mapStream() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a Stream inside a promise.
+
+
mapStream(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Stream.
+
+
mapStream() - Method in class fj.F1W
+
+
Promotes this function to map over a Stream.
+
+
mapSuccess(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the success side of a Validation.
+
+
mapSuccess() - Method in class fj.F1W
+
+
Promotes this function to map over the success side of a Validation.
+
+
mapTails(F<NonEmptyList<A>, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across the tails of this list (comonad pattern).
+
+
mapTree(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Tree.
+
+
mapTree() - Method in class fj.F1W
+
+
Promotes this function to map over a Tree.
+
+
mapTreeZipper(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a TreeZipper.
+
+
mapTreeZipper() - Method in class fj.F1W
+
+
Promotes this function to map over a TreeZipper.
+
+
mapValue(F<A, B>) - Method in class fj.parser.Result
+
+
Maps the given function across the parse value.
+
+
mapValue() - Method in class fj.parser.Result
+
+
First-class function mapping across the parse value.
+
+
mapValues(F<V, B>) - Method in class fj.data.HashMap
+
 
+
mapZipper(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Zipper.
+
+
mapZipper() - Method in class fj.F1W
+
+
Promotes this function to map over a Zipper.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Deep
+
+
Pattern matching on the tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Digit
+
+
Structural pattern matching on digits.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Empty
+
+
Pattern matching on the structure of this tree.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Provides pattern matching on trees.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Four
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node2
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node3
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.One
+
 
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Single
+
+
Pattern matching on the structure of this tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Three
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Two
+
 
+
match(F<P2<K, V>, B>, F<HashArrayMappedTrie<K, V>, B>) - Method in class fj.data.hamt.Node
+
+
Performs a reduction on this Node using the given arguments.
+
+
matches(String) - Method in class fj.data.LazyString
+
+
Regular expression pattern matching.
+
+
matches - Static variable in class fj.function.Strings
+
+
A curried version of String.matches(String).
+
+
max() - Method in class fj.data.Enumerator
+
+
Returns the maximum value for this enumerator if there is one.
+
+
max() - Method in class fj.data.Set
+
 
+
max() - Method in class fj.data.TreeMap
+
+
Returns the maximum (key, value) pair in the tree if the tree is not empty.
+
+
max - Variable in class fj.Ord
+
+
A function that returns the greater of its two arguments.
+
+
max(A, A) - Method in class fj.Ord
+
+
Returns the greater of its two arguments.
+
+
MAX_BIT_INDEX - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_BIT_SIZE - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
maximum(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maximum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the maximum element in this non empty list according to the given ordering.
+
+
maximumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maxKey() - Method in class fj.data.TreeMap
+
+
Returns the maximum key in the tree if the tree is not empty.
+
+
maxMonoid(A) - Method in class fj.Ord
+
 
+
maxSemigroup() - Method in class fj.Ord
+
 
+
measure() - Method in class fj.data.fingertrees.Deep
+
+
Returns the sum of the measurements of this tree's elements, according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Digit
+
+
Returns the sum of the measurements of this digit according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Empty
+
+
Returns zero.
+
+
measure() - Method in class fj.data.fingertrees.FingerTree
+
+
Returns the sum of this tree's annotations.
+
+
measure() - Method in class fj.data.fingertrees.Measured
+
+
Returns the measuring function.
+
+
measure(A) - Method in class fj.data.fingertrees.Measured
+
+
Measures a given element.
+
+
measure() - Method in class fj.data.fingertrees.Node
+
 
+
measure() - Method in class fj.data.fingertrees.Single
+
+
Returns the annotation of this tree's single element.
+
+
measured() - Method in class fj.data.fingertrees.FingerTree
+
 
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Constructs a Measured instance for the element type, given a monoid and a measuring function.
+
+
Measured<V,A> - Class in fj.data.fingertrees
+
+
Determines how the elements of a tree are measured and how measures are summed.
+
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.Measured
+
 
+
member(A) - Method in class fj.data.Set
+
+
Checks if the given element is a member of this set.
+
+
member() - Static method in class fj.data.Set
+
+
First-class membership check.
+
+
memo() - Method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P1.weakMemo() instead.
+
+
+
memo(F<Unit, A>) - Static method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P.weakMemo(F0) instead.
+
+
+
memo(F0<A>) - Static method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P.weakMemo(F0) instead.
+
+
+
memo() - Method in class fj.P2
+
+
Provides a memoising P2 that remembers its values.
+
+
memo() - Method in class fj.P3
+
+
Provides a memoising P3 that remembers its values.
+
+
memo() - Method in class fj.P4
+
+
Provides a memoising P4 that remembers its values.
+
+
memo() - Method in class fj.P5
+
+
Provides a memoising P5 that remembers its values.
+
+
memo() - Method in class fj.P6
+
+
Provides a memoising P6 that remembers its values.
+
+
memo() - Method in class fj.P7
+
+
Provides a memoising P7 that remembers its values.
+
+
memo() - Method in class fj.P8
+
+
Provides a memoising P8 that remembers its values.
+
+
mergeAll(List<Future<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Waits for every Future in a list to obtain a value, and collects those values in a list.
+
+
middle() - Method in class fj.data.fingertrees.Deep
+
+
Returns a finger tree of the inner nodes of this tree.
+
+
min() - Method in class fj.data.Enumerator
+
+
Returns the minimum value for this enumerator if there is one.
+
+
min() - Method in class fj.data.Set
+
 
+
min() - Method in class fj.data.TreeMap
+
+
Returns the minimum (key, value) pair in the tree if the tree is not empty.
+
+
min - Variable in class fj.Ord
+
+
A function that returns the lesser of its two arguments.
+
+
min(A, A) - Method in class fj.Ord
+
+
Returns the lesser of its two arguments.
+
+
MIN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
minimum(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minimum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the minimum element in this non empty list according to the given ordering.
+
+
minimumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minKey() - Method in class fj.data.TreeMap
+
+
Returns the minimum key in the tree if the tree is not empty.
+
+
minMonoid(A) - Method in class fj.Ord
+
 
+
minSemigroup() - Method in class fj.Ord
+
 
+
minus(Equal<A>, List<A>) - Method in class fj.data.List
+
+
Returns a new list of all the items in this list that do not appear in the given list.
+
+
minus(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that occur in the given set.
+
+
minus() - Static method in class fj.data.Set
+
+
A first class function for Set.minus(Set).
+
+
minus(Equal<A>, Stream<A>) - Method in class fj.data.Stream
+
+
Returns a new stream of all the items in this stream that do not appear in the given stream.
+
+
mirrored(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mirrored(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mkTree(Measured<V, A>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a builder of trees and tree components that annotates them using the given Measured instance.
+
+
mod - Static variable in class fj.data.Natural
+
+
A function that yields the remainder of division of its second argument by its first.
+
+
mod(Natural) - Method in class fj.data.Natural
+
+
Take the remainder of a natural number division.
+
+
mode(Ord<A>) - Method in class fj.data.List
+
+
Returns the most common element in this list.
+
+
modify(F<A, A>) - Method in class fj.data.optic.Lens
+
 
+
modify(F<A, A>) - Method in class fj.data.optic.Optional
+
 
+
modify(F<A, B>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens using a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PSetter
+
+
modify polymorphically the target of a PSetter with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with a function
+
+
modify(F<A, A>) - Method in class fj.data.optic.Setter
+
 
+
modify(F<S, S>) - Static method in class fj.data.State
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyLabel(F<A, A>) - Method in class fj.data.TreeZipper
+
+
Modifies the label at the current node with the given function.
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyOption(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function.
+
+
modifyOption(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function.
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTree(F<Tree<A>, Tree<A>>) - Method in class fj.data.TreeZipper
+
+
Modifies the current node with the given function.
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, A>>) - Method in class fj.data.optic.Traversal
+
 
+
monoid() - Method in class fj.data.fingertrees.Measured
+
+
Returns the monoid used to sum measures.
+
+
monoid() - Method in class fj.data.Writer
+
 
+
Monoid<A> - Class in fj
+
+
A monoid abstraction to be defined across types of the given type argument.
+
+
monoid(F<A, F<A, A>>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(F2<A, A, A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(Semigroup<A>, A) - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Monoid.monoidDef(Semigroup.Definition, Object) or Semigroup.monoid(Object) instead.
+
+
+
monoid(A) - Method in class fj.Semigroup
+
+
Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
+
+
Monoid.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Monoid: alternative minimal definition and overridable methods.
+
+
Monoid.Definition<A> - Interface in fj
+
+
Primitives functions of Monoid: minimal definition and overridable methods.
+
+
monoidDef(Monoid.Definition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Monoid.AltDefinition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Semigroup.Definition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
monoidDef(Semigroup.AltDefinition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
move(int) - Method in class fj.data.Zipper
+
+
Move the focus to the specified index.
+
+
move() - Static method in class fj.data.Zipper
+
+
A first-class version of the move function.
+
+
multiply - Static variable in class fj.data.Natural
+
+
A function that multiplies a natural number by another.
+
+
multiply(Natural) - Method in class fj.data.Natural
+
+
Multiply a natural number by another.
+
+
multiply - Static variable in class fj.function.BigIntegers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Doubles
+
+
Curried Double multiplication.
+
+
multiply - Static variable in class fj.function.Integers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Longs
+
+
Curried Long multiplication.
+
+
multiply(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply(int, A) - Method in class fj.Monoid
+
+
Returns a value summed n times (a + a + ...
+
+
multiply1p(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Ord.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Semigroup.Definition
+
 
+
multiply1p(int, A) - Method in class fj.Semigroup
+
+
Returns a value summed n + 1 times ( + a + a + ...
+
+
+ + + +

N

+
+
Natural - Class in fj.data
+
+
Represents a natural number (zero, one, two, etc.)
+
+
natural(BigInteger) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given BigInteger
+
+
natural(long) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given long
+
+
naturalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds natural numbers.
+
+
naturalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds natural numbers.
+
+
naturalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Natural
+
+
naturalEqual - Static variable in class fj.Equal
+
+
An equal instance for the Natural type.
+
+
naturalHash - Static variable in class fj.Hash
+
+
A hash instance for the Natural type.
+
+
naturalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of natural numbers.
+
+
naturalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of natural numbers.
+
+
naturalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies natural numbers.
+
+
naturalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies natural numbers.
+
+
naturalOrd - Static variable in class fj.Ord
+
+
An order instance for the Natural type.
+
+
naturalShow - Static variable in class fj.Show
+
+
A show instance for natural numbers.
+
+
negate - Static variable in class fj.function.BigIntegers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Doubles
+
+
Negation.
+
+
negate - Static variable in class fj.function.Integers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Longs
+
+
Negation.
+
+
nel(A, List<A>) - Static method in class fj.data.NonEmptyList
+
+
Return a non-empty list with the given head and tail.
+
+
nel(A, A...) - Static method in class fj.data.NonEmptyList
+
+
Constructs a non empty list from the given elements.
+
+
nel() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that puts an element into a non-empty list.
+
+
nel() - Method in class fj.data.Validation
+
+
Puts this validation's failing value in a non-empty list if there is one.
+
+
nelK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a NonEmptyList.
+
+
nelK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a NonEmptyList.
+
+
nelM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on non-empty lists.
+
+
nelM() - Method in class fj.F2W
+
+
Promotes this function to a function on non-empty lists.
+
+
next() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the next element in the list.
+
+
next_() - Static method in class fj.data.Zipper
+
+
First-class version of the next() function.
+
+
nextInt() - Method in class fj.LcgRng
+
 
+
nextInt() - Method in class fj.Rng
+
 
+
nextLong() - Method in class fj.LcgRng
+
 
+
nextLong() - Method in class fj.Rng
+
 
+
nextNatural() - Method in class fj.Rng
+
 
+
nif - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not if" (reverse nonimplication).
+
+
nil() - Static method in class fj.data.DList
+
+
A empty DList.
+
+
nil() - Static method in class fj.data.hlist.HList
+
+
Returns the empty list.
+
+
nil() - Static method in class fj.data.List
+
+
Returns an empty list.
+
+
nil() - Static method in class fj.data.List.Optic
+
+
Nil prism
+
+
nil() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nil_() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nimp - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not implies" (nonimplication).
+
+
Node<V,A> - Class in fj.data.fingertrees
+
+
An inner node of the 2-3 tree.
+
+
Node<K,V> - Class in fj.data.hamt
+
+
A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
+
+
Node(Either<P2<K, V>, HashArrayMappedTrie<K, V>>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(P2<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(HashArrayMappedTrie<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
node(A, P1<Stream<Tree<A>>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, Stream<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, List<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new n-ary given a root and a subforest of length n.
+
+
node() - Static method in class fj.data.Tree
+
+
First-class constructor of trees.
+
+
node2(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node.
+
+
node2(V2<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node
+
+
Node2<V,A> - Class in fj.data.fingertrees
+
+
A two-element inner tree node.
+
+
node3(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node.
+
+
node3(V3<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node
+
+
Node3<V,A> - Class in fj.data.fingertrees
+
+
A three-element inner tree node.
+
+
nodeMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for nodes.
+
+
nodeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
none() - Static method in class fj.data.Option
+
+
Constructs an optional value that has no value.
+
+
none() - Static method in class fj.data.Option.Optic
+
+
None prism
+
+
none_() - Static method in class fj.data.Option
+
 
+
NonEmptyList<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list with total head and tail.
+
+
nonEmptyListEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the NonEmptyList type.
+
+
nonEmptyListHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the NonEmptyList type.
+
+
nonEmptyListOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the NonEmptyList type.
+
+
nonEmptyListSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for non-empty lists.
+
+
nonEmptyListShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the NonEmptyList type.
+
+
nor - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not or".
+
+
normalise(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Normalises the given Callable by calling it and wrapping the result in a new Callable.
+
+
normalise() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the normalise function.
+
+
not() - Method in class fj.data.hamt.BitSet
+
 
+
not() - Method in class fj.Equal
+
+
An equal instance, which reverts equality for self
+
+
not - Static variable in class fj.function.Booleans
+
+
Logical negation.
+
+
not(F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
Negates the given predicate.
+
+
not(F0<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
not(E) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
notEq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are not equal, false otherwise.
+
+
now(A) - Static method in class fj.data.Eval
+
+
Constructs an eager evaluation by wrapping the given value.
+
+
nub() - Method in class fj.data.List
+
+
Removes duplicates according to object equality.
+
+
nub(Equal<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given equality.
+
+
nub(Ord<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given ordering.
+
+
nullable(F<A, B>) - Static method in class fj.Function
+
+
Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
+
+
nullablefindFirst(List<X>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value in the given list of optional values.
+
+
nullableVisitor(List<F<A, B>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
+
+
+ + + +

O

+
+
o(F<A, B>, F<C, A>) - Static method in class fj.F1Functions
+
+
Function composition
+
+
o(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function composition
+
+
o(F<C, A>) - Method in class fj.F1W
+
+
Function composition
+
+
o() - Method in class fj.F1W
+
+
First-class function composition
+
+
obtain() - Static method in class fj.control.parallel.Strategy
+
+
Returns a function which returns a product-1 which waits for the given Future to obtain a value.
+
+
obtain(Future<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a product-1 that waits for the given future to obtain a value.
+
+
on(F<B, A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<A, B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<T, E>) - Method in class fj.data.Validation.FailProjection
+
+
The failing value or the application of the given function to the success value.
+
+
on(F<E, T>) - Method in class fj.data.Validation
+
+
The success value or the application of the given function to the failing value.
+
+
on(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Begin definition of an equal instance.
+
+
on(F<A, B>, F<B, F<B, C>>) - Static method in class fj.F1Functions
+
+
Applies this function over the arguments of another function.
+
+
on(F<A, B>) - Static method in class fj.F1Functions
+
+
Applies this function over the arguments of another function.
+
+
on(F<B, F<B, C>>) - Method in class fj.F1W
+
+
Applies this function over the arguments of another function.
+
+
on() - Method in class fj.F1W
+
+
Applies this function over the arguments of another function.
+
+
on(F<A, F<A, C>>, F<B, A>) - Static method in class fj.Function
+
+
Applies a given function over the arguments of another function of arity-2.
+
+
on(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Begin definition of an ord instance.
+
+
one(A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of one element.
+
+
One<V,A> - Class in fj.data.fingertrees
+
+
A single-element prefix or suffix of a finger tree.
+
+
ONE - Static variable in class fj.data.Natural
+
+
The natural number one
+
+
onFail(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
+
+
onFail() - Method in class fj.F1W
+
+
Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
+
+
onLeft(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the left side of a given Either, or this function applied to the right side.
+
+
onLeft() - Method in class fj.F1W
+
+
Returns a function that returns the left side of a given Either, or this function applied to the right side.
+
+
onRight(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the right side of a given Either, or this function applied to the left side.
+
+
onRight() - Method in class fj.F1W
+
+
Returns a function that returns the right side of a given Either, or this function applied to the left side.
+
+
onSuccess(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
+
+
onSuccess() - Method in class fj.F1W
+
+
Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
+
+
option(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into an optional value.
+
+
option() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an optional value.
+
+
Option<A> - Class in fj.data
+
+
An optional value that may be none (no value) or some (a value).
+
+
option(B, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
option(F0<B>, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
Option.Optic - Class in fj.data
+
 
+
option_(B, F<A, B>) - Static method in class fj.data.Option
+
+
First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
+
+
Option_Array() - Static method in class fj.data.Conversions
+
+
A function that converts options to arrays.
+
+
Option_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to array blocking queues.
+
+
Option_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to array lists.
+
+
Option_BitSet - Static variable in class fj.data.Java
+
+
A function that converts options to bit sets.
+
+
Option_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts options to concurrent linked queues.
+
+
Option_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array lists.
+
+
Option_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array sets.
+
+
Option_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts options to delay queues.
+
+
Option_Either() - Static method in class fj.data.Conversions
+
+
A function that converts options to eithers.
+
+
Option_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts options to enum sets.
+
+
Option_HashSet() - Static method in class fj.data.Java
+
+
A function that converts options to hash sets.
+
+
Option_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to linked blocking queues.
+
+
Option_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts options to linked hash sets.
+
+
Option_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts options to linked lists.
+
+
Option_List() - Static method in class fj.data.Conversions
+
+
A function that converts options to lists.
+
+
Option_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority blocking queues.
+
+
Option_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority queues.
+
+
Option_PriorityQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_PriorityQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_Stack() - Static method in class fj.data.Java
+
+
A function that converts options to stacks.
+
+
Option_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts options to streams.
+
+
Option_String - Static variable in class fj.data.Conversions
+
+
A function that converts options to strings.
+
+
Option_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts options to string buffers.
+
+
Option_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts options to string builders.
+
+
Option_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to synchronous queues.
+
+
Option_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts options to tree sets.
+
+
Option_Vector() - Static method in class fj.data.Java
+
+
A function that converts options to vectors.
+
+
Optional<S,A> - Class in fj.data.optic
+
+
POptional restricted to monomorphic update
+
+
Optional(POptional<S, S, A, A>) - Constructor for class fj.data.optic.Optional
+
 
+
optional(F<S, Option<A>>, F<A, F<S, S>>) - Static method in class fj.data.optic.Optional
+
 
+
optionEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Option type.
+
+
optionHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Option type.
+
+
optionK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in an Option.
+
+
optionK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in an Option.
+
+
optionM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Options.
+
+
optionM() - Method in class fj.F2W
+
+
Promotes this function to a function on Options.
+
+
optionMonoid() - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Monoid.firstOptionMonoid().
+
+
+
optionOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Option type.
+
+
optionSemigroup() - Static method in class fj.Semigroup
+
+
Deprecated. +
since 4.7. Use Semigroup.firstOptionSemigroup().
+
+
+
optionShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Option type.
+
+
or(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
or - Static variable in class fj.function.Booleans
+
+
Curried form of logical "inclusive or" (disjunction).
+
+
or(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns composed predicate using disjunction
+
+
or(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given list is true.
+
+
or(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given stream is true.
+
+
or(F0<Parser<I, A, E>>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(F0<Parser<I, A, E>>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
orAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
orAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given Stream of predicates
+
+
ord() - Method in class fj.data.Set
+
+
Returns the order of this Set.
+
+
ord(Ord<A>) - Static method in class fj.data.Zipper
+
+
An Ord instance for Zippers.
+
+
Ord<A> - Class in fj
+
+
Tests for ordering between two objects.
+
+
ord() - Method in interface fj.Ord.Definition
+
+
Build an ord instance from this definition.
+
+
ord(F<A, F<A, Ordering>>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
ord(F2<A, A, Ordering>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
Ord.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Ord: alternative minimal definition and overridable methods.
+
+
Ord.Definition<A> - Interface in fj
+
+
Primitives functions of Ord: minimal definition and overridable methods.
+
+
ordDef(Ord.Definition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
ordDef(Ord.AltDefinition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
order() - Method in class fj.data.Enumerator
+
+
Returns the ordering for the enumerator.
+
+
Ordering - Enum in fj
+
+
The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
+
+
orderingEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Ordering.
+
+
orderingOrd - Static variable in class fj.Ord
+
+
An order instance for the Ordering type.
+
+
ordMaxMonoid(Ord<A>, A) - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Ord.maxMonoid(Object)
+
+
+
orElse(F0<Option<A>>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orElse(Option<A>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orFail(F0<E>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orFail(E) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orHead(F0<A>) - Method in class fj.data.List
+
+
Returns the head of this list if there is one or the given argument if this list is empty.
+
+
orHead(F0<A>) - Method in class fj.data.Stream
+
+
Returns the head of this stream if there is one or the given argument if this stream is empty.
+
+
orSome(F0<A>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSome(A) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSuccess(F0<T>) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orSuccess(T) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orTail(F0<List<A>>) - Method in class fj.data.List
+
+
Returns the tail of this list if there is one or the given argument if this list is empty.
+
+
orTail(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Returns the tail of this stream if there is one or the given argument if this stream is empty.
+
+
orValue(F0<A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(A) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(F0<B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the given argument.
+
+
+ + + +

P

+
+
p(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
p() - Method in class fj.data.TreeZipper
+
+
Returns the product-4 representation of this zipper.
+
+
p(P2<A, A>) - Static method in class fj.data.vector.V2
+
+
Creates a vector-2 from a homogeneous product-2.
+
+
p() - Method in class fj.data.vector.V2
+
+
Returns a homogeneous product-2 equivalent to this vector.
+
+
p(P3<A, A, A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a homogeneous product-3.
+
+
p() - Method in class fj.data.vector.V3
+
+
Returns a homogeneous product-3 equivalent to this vector.
+
+
p(P4<A, A, A, A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a homogeneous product-4.
+
+
p() - Method in class fj.data.vector.V4
+
+
Returns a homogeneous product-4 equivalent to this vector.
+
+
p(P5<A, A, A, A, A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a homogeneous product-5.
+
+
p() - Method in class fj.data.vector.V5
+
+
Returns a homogeneous product-5 equivalent to this vector.
+
+
p(P6<A, A, A, A, A, A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a homogeneous product-6.
+
+
p() - Method in class fj.data.vector.V6
+
+
Returns a homogeneous product-6 equivalent to this vector.
+
+
p(P7<A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a homogeneous product-7.
+
+
p() - Method in class fj.data.vector.V7
+
+
Returns a homogeneous product-7 equivalent to this vector.
+
+
p(P8<A, A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a homogeneous product-8.
+
+
p() - Method in class fj.data.vector.V8
+
+
Returns a homogeneous product-8 equivalent to this vector.
+
+
p() - Method in class fj.data.Zipper
+
+
Returns the product-3 representation of this Zipper.
+
+
P - Class in fj
+
+
Functions across products.
+
+
p(A) - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
p(A, B) - Static method in class fj.P
+
+
A function that puts elements in a product-2.
+
+
p(A, B, C) - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
p(A, B, C, D) - Static method in class fj.P
+
+
A function that puts elements in a product-4.
+
+
p(A, B, C, D, E) - Static method in class fj.P
+
+
A function that puts elements in a product-5.
+
+
p(A, B, C, D, E, F$) - Static method in class fj.P
+
+
A function that puts elements in a product-6.
+
+
p(A, B, C, D, E, F$, G) - Static method in class fj.P
+
+
A function that puts elements in a product-7.
+
+
p(A, B, C, D, E, F$, G, H) - Static method in class fj.P
+
+
A function that puts elements in a product-8.
+
+
p1() - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
P1<A> - Class in fj
+
 
+
P1() - Constructor for class fj.P1
+
 
+
P1_Callable() - Static method in class fj.data.Java
+
 
+
p1Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a product-1.
+
+
p1Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a product-1.
+
+
p1Ord(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for a product-1.
+
+
p1Semigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for unary products.
+
+
p1Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for the tuple-1 type.
+
+
p1ShowEager(Show<A>) - Static method in class fj.Show
+
 
+
p1ShowLazy(Show<A>) - Static method in class fj.Show
+
 
+
p2() - Static method in class fj.P
+
+
A function that puts an element in a product-2.
+
+
P2<A,B> - Class in fj
+
+
A product-2.
+
+
P2() - Constructor for class fj.P2
+
 
+
P2.Optic - Class in fj
+
+
Optic factory methods for a P2
+
+
p2Equal(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for a product-2.
+
+
p2Hash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for a product-2.
+
+
p2MapShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type in the style of a mapping from A to B.
+
+
p2Node(P2<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
p2Ord(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for a product-2, with the first factor considered most significant.
+
+
p2Ord1(Ord<A>) - Static method in class fj.Ord
+
 
+
p2Ord2(Ord<B>) - Static method in class fj.Ord
+
 
+
p2Semigroup(Semigroup<A>, Semigroup<B>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for binary products.
+
+
p2Show(Show<A>, Show<B>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p2Show(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p3() - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
P3<A,B,C> - Class in fj
+
+
A product-3.
+
+
P3() - Constructor for class fj.P3
+
 
+
p3Equal(Equal<A>, Equal<B>, Equal<C>) - Static method in class fj.Equal
+
+
An equal instance for a product-3.
+
+
p3Hash(Hash<A>, Hash<B>, Hash<C>) - Static method in class fj.Hash
+
+
A hash instance for a product-3.
+
+
p3Ord(Ord<A>, Ord<B>, Ord<C>) - Static method in class fj.Ord
+
+
An order instance for a product-3, with the first factor considered most significant.
+
+
p3Show(Show<A>, Show<B>, Show<C>) - Static method in class fj.Show
+
+
A show instance for the tuple-3 type.
+
+
p4() - Static method in class fj.P
+
+
A function that puts an element in a product-4.
+
+
P4<A,B,C,D> - Class in fj
+
+
A product-4.
+
+
P4() - Constructor for class fj.P4
+
 
+
p4Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>) - Static method in class fj.Equal
+
+
An equal instance for a product-4.
+
+
p4Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>) - Static method in class fj.Hash
+
+
A hash instance for a product-4.
+
+
p4Show(Show<A>, Show<B>, Show<C>, Show<D>) - Static method in class fj.Show
+
+
A show instance for the tuple-4 type.
+
+
p5() - Static method in class fj.P
+
+
A function that puts an element in a product-5.
+
+
P5<A,B,C,D,E> - Class in fj
+
+
A product-5.
+
+
P5() - Constructor for class fj.P5
+
 
+
p5Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>) - Static method in class fj.Equal
+
+
An equal instance for a product-5.
+
+
p5Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>) - Static method in class fj.Hash
+
+
A hash instance for a product-5.
+
+
p5Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>) - Static method in class fj.Show
+
+
A show instance for the tuple-5 type.
+
+
p6() - Static method in class fj.P
+
+
A function that puts an element in a product-6.
+
+
P6<A,B,C,D,E,F> - Class in fj
+
+
A product-6.
+
+
P6() - Constructor for class fj.P6
+
 
+
p6Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>) - Static method in class fj.Equal
+
+
An equal instance for a product-6.
+
+
p6Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>) - Static method in class fj.Hash
+
+
A hash instance for a product-6.
+
+
p6Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>) - Static method in class fj.Show
+
+
A show instance for the tuple-6 type.
+
+
p7() - Static method in class fj.P
+
+
A function that puts an element in a product-7.
+
+
P7<A,B,C,D,E,F,G> - Class in fj
+
+
A product-7.
+
+
P7() - Constructor for class fj.P7
+
 
+
p7Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>) - Static method in class fj.Equal
+
+
An equal instance for a product-7.
+
+
p7Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>) - Static method in class fj.Hash
+
+
A hash instance for a product-7.
+
+
p7Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>) - Static method in class fj.Show
+
+
A show instance for the tuple-7 type.
+
+
p8() - Static method in class fj.P
+
+
A function that puts an element in a product-8.
+
+
P8<A,B,C,D,E,F,G,H> - Class in fj
+
+
A product-8.
+
+
P8() - Constructor for class fj.P8
+
 
+
p8Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>, Equal<H>) - Static method in class fj.Equal
+
+
An equal instance for a product-8.
+
+
p8Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>, Hash<H>) - Static method in class fj.Hash
+
+
A hash instance for a product-8.
+
+
p8Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>, Show<H>) - Static method in class fj.Show
+
+
A show instance for the tuple-8 type.
+
+
p_() - Static method in class fj.data.TreeZipper
+
+
A first-class function that returns the product-4 representation of a given zipper.
+
+
p_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to the equivalent product-2.
+
+
p_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to the equivalent product-3.
+
+
p_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to the equivalent product-4.
+
+
p_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to the equivalent product-5.
+
+
p_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to the equivalent product-6.
+
+
p_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to the equivalent product-7.
+
+
p_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to the equivalent product-8.
+
+
p_() - Static method in class fj.data.Zipper
+
+
A first-class function that yields the product-3 representation of a given Zipper.
+
+
par(P1<A>) - Method in class fj.control.parallel.Strategy
+
+
Apply the strategy to the given product-1.
+
+
parent() - Method in class fj.data.TreeZipper
+
+
Navigates to the parent of the current location.
+
+
parents() - Method in class fj.data.TreeZipper
+
+
Returns the parents of the currently focused node.
+
+
parExtend(Zipper<A>, F<Zipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given zipper in parallel.
+
+
parExtend(Tree<A>, F<Tree<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all subtrees of the given Tree in parallel.
+
+
parExtend(TreeZipper<A>, F<TreeZipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given TreeZipper in parallel.
+
+
parExtend(NonEmptyList<A>, F<NonEmptyList<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all sublists of the given NonEmptyList in parallel.
+
+
parFlatMap(List<A>, F<A, List<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a list-valued function across a list in parallel, concatenating the results into a new list.
+
+
parFlatMap(Stream<A>, F<A, Stream<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
+
+
parFlatMap(Array<A>, F<A, Array<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
+
+
parFlatMap(Iterable<A>, F<A, Iterable<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
+
+
parFlatMap(Strategy<List<B>>, F<A, List<B>>, List<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given list, using the given strategy, with a final join.
+
+
parFlatMap(Strategy<Array<B>>, F<A, Array<B>>, Array<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given array, using the given strategy, with a final join.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>, F<Stream<A>, P2<Stream<A>, Stream<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>, F<Iterable<A>, P2<Iterable<A>, Iterable<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
+
+
parList(List<P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Evaluates a list of product-1s in parallel.
+
+
parListChunk(Strategy<List<A>>, int, List<P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Sequentially evaluates chunks (sub-sequences) of a list in parallel.
+
+
parMap(List<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a list in parallel.
+
+
parMap(NonEmptyList<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a nonempty list in parallel.
+
+
parMap(Stream<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a Stream in parallel.
+
+
parMap(Iterable<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Iterable in parallel.
+
+
parMap(Array<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Array in parallel.
+
+
parMap(Zipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Zipper in parallel.
+
+
parMap(Tree<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Tree in parallel.
+
+
parMap(TreeZipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a TreeZipper in parallel.
+
+
parMap(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given list in parallel using this strategy.
+
+
parMap(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given array in parallel using this strategy.
+
+
parMap1(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over lists.
+
+
parMap1(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over arrays.
+
+
parMapArray() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an array in parallel.
+
+
parMapArray(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on arrays using this strategy.
+
+
parMapArray() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on arrays.
+
+
parMapArray1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on arrays (parallel array functor).
+
+
parMapIterable() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an iterable in parallel.
+
+
parMapList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a list in parallel.
+
+
parMapList(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on lists using this strategy.
+
+
parMapList() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on lists.
+
+
parMapList1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on lists (parallel list functor).
+
+
parMapStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a stream in parallel.
+
+
parMapTree() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps across a Tree in parallel.
+
+
ParModule - Class in fj.control.parallel
+
+
A module of higher-order concurrency features.
+
+
parModule(Strategy<Unit>) - Static method in class fj.control.parallel.ParModule
+
+
Constructor method for ParModule
+
+
parse(I) - Method in class fj.parser.Parser
+
+
Parses the input to produce a result or error.
+
+
parseByte - Static variable in class fj.data.Option
+
+
A function that parses a string to a byte.
+
+
parseByte - Static variable in class fj.data.Validation
+
+
A function that parses a string into a byte.
+
+
parseByte(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a byte.
+
+
parseDouble - Static variable in class fj.data.Option
+
+
A function that parses a string to a double.
+
+
parseDouble - Static variable in class fj.data.Validation
+
+
A function that parses a string into a double.
+
+
parseDouble(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a double.
+
+
parseFloat - Static variable in class fj.data.Option
+
+
A function that parses a string to a float.
+
+
parseFloat - Static variable in class fj.data.Validation
+
+
A function that parses a string into a float.
+
+
parseFloat(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a float.
+
+
parseInt - Static variable in class fj.data.Option
+
+
A function that parses a string to an integer.
+
+
parseInt - Static variable in class fj.data.Validation
+
+
A function that parses a string into an integer.
+
+
parseInt(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a integer.
+
+
parseLong - Static variable in class fj.data.Option
+
+
A function that parses a string to a long.
+
+
parseLong - Static variable in class fj.data.Validation
+
+
A function that parses a string into a long.
+
+
parseLong(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a long.
+
+
Parser<I,A,E> - Class in fj.parser
+
+
A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
+
+
parser(F<I, Validation<E, Result<I, A>>>) - Static method in class fj.parser.Parser
+
+
Returns a parser that computes using the given function.
+
+
Parser.CharsParser - Class in fj.parser
+
+
Parsers that accept Stream<Character> input.
+
+
Parser.StreamParser - Class in fj.parser
+
+
Parsers that accept Stream input.
+
+
parseShort - Static variable in class fj.data.Option
+
+
A function that parses a string to a short.
+
+
parseShort - Static variable in class fj.data.Validation
+
+
A function that parses a string into a short.
+
+
parseShort(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a short.
+
+
partialApply2(F<A, F<B, C>>, B) - Static method in class fj.Function
+
+
Partial application of the second argument to the supplied function to get a function of type + A -> C.
+
+
partialApply3(F<A, F<B, F<C, D>>>, C) - Static method in class fj.Function
+
+
Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
+
+
partialApply4(F<A, F<B, F<C, F<D, E>>>>, D) - Static method in class fj.Function
+
+
Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
+
+
partialApply5(F<A, F<B, F<C, F<D, F<E, F$>>>>>, E) - Static method in class fj.Function
+
+
Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
+
+
partialApply6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>, F$) - Static method in class fj.Function
+
+
Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
+
+
partialApply7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>, G) - Static method in class fj.Function
+
+
Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
+
+
partialApply8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>, H) - Static method in class fj.Function
+
+
Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
+
+
partition(int) - Method in class fj.data.List
+
+
Splits this list into lists of the given size.
+
+
partition(F<A, Boolean>) - Method in class fj.data.List
+
+
Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
+
+
partition(List<Validation<A, B>>) - Static method in class fj.data.Validation
+
+
Partitions the list into the list of fails and the list of successes
+
+
parZipArrayWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
+
+
parZipListWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
+
+
parZipWith(List<A>, List<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two lists together with a given function, in parallel.
+
+
parZipWith(Stream<A>, Stream<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two streams together with a given function, in parallel.
+
+
parZipWith(Array<A>, Array<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two arrays together with a given function, in parallel.
+
+
parZipWith(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two iterables together with a given function, in parallel.
+
+
parZipWith(F2<B, C, A>, List<B>, List<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two lists in parallel using a given function, with this strategy.
+
+
parZipWith(F2<B, C, A>, Array<B>, Array<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two arrays in parallel using a given function, with this strategy.
+
+
pCodiagonal() - Static method in class fj.data.optic.PSetter
+
 
+
pCodiagonal() - Static method in class fj.data.optic.PTraversal
+
 
+
peek() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that returns the first element of the input
+
+
pId() - Static method in class fj.data.optic.PIso
+
+
create a PIso between any type and itself.
+
+
pId() - Static method in class fj.data.optic.PLens
+
 
+
pId() - Static method in class fj.data.optic.POptional
+
 
+
pId() - Static method in class fj.data.optic.PPrism
+
 
+
pId() - Static method in class fj.data.optic.PSetter
+
 
+
pId() - Static method in class fj.data.optic.PTraversal
+
 
+
PIso<S,T,A,B> - Class in fj.data.optic
+
+
A PIso defines an isomorphism between types S, A and B, T:
+
+
pIso(F<S, A>, F<B, T>) - Static method in class fj.data.optic.PIso
+
+
create a PIso using a pair of functions: one to get the target and one to get the source.
+
+
PLens<S,T,A,B> - Class in fj.data.optic
+
+
A PLens can be seen as a pair of functions: - `get: S => A` i.e.
+
+
pLens(F<S, A>, F<B, F<S, T>>) - Static method in class fj.data.optic.PLens
+
+
create a PLens using a pair of functions: one to get the target, one to set the target.
+
+
plus() - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(long) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A, long) - Method in class fj.data.Enumerator
+
+
Moves a value along the enumerator a given number of times.
+
+
POptional<S,T,A,B> - Class in fj.data.optic
+
+
A POptional can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `set : (B, S) => T` + + A POptional could also be defined as a weaker PLens and weaker PPrism + + POptional stands for Polymorphic Optional as it set and modify methods change a type `A` to `B` and `S` to `T`.
+
+
pOptional(F<S, Either<T, A>>, F<B, F<S, T>>) - Static method in class fj.data.optic.POptional
+
+
create a POptional using the canonical functions: getOrModify and set
+
+
positions() - Method in class fj.data.TreeZipper
+
+
Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern).
+
+
positions() - Method in class fj.data.Zipper
+
+
Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
+
+
power - Static variable in class fj.function.BigIntegers
+
+
Power.
+
+
power - Static variable in class fj.function.Doubles
+
+
Power.
+
+
power - Static variable in class fj.function.Integers
+
+
Power.
+
+
PPrism<S,T,A,B> - Class in fj.data.optic
+
+
A PPrism can be seen as a pair of functions: - `getOrModify: S => T \/ A` - `reverseGet : B => T` + + A PPrism could also be defined as a weaker PIso where get can fail.
+
+
pPrism(F<S, Either<T, A>>, F<B, T>) - Static method in class fj.data.optic.PPrism
+
+
create a PPrism using the canonical functions: getOrModify and reverseGet
+
+
pred() - Method in class fj.data.Natural
+
+
Return the predecessor of this natural number
+
+
pred_() - Static method in class fj.data.Natural
+
+
First-class predecessor function.
+
+
predecessor() - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator in curried form.
+
+
predecessor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator.
+
+
prefix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the first few elements of this tree.
+
+
prepend(A) - Method in interface fj.Monoid.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.Definition
+
 
+
prepend(A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Semigroup.Definition
+
 
+
prependToList(List<A>) - Method in class fj.data.List.Buffer
+
+
Prepends the elements of this buffer to the given list.
+
+
previous() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the previous element in the list.
+
+
previous_() - Static method in class fj.data.Zipper
+
+
First-class version of the previous() function.
+
+
Primitive - Class in fj
+
+
Functions that convert between Java primitive types.
+
+
print(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream.
+
+
println(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream with a new line.
+
+
printlnE(A) - Method in class fj.Show
+
+
Prints the given argument to the standard error stream with a new line.
+
+
PriorityBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority blocking queues to lists.
+
+
PriorityQueue<K,A> - Class in fj.data
+
+
A priority queue implementation backed by a + FingerTree.
+
+
priorityQueue(Equal<K>, FingerTree<K, P2<K, A>>) - Static method in class fj.data.PriorityQueue
+
+
Creates a priority queue from a finger tree.
+
+
PriorityQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority queues to lists.
+
+
priorityQueueShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
Prism<S,A> - Class in fj.data.optic
+
+
PPrism restricted to monomorphic update
+
+
Prism(PPrism<S, S, A, A>) - Constructor for class fj.data.optic.Prism
+
 
+
prism(F<S, Option<A>>, F<A, S>) - Static method in class fj.data.optic.Prism
+
 
+
product(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a stream of natural numbers.
+
+
product(List<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a list of natural numbers.
+
+
product(Getter<S1, A1>) - Method in class fj.data.optic.Getter
+
+
pair two disjoint Getter
+
+
product(Iso<S1, A1>) - Method in class fj.data.optic.Iso
+
+
pair two disjoint Iso
+
+
product(PIso<S1, T1, A1, B1>) - Method in class fj.data.optic.PIso
+
+
pair two disjoint PIso
+
+
product(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Returns the product of a list of big integers.
+
+
product(List<Double>) - Static method in class fj.function.Doubles
+
+
Returns the product of a list of doubles.
+
+
product(List<Integer>) - Static method in class fj.function.Integers
+
+
Returns the product of a list of integers.
+
+
promise() - Method in class fj.control.parallel.Actor
+
+
Transforms this actor to an actor on promises.
+
+
promise(P1<A>) - Method in class fj.control.parallel.ParModule
+
+
Evaluates the given product concurrently and returns a Promise of the result.
+
+
promise() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that evaluates a given product concurrently and returns a Promise of the result.
+
+
promise(F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
promise(F2<A, B, C>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
Promise<A> - Class in fj.control.parallel
+
+
Represents a non-blocking future value.
+
+
promise(Strategy<Unit>, P1<A>) - Static method in class fj.control.parallel.Promise
+
+
Promises to provide the value of the given 1-product, in the future.
+
+
promise(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
Provides a first-class unit function for promises.
+
+
promise(Strategy<Unit>, Callable<A>) - Static method in class fj.control.parallel.Promise
+
+
Provides a promise to call the given Callable in the future.
+
+
promise(Strategy<Unit>, F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Transforms any function so that it returns a promise of a value instead of an actual value.
+
+
promiseK(F<A, B>, Strategy<Unit>) - Static method in class fj.F1Functions
+
+
Promotes this function to a concurrent function that returns a Promise of a value.
+
+
promiseK(Strategy<Unit>) - Method in class fj.F1W
+
+
Promotes this function to a concurrent function that returns a Promise of a value.
+
+
promiseM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Promises.
+
+
promiseM() - Method in class fj.F2W
+
+
Promotes this function to a function on Promises.
+
+
promisePure() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that promotes a given function to a concurrent function that returns a Promise.
+
+
PSetter<S,T,A,B> - Class in fj.data.optic
+
+
A PSetter is a generalisation of Functor map: - `map: (A => B) => F[A] => F[B]` - `modify: (A => B) => S => + T` + + PSetter stands for Polymorphic Setter as it set and modify methods change a type `A` to `B` and `S` to `T`.
+
+
pSetter(F<F<A, B>, F<S, T>>) - Static method in class fj.data.optic.PSetter
+
 
+
pSome() - Static method in class fj.data.Option.Optic
+
+
Polymorphic Some prism
+
+
pTraversal() - Static method in class fj.data.List.Optic
+
+
Polymorphic traversal
+
+
PTraversal<S,T,A,B> - Class in fj.data.optic
+
+
A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
+
+
PTraversal() - Constructor for class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F3<B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F4<B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<B, B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pure() - Static method in class fj.control.Trampoline
+
 
+
pure(A) - Static method in class fj.control.Trampoline
+
+
Constructs a pure computation that results in the given value.
+
+
put(S) - Static method in class fj.data.State
+
 
+
+ + + +

Q

+
+
queueActor(Strategy<Unit>, Effect1<T>) - Static method in class fj.control.parallel.Actor
+
+
An Actor equipped with a queue and which is guaranteed to process one message at a time.
+
+
+ + + +

R

+
+
range(int, int) - Static method in class fj.data.Array
+
+
Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, int) - Method in class fj.data.hamt.BitSet
+
+
Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g.
+
+
range(int, int) - Static method in class fj.data.List
+
+
Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, long) - Static method in class fj.data.Stream
+
+
Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(Enumerator<A>, A, A) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
+
+
range(Enumerator<A>, A, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
+
+
range(int) - Static method in class fj.data.Stream
+
+
Returns an infinite stream of integers from the given from value (inclusive).
+
+
range(int, int) - Method in class fj.Rng
+
 
+
re() - Method in class fj.data.optic.PPrism
+
+
create a Getter from the modified target to the modified source of a PPrism
+
+
reader(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state reader given a connection URL.
+
+
reader(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new reader that reads the database via the given Connector.
+
+
Reader<A,B> - Class in fj.data
+
+
The Reader monad (also called the function monad, so equivalent to the idea of F).
+
+
Reader(F<A, B>) - Constructor for class fj.data.Reader
+
 
+
readerState() - Static method in class fj.data.IOFunctions
+
 
+
reduce(Either<A, A>) - Static method in class fj.data.Either
+
+
Takes an Either to its contained value within left or right.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
remainder - Static variable in class fj.function.BigIntegers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Doubles
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Integers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Longs
+
+
Remainder.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
+
+
repeat(A) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given element.
+
+
repeat() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser zero or many times.
+
+
repeat1() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser one or many times.
+
+
replace(F<A, Boolean>, A) - Method in class fj.data.Stream
+
+
Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
+
+
replace(A) - Method in class fj.data.Zipper
+
+
Replaces the element in focus with the given element.
+
+
replicate(int, A) - Static method in class fj.data.List
+
+
Returns a list of the given value replicated the given number of times.
+
+
replicateM(IO<A>, int) - Static method in class fj.data.IOFunctions
+
 
+
rest() - Method in class fj.parser.Result
+
+
The remainder of the parse input.
+
+
Result<I,A> - Class in fj.parser
+
+
A parse result made up of a value (A) and the remainder of the parse input (I).
+
+
result(I, A) - Static method in class fj.parser.Result
+
+
Construct a result with the given remainder of the parse input and parse value.
+
+
result() - Static method in class fj.parser.Result
+
+
First-class construction of a result.
+
+
resultEqual(Equal<A>, Equal<I>) - Static method in class fj.Equal
+
 
+
resultHash(Hash<A>, Hash<I>) - Static method in class fj.Hash
+
+
A hash instance for the Result type.
+
+
resultShow(Show<A>, Show<I>) - Static method in class fj.Show
+
+
A show instance for the Result type.
+
+
resume() - Method in class fj.control.Trampoline
+
+
Runs a single step of this computation.
+
+
resume_() - Static method in class fj.control.Trampoline
+
 
+
reverse() - Method in class fj.data.Array.ImmutableProjection
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.Array
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.LazyString
+
+
Returns the reverse of this string.
+
+
reverse() - Method in class fj.data.List
+
+
Reverse this list in constant stack space.
+
+
reverse() - Method in class fj.data.NonEmptyList
+
+
Reverse this non empty list in constant stack space.
+
+
reverse() - Method in class fj.data.optic.Iso
+
 
+
reverse() - Method in class fj.data.optic.PIso
+
+
reverse a PIso: the source becomes the target and the target becomes the source
+
+
reverse() - Method in class fj.data.Stream
+
+
Reverse this stream in constant stack space.
+
+
reverse() - Method in class fj.Ord
+
 
+
reverse() - Method in enum fj.Ordering
+
 
+
reverseBytes - Static variable in class fj.function.Characters
+
 
+
reverseGet(A) - Method in class fj.data.optic.Iso
+
 
+
reverseGet(B) - Method in class fj.data.optic.PIso
+
+
get the modified source of a PIso
+
+
reverseGet(B) - Method in class fj.data.optic.PPrism
+
+
get the modified source of a PPrism
+
+
reverseGet(A) - Method in class fj.data.optic.Prism
+
 
+
right() - Method in class fj.data.Either
+
+
Projects this either as a right.
+
+
right(B) - Static method in class fj.data.Either
+
+
Construct a right value of either.
+
+
right() - Method in class fj.data.TreeZipper
+
+
Navigates to the right sibling of the current location.
+
+
right_() - Static method in class fj.data.Either
+
+
A function that constructs a right value of either.
+
+
right_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the right() function.
+
+
rightMap_() - Static method in class fj.data.Either
+
 
+
rights(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the right values in the given list.
+
+
rights() - Method in class fj.data.TreeZipper
+
+
Returns the right siblings of the currently focused node.
+
+
rights() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the right of focus.
+
+
Rng - Class in fj
+
+
Created by MarkPerry on 7/07/2014.
+
+
Rng() - Constructor for class fj.Rng
+
 
+
root() - Method in class fj.data.Tree
+
+
Returns the root element of the tree.
+
+
root() - Method in class fj.data.TreeZipper
+
+
Navigates to the top-most parent of the current location.
+
+
root_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its root.
+
+
root_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the root function.
+
+
run(Connection) - Method in class fj.control.db.DB
+
+
Executes the database action, given a database connection.
+
+
run(DB<A>) - Method in class fj.control.db.DbState
+
+
Runs the given database action as a single transaction.
+
+
run() - Method in class fj.control.Trampoline
+
+
Runs this computation all the way to the end, in constant stack.
+
+
run() - Method in class fj.data.DList
+
+
Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
+
+
run() - Method in interface fj.data.IO
+
 
+
run() - Method in class fj.data.IOW
+
 
+
run() - Method in class fj.data.Iteratee.IterV
+
 
+
run() - Method in interface fj.data.SafeIO
+
 
+
run(S) - Method in class fj.data.State
+
 
+
run() - Method in class fj.data.Writer
+
 
+
runSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Run io, rethrowing any IOException wrapped in a RuntimeException
+
+
+ + + +

S

+
+
safe() - Method in class fj.data.IOW
+
 
+
SafeIO<A> - Interface in fj.data
+
+
Created by MarkPerry on 3/07/2014.
+
+
satisfy(F0<E>, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
satisfy(E, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
scanLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a fold left accummulating and returns an array of the intermediate results.
+
+
scanLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating and returns an array of the intermediate results.
+
+
scanLeft1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanLeft1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
second() - Method in class fj.data.optic.Getter
+
 
+
second() - Method in class fj.data.optic.Iso
+
 
+
second() - Method in class fj.data.optic.Optional
+
 
+
second() - Method in class fj.data.optic.PIso
+
 
+
second() - Method in class fj.data.optic.POptional
+
 
+
semigroup() - Method in class fj.Monoid
+
+
Returns a semigroup projection of this monoid.
+
+
Semigroup<A> - Class in fj
+
+
Implementations must satisfy the law of associativity: + + Associativity; forall x.
+
+
semigroup(F<A, F<A, A>>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
semigroup(F2<A, A, A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
Semigroup.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Semigroup: alternative minimal definition and overridable methods.
+
+
Semigroup.Definition<A> - Interface in fj
+
+
Primitives functions of Semigroup: minimal definition and overridable methods.
+
+
semigroupDef(Semigroup.Definition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
semigroupDef(Semigroup.AltDefinition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
Seq<A> - Class in fj.data
+
+
Provides an immutable finite sequence, implemented as a finger tree.
+
+
seq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given elements.
+
+
seq(List<A>) - Static method in class fj.data.Seq
+
+
Deprecated. +
As of release 4.5, use Seq.listSeq(List)
+
+
+
seqEqual(Equal<A>) - Static method in class fj.Equal
+
 
+
seqHash(Hash<A>) - Static method in class fj.Hash
+
 
+
seqShow(Show<A>) - Static method in class fj.Show
+
 
+
seqStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
+
+
sequence(List<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a List of Callables into a single Callable of a List.
+
+
sequence(List<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
List iteration inside a Promise.
+
+
sequence(Stream<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Stream iteration inside a Promise.
+
+
sequence(P1<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Traverses a product-1 inside a promise.
+
+
sequence(Strategy<Unit>, List<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a List of promises into a single promise of a List.
+
+
sequence(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a List.
+
+
sequence(Strategy<Unit>, Stream<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a Stream of promises into a single promise of a Stream.
+
+
sequence(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Transforms a product of a promise to a promise of a product.
+
+
sequence(Array<B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Array<B>) - Method in class fj.data.Array
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Either<X, B>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
sequence(Either<A, X>) - Method in class fj.data.Either.RightProjection
+
+
Anonymous bind through this projection.
+
+
sequence(List<IO<A>>) - Static method in class fj.data.IOFunctions
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
sequence(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
+
+
sequence(List<B>) - Method in class fj.data.List
+
+
Performs a bind across each list element, but ignores the element value each time.
+
+
sequence(Option<B>) - Method in class fj.data.Option
+
+
Performs a bind across the optional value, but ignores the element value in the function.
+
+
sequence(List<Option<A>>) - Static method in class fj.data.Option
+
+
Sequence through the option monad.
+
+
sequence(List<State<S, A>>) - Static method in class fj.data.State
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<B>) - Method in class fj.data.Stream
+
+
Performs a bind across each stream element, but ignores the element value each time.
+
+
sequence(IO<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Option<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Validation<A, T>) - Method in class fj.data.Validation.FailProjection
+
+
Performs a bind across the validation, but ignores the element value in the function.
+
+
sequence(Validation<E, A>) - Method in class fj.data.Validation
+
+
Anonymous bind through this validation.
+
+
sequence(Semigroup<E>, List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
+
+
sequence(List<P1<A>>) - Static method in class fj.P1
+
+
Turns a List of P1s into a single P1 of a List.
+
+
sequence(Stream<P1<A>>) - Static method in class fj.P1
+
+
Turns a stream of P1s into a single P1 of a stream.
+
+
sequence(Option<P1<A>>) - Static method in class fj.P1
+
+
Turns an optional P1 into a lazy option.
+
+
sequence(Array<P1<A>>) - Static method in class fj.P1
+
+
Turns an array of P1s into a single P1 of an array.
+
+
sequence(Parser<I, B, E>) - Method in class fj.parser.Parser
+
+
Binds anonymously, ignoring the result value.
+
+
sequence(List<Parser<I, A, E>>) - Static method in class fj.parser.Parser
+
+
Sequence the list of parsers through Parser.bind(fj.F<A, fj.parser.Parser<I, B, E>>).
+
+
sequence_() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the sequence method.
+
+
sequence_(List<F<B, A>>) - Static method in class fj.data.List
+
+
Turn a list of functions into a function returning a list.
+
+
sequence_(Stream<F<B, A>>) - Static method in class fj.data.Stream
+
+
Turn a stream of functions into a function returning a stream.
+
+
sequenceLeft(List<Either<A, X>>) - Static method in class fj.data.Either
+
+
Sequences through the left side of the either monad with a list of values.
+
+
sequenceList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a list inside a promise.
+
+
sequenceList() - Static method in class fj.P1
+
+
A first-class version of the sequence method for lists of P1s.
+
+
sequenceNonCumulative(List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values.
+
+
sequenceRight(List<Either<X, B>>) - Static method in class fj.data.Either
+
+
Sequences through the right side of the either monad with a list of values.
+
+
sequenceS(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a Stream.
+
+
sequenceStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a stream inside a promise.
+
+
sequenceW(Stream<F<Promise<A>, B>>) - Method in class fj.control.parallel.Promise
+
+
Applies a stream of comonadic functions to this promise, returning a stream of values.
+
+
sequenceW(Stream<F<Stream<A>, B>>) - Method in class fj.data.Stream
+
+
Applies a stream of comonadic functions to this stream, returning a stream of values.
+
+
sequenceW(List<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a list of comonadic functions to this product, returning a list of values.
+
+
sequenceW(Stream<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a stream of comonadic functions to this product, returning a stream of values.
+
+
sequenceWhile(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
sequenceWhileEager(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
set(int, A) - Method in class fj.data.Array
+
+
Sets the element at the given index to the given value.
+
+
set(int) - Method in class fj.data.hamt.BitSet
+
 
+
set(int, boolean) - Method in class fj.data.hamt.BitSet
+
 
+
set(K, V) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the key-value pair (k, v) to the trie.
+
+
set(List<P2<K, V>>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the product of key-value (k, v) pairs to the trie.
+
+
set(K, V) - Method in class fj.data.HashMap
+
+
Inserts the given key and value association into the hash map.
+
+
set(A) - Method in class fj.data.HashSet
+
+
Insert the given element into this hash set.
+
+
set(A) - Method in class fj.data.optic.Lens
+
 
+
set(A) - Method in class fj.data.optic.Optional
+
 
+
set(B) - Method in class fj.data.optic.PIso
+
+
set polymorphically the target of a PIso with a value
+
+
set(B) - Method in class fj.data.optic.PLens
+
+
set polymorphically the target of a PLens using a function
+
+
set(B) - Method in class fj.data.optic.POptional
+
+
get the modified source of a POptional
+
+
set(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value
+
+
set(B) - Method in class fj.data.optic.PSetter
+
+
set polymorphically the target of a PSetter with a value
+
+
set(B) - Method in class fj.data.optic.PTraversal
+
+
set polymorphically the target of a PTraversal with a value
+
+
set(A) - Method in class fj.data.optic.Setter
+
 
+
Set<A> - Class in fj.data
+
+
Provides an in-memory, immutable set, implemented as a red/black tree.
+
+
set(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Constructs a set from the given elements.
+
+
set(Ord<A>, List<A>) - Static method in class fj.data.Set
+
+
Deprecated. +
As of release 4.5, use Set.iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
+
+
+
set(K, V) - Method in class fj.data.TreeMap
+
+
Inserts the given key and value association into the tree map.
+
+
setEqual(Equal<A>) - Static method in class fj.Equal
+
+
Equal instance for sets.
+
+
setHash(Hash<A>) - Static method in class fj.Hash
+
 
+
setK(F<A, B>, Ord<B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Set.
+
+
setK(Ord<B>) - Method in class fj.F1W
+
+
Promotes this function to return its value in a Set.
+
+
setLabel(A) - Method in class fj.data.TreeZipper
+
+
Replaces the label of the current node with the given value.
+
+
setM(F2<A, B, C>, Ord<C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Sets.
+
+
setM(Ord<C>) - Method in class fj.F2W
+
+
Promotes this function to a function on Sets.
+
+
setMax(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given maximum value.
+
+
setMin(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given minimum value.
+
+
setMonoid(Ord<A>) - Static method in class fj.Monoid
+
+
A monoid for sets.
+
+
setOption(B) - Method in class fj.data.optic.POptional
+
+
set polymorphically the target of a POptional with a value.
+
+
setOption(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value.
+
+
setOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Set type.
+
+
setSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for sets.
+
+
setShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Set type.
+
+
Setter<S,A> - Class in fj.data.optic
+
+
PSetter with a monomorphic modify function
+
+
Setter(PSetter<S, S, A, A>) - Constructor for class fj.data.optic.Setter
+
 
+
setter(F<F<A, A>, F<S, S>>) - Static method in class fj.data.optic.Setter
+
+
alias for PSetter constructor with a monomorphic modify function
+
+
setTree(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Replaces the current node with the given tree.
+
+
shiftLeft(int) - Method in class fj.data.hamt.BitSet
+
 
+
shiftRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
Short_Boolean - Static variable in class fj.Primitive
+
+
A function that converts shorts to booleans.
+
+
Short_Byte - Static variable in class fj.Primitive
+
+
A function that converts shorts to bytes.
+
+
Short_Character - Static variable in class fj.Primitive
+
+
A function that converts shorts to characters.
+
+
Short_Double - Static variable in class fj.Primitive
+
+
A function that converts shorts to doubles.
+
+
Short_Float - Static variable in class fj.Primitive
+
+
A function that converts shorts to floats.
+
+
Short_Integer - Static variable in class fj.Primitive
+
+
A function that converts shorts to integers.
+
+
Short_Long - Static variable in class fj.Primitive
+
+
A function that converts shorts to longs.
+
+
shortEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for short.
+
+
shortEqual - Static variable in class fj.Equal
+
+
An equal instance for the short type.
+
+
shortHash - Static variable in class fj.Hash
+
+
A hash instance for the short type.
+
+
shortOrd - Static variable in class fj.Ord
+
+
An order instance for the short type.
+
+
shortShow - Static variable in class fj.Show
+
+
A show instance for the short type.
+
+
show() - Method in class fj.data.hlist.HPre.HNat
+
 
+
show() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
show() - Method in class fj.data.hlist.HPre.HZero
+
 
+
show(Show<A>) - Static method in class fj.data.TreeZipper
+
+
A Show instance for tree zippers.
+
+
show(Show<A>) - Static method in class fj.data.Zipper
+
+
A Show instance for Zippers.
+
+
Show<A> - Class in fj
+
+
Renders an object for display.
+
+
show(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
show(F<A, Stream<Character>>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
show2D(Show<A>) - Static method in class fj.data.Tree
+
+
Provides a show instance that draws a 2-dimensional representation of a tree.
+
+
show_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
showl(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
showS(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument as a String.
+
+
showS(F<A, String>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
showS_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
simpleThreadStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
+
+
single(A) - Static method in class fj.data.Array
+
+
Constructs a singleton array.
+
+
single(A) - Static method in class fj.data.DList
+
+
Produces a DList with one element.
+
+
single(A) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a singleton tree.
+
+
Single<V,A> - Class in fj.data.fingertrees
+
+
A tree with a single element.
+
+
single(E) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of a single element.
+
+
single(A) - Static method in class fj.data.List
+
+
Returns a list of one element containing the given value.
+
+
single(A) - Static method in class fj.data.Seq
+
+
A singleton sequence.
+
+
single(Ord<A>, A) - Static method in class fj.data.Set
+
+
Returns a set with a single element.
+
+
single(A) - Static method in class fj.data.Stream
+
+
Returns a stream of one element containing the given value.
+
+
single() - Static method in class fj.data.Stream
+
+
Returns a function that yields a stream containing its argument.
+
+
single(A) - Static method in class fj.data.Zipper
+
+
Creates a new zipper with a single element.
+
+
SIZE - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
size() - Method in class fj.data.HashMap
+
+
Returns the number of entries in this hash map.
+
+
size() - Method in class fj.data.HashSet
+
+
Returns the number of entries in this hash set.
+
+
size() - Method in class fj.data.Set
+
+
Returns the size of this set.
+
+
size() - Method in class fj.data.TreeMap
+
+
Returns the number of entries in this tree map.
+
+
snoc(A) - Method in class fj.data.DList
+
+
Appends a single element on the end of the DList to produce a new DList.
+
+
snoc(A) - Method in class fj.data.fingertrees.Deep
+
 
+
snoc(A) - Method in class fj.data.fingertrees.Empty
+
 
+
snoc(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the last element.
+
+
snoc(A) - Method in class fj.data.fingertrees.Single
+
 
+
snoc(A) - Method in class fj.data.List.Buffer
+
+
Appends (snoc) the given element to this buffer to produce a new buffer.
+
+
snoc(A) - Method in class fj.data.List
+
+
Appends (snoc) the given element to this list to produce a new list.
+
+
snoc(A) - Method in class fj.data.NonEmptyList
+
+
Appends (snoc) the given element to this non empty list to produce a new non empty list.
+
+
snoc(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the end of this sequence.
+
+
snoc(A) - Method in class fj.data.Stream
+
+
Append the given element to this stream to product a new stream.
+
+
snoc(F0<A>) - Method in class fj.data.Stream
+
+
Append the given element to this stream to produce a new stream.
+
+
softMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
+
+
softMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a SoftReference
+
+
some() - Static method in class fj.data.Option.Optic
+
+
Monomorphic Some prism
+
+
some() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or fails if there is no value.
+
+
some(T) - Static method in class fj.data.Option
+
+
Constructs an optional value that has a value of the given argument.
+
+
some_() - Static method in class fj.data.Option
+
 
+
somes(List<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given list.
+
+
somes(Stream<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given stream.
+
+
sort(Ord<A>) - Method in class fj.data.List
+
+
Sorts this list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Sorts this non empty list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering.
+
+
sort(Ord<A>, Strategy<Unit>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
+
+
space(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
space(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
span(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
+
+
span(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
+
+
split(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
+
+
split(F<Character, Boolean>) - Method in class fj.data.LazyString
+
+
Splits this lazy string by characters matching the given predicate.
+
+
split(char) - Method in class fj.data.LazyString
+
+
Splits this lazy string by the given delimiter character.
+
+
split(int) - Method in class fj.data.Seq
+
+
Splits this sequence into a pair of sequences at the given position.
+
+
split(A) - Method in class fj.data.Set
+
+
Splits this set at the given element.
+
+
split(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
+
+
split(Ord<V>, K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
split(F<A, C>, F<B, D>) - Method in class fj.P2
+
+
Split this product between two argument functions and combine their output.
+
+
split1(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Like split, but returns the element where pred first holds separately.
+
+
split_(F<A, C>, F<B, D>) - Static method in class fj.P2
+
+
A first-class version of the split function.
+
+
splitAt(int) - Method in class fj.data.List
+
+
Splits this list into two lists at the given index.
+
+
splitLookup(K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
Stack_List() - Static method in class fj.data.Java
+
+
A function that converts stacks to lists.
+
+
startsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a prefix of this lazy string.
+
+
startsWith() - Static method in class fj.data.LazyString
+
+
First-class prefix check.
+
+
State<S,A> - Class in fj.data
+
+
Created by MarkPerry on 7/07/2014.
+
+
stdinBufferedReader - Static variable in class fj.data.IOFunctions
+
 
+
stdinReadLine() - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrint(String) - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrintln(String) - Static method in class fj.data.IOFunctions
+
 
+
str(String) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a String.
+
+
Strategy<A> - Class in fj.control.parallel
+
+
Functional-style parallel evaluation strategies.
+
+
strategy(F<P1<A>, P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Constructs a strategy from the given evaluation function.
+
+
Stream<A> - Class in fj.data
+
+
A lazy (not yet evaluated), immutable, singly linked list.
+
+
stream(B, F<A, F<P1<Stream<A>>, B>>) - Method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.uncons(B, fj.F<A, fj.F<fj.P1<fj.data.Stream<A>>, B>>)
+
+
+
stream(A...) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements.
+
+
stream(Iterable<A>) - Static method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.iterableStream(Iterable)
+
+
+
stream(Iterator<A>) - Static method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.iteratorStream(Iterator)
+
+
+
Stream_Array() - Static method in class fj.data.Conversions
+
+
A function that converts streams to arrays.
+
+
Stream_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to array blocking queues.
+
+
Stream_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to array lists.
+
+
Stream_BitSet - Static variable in class fj.data.Java
+
+
A function that converts streams to bit sets.
+
+
Stream_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to concurrent linked queues.
+
+
Stream_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array lists.
+
+
Stream_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array sets.
+
+
Stream_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to delay queues.
+
+
Stream_Either() - Static method in class fj.data.Conversions
+
+
A function that converts streams to eithers.
+
+
Stream_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts streams to enum sets.
+
+
Stream_HashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to hash sets.
+
+
Stream_Iterable() - Static method in class fj.data.Java
+
+
A function that converts streams to iterable.
+
+
Stream_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to linked blocking queues.
+
+
Stream_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to linked hash sets.
+
+
Stream_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts streams to linked lists.
+
+
Stream_List() - Static method in class fj.data.Conversions
+
+
A function that converts streams to lists.
+
+
Stream_Option() - Static method in class fj.data.Conversions
+
+
A function that converts streams to options.
+
+
Stream_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority blocking queues.
+
+
Stream_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority queues.
+
+
Stream_Stack() - Static method in class fj.data.Java
+
+
A function that converts streams to stacks.
+
+
Stream_String - Static variable in class fj.data.Conversions
+
+
A function that converts streams to strings.
+
+
Stream_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string buffers.
+
+
Stream_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string builders.
+
+
Stream_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to synchronous queues.
+
+
Stream_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts streams to tree sets.
+
+
Stream_Vector() - Static method in class fj.data.Java
+
+
A function that converts streams to vectors.
+
+
streamBitSet(Stream<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
streamEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Stream type.
+
+
streamHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Stream type.
+
+
streamK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a Stream.
+
+
streamK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a Stream.
+
+
streamM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Streams.
+
+
streamM() - Method in class fj.F2W
+
+
Promotes this function to a function on Streams.
+
+
streamMonoid() - Static method in class fj.Monoid
+
+
A monoid for streams.
+
+
streamOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Stream type.
+
+
streamSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for streams.
+
+
streamShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow(Show<A>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow_(Show<A>, String, String, String) - Static method in class fj.Show
+
+
Returns the transformation equivalent for the stream show.
+
+
string(F0<E>, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
string(E, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
String_Array - Static variable in class fj.data.Conversions
+
+
A function that converts strings to arrays.
+
+
String_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to array blocking queues.
+
+
String_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to array lists.
+
+
String_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to concurrent linked queues.
+
+
String_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array lists.
+
+
String_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array sets.
+
+
String_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string to eithers.
+
+
String_HashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to hash sets.
+
+
String_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to linked blocking queues.
+
+
String_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to linked hash sets.
+
+
String_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts strings to linked lists.
+
+
String_List - Static variable in class fj.data.Conversions
+
+
A function that converts strings to lists.
+
+
String_Option - Static variable in class fj.data.Conversions
+
+
A function that converts strings to options.
+
+
String_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority blocking queues.
+
+
String_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority queues.
+
+
String_Stack - Static variable in class fj.data.Java
+
+
A function that converts strings to stacks.
+
+
String_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts strings to streams.
+
+
String_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string buffers.
+
+
String_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string builders.
+
+
String_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to synchronous queues.
+
+
String_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts strings to tree sets.
+
+
String_Vector - Static variable in class fj.data.Java
+
+
A function that converts strings to vectors.
+
+
stringBitSet(String) - Static method in class fj.data.hamt.BitSet
+
 
+
StringBuffer_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to arrays.
+
+
StringBuffer_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to array blocking queues.
+
+
StringBuffer_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to array lists.
+
+
StringBuffer_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to concurrent linked queues.
+
+
StringBuffer_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array lists.
+
+
StringBuffer_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array sets.
+
+
StringBuffer_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string buffers to eithers.
+
+
StringBuffer_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to hash sets.
+
+
StringBuffer_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked blocking queues.
+
+
StringBuffer_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked hash sets.
+
+
StringBuffer_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked lists.
+
+
StringBuffer_List - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to lists.
+
+
StringBuffer_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to options.
+
+
StringBuffer_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority blocking queues.
+
+
StringBuffer_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority queues.
+
+
StringBuffer_Stack - Static variable in class fj.data.Java
+
+
A function that converts string buffers to stacks.
+
+
StringBuffer_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to streams.
+
+
StringBuffer_String - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to strings.
+
+
StringBuffer_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to string builders.
+
+
StringBuffer_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to synchronous queues.
+
+
StringBuffer_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to tree sets.
+
+
StringBuffer_Vector - Static variable in class fj.data.Java
+
+
A function that converts string buffers to vectors.
+
+
stringBufferEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuffer type.
+
+
stringBufferHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuffer type.
+
+
stringBufferMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string buffers.
+
+
stringBufferOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBufferSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string buffers.
+
+
stringBufferShow - Static variable in class fj.Show
+
+
A show instance for the StringBuffer type.
+
+
StringBuilder_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to arrays.
+
+
StringBuilder_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to array blocking queues.
+
+
StringBuilder_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to array lists.
+
+
StringBuilder_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to concurrent linked queues.
+
+
StringBuilder_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array lists.
+
+
StringBuilder_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array sets.
+
+
StringBuilder_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string builders to eithers.
+
+
StringBuilder_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to hash sets.
+
+
StringBuilder_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked blocking queues.
+
+
StringBuilder_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked hash sets.
+
+
StringBuilder_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked lists.
+
+
StringBuilder_List - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to lists.
+
+
StringBuilder_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to options.
+
+
StringBuilder_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority blocking queues.
+
+
StringBuilder_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority queues.
+
+
StringBuilder_Stack - Static variable in class fj.data.Java
+
+
A function that converts string builders to stacks.
+
+
StringBuilder_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to streams.
+
+
StringBuilder_String - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to strings.
+
+
StringBuilder_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to string buffers.
+
+
StringBuilder_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to synchronous queues.
+
+
StringBuilder_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to tree sets.
+
+
StringBuilder_Vector - Static variable in class fj.data.Java
+
+
A function that converts string builders to vectors.
+
+
stringBuilderEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuilder type.
+
+
stringBuilderHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuilder type.
+
+
stringBuilderMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string builders.
+
+
stringBuilderOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBuilderSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string builders.
+
+
stringBuilderShow - Static variable in class fj.Show
+
+
A show instance for the StringBuilder type.
+
+
stringEqual - Static variable in class fj.Equal
+
+
An equal instance for the String type.
+
+
stringHash - Static variable in class fj.Hash
+
+
A hash instance for the String type.
+
+
stringLogger() - Static method in class fj.data.Writer
+
 
+
stringMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends strings.
+
+
stringOrd - Static variable in class fj.Ord
+
+
An order instance for the String type.
+
+
Strings - Class in fj.function
+
+
Curried string functions.
+
+
stringSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends strings.
+
+
stringShow - Static variable in class fj.Show
+
+
A show instance for the String type.
+
+
subForest() - Method in class fj.data.Tree
+
+
Returns a stream of the tree's subtrees.
+
+
subForest_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its subforest.
+
+
sublists() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the sublists of this list.
+
+
subSequence(int, int) - Method in class fj.data.LazyString
+
+
Gets the specified subsequence of this lazy string.
+
+
subsetOf(Set<A>) - Method in class fj.data.Set
+
+
Returns true if this set is a subset of the given set.
+
+
substreams() - Method in class fj.data.Stream
+
+
Returns a stream of all infixes of this stream.
+
+
subtract - Static variable in class fj.data.Natural
+
+
A function that subtracts its first argument from its second.
+
+
subtract(Natural) - Method in class fj.data.Natural
+
+
Subtract a natural number from another.
+
+
subtract - Static variable in class fj.function.BigIntegers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Doubles
+
+
Curried Double subtraction.
+
+
subtract - Static variable in class fj.function.Integers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Longs
+
+
Curried Long subtraction.
+
+
succ() - Method in class fj.data.Natural
+
+
Return the successor of this natural number
+
+
succ_() - Static method in class fj.data.Natural
+
+
First-class successor function.
+
+
success() - Method in class fj.data.Validation
+
+
Returns the success value, or throws an error if there is no success value.
+
+
success(T) - Static method in class fj.data.Validation
+
+
Returns a succeeding validation containing the given value.
+
+
successE(F0<String>) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successE(String) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successes(List<Validation<?, A>>) - Static method in class fj.data.Validation
+
 
+
successK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the success side of an Validation.
+
+
successK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the success side of an Validation.
+
+
successor() - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator in curried form.
+
+
successor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator.
+
+
suffix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the last few elements of this tree.
+
+
sum(V, V) - Method in class fj.data.fingertrees.Measured
+
+
Sums the given measurements with the monoid.
+
+
sum() - Method in class fj.data.hlist.HPre.HAdd
+
 
+
sum(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Sums a stream of natural numbers.
+
+
sum(List<Natural>) - Static method in class fj.data.Natural
+
+
Sums a list of natural numbers.
+
+
sum(Fold<S1, A>) - Method in class fj.data.optic.Fold
+
+
join two Fold with the same target
+
+
sum(Getter<S1, A>) - Method in class fj.data.optic.Getter
+
+
join two Getter with the same target
+
+
sum(Lens<S1, A>) - Method in class fj.data.optic.Lens
+
+
join two Lens with the same target
+
+
sum(Optional<S1, A>) - Method in class fj.data.optic.Optional
+
+
join two Optional with the same target
+
+
sum(PLens<S1, T1, A, B>) - Method in class fj.data.optic.PLens
+
+
join two PLens with the same target
+
+
sum(POptional<S1, T1, A, B>) - Method in class fj.data.optic.POptional
+
+
join two POptional with the same target
+
+
sum(PSetter<S1, T1, A, B>) - Method in class fj.data.optic.PSetter
+
+
join two PSetter with the same target
+
+
sum(PTraversal<S1, T1, A, B>) - Method in class fj.data.optic.PTraversal
+
+
join two PTraversal with the same target
+
+
sum(Setter<S1, A>) - Method in class fj.data.optic.Setter
+
+
join two Setter with the same target
+
+
sum(Traversal<S1, A>) - Method in class fj.data.optic.Traversal
+
+
join two Traversal with the same target
+
+
sum(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Sums a list of big integers.
+
+
sum(List<Double>) - Static method in class fj.function.Doubles
+
+
Sums a list of doubles.
+
+
sum(List<Integer>) - Static method in class fj.function.Integers
+
+
Sums a list of integers.
+
+
sum(F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, A) - Method in class fj.Monoid
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Monoid
+
+
Returns a function that sums the given value according to this monoid.
+
+
sum() - Method in class fj.Monoid
+
+
Returns a function that sums according to this monoid.
+
+
sum(A, F0<Stream<A>>) - Method in interface fj.Semigroup.Definition
+
 
+
sum(A, A) - Method in class fj.Semigroup
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Semigroup
+
+
Returns a function that sums the given value according to this semigroup.
+
+
sum() - Method in class fj.Semigroup
+
+
Returns a function that sums according to this semigroup.
+
+
sumLeft(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumLeftS() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumNel(NonEmptyList<A>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold.
+
+
sumRight(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with right-fold.
+
+
sumStream(A, F0<Stream<A>>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold, shortcutting the computation as early as possible.
+
+
superclassParameters() - Method in class fj.Class
+
+
Provides this class's superclass type parameter information as a Tree of the type expression.
+
+
suspend(P1<Trampoline<A>>) - Static method in class fj.control.Trampoline
+
+
Suspends the given computation in a thunk.
+
+
suspend_() - Static method in class fj.control.Trampoline
+
 
+
swap() - Method in class fj.data.Either
+
+
If this is a left, then return the left value in right, or vice versa.
+
+
swap() - Method in class fj.P2
+
+
Swaps the elements around in this product.
+
+
swap_() - Static method in class fj.P2
+
+
Returns a curried form of P2.swap().
+
+
SynchronousQueue_List() - Static method in class fj.data.Java
+
+
A function that converts synchronous queues to lists.
+
+
+ + + +

T

+
+
tail() - Method in class fj.data.fingertrees.Deep
+
 
+
tail() - Method in class fj.data.fingertrees.Empty
+
 
+
tail() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the first element.
+
+
tail() - Method in class fj.data.fingertrees.Single
+
 
+
tail() - Method in class fj.data.hlist.HList.HCons
+
 
+
tail() - Method in class fj.data.LazyString
+
+
Returns all but the first character of this string.
+
+
tail() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons tail.
+
+
tail() - Method in class fj.data.List
+
+
The list without the first element or fails for the empty list.
+
+
tail() - Method in class fj.data.NonEmptyList
+
+
This list without the first element.
+
+
tail() - Method in class fj.data.Seq
+
+
The sequence without the first element.
+
+
tail() - Method in class fj.data.Stream
+
+
The stream without the first element or fails for the empty stream.
+
+
tail() - Method in class fj.data.vector.V3
+
+
Returns all but the first element of this vector, as a vector-2.
+
+
tail() - Method in class fj.data.vector.V4
+
+
Returns all but the first element of this vector, as a vector-3.
+
+
tail() - Method in class fj.data.vector.V5
+
+
Returns all but the first element of this vector, as a vector-4.
+
+
tail() - Method in class fj.data.vector.V6
+
+
Returns all but the first element of this vector, as a vector-5.
+
+
tail() - Method in class fj.data.vector.V7
+
+
Returns all but the first element of this vector, as a vector-6.
+
+
tail() - Method in class fj.data.vector.V8
+
+
Returns all but the first element of this vector, as a vector-7.
+
+
tail_() - Static method in class fj.data.List
+
+
First-class tail function.
+
+
tailOption() - Method in class fj.data.List
+
+
Reutrns the tail of the list, if any.
+
+
tails() - Method in class fj.data.List
+
+
Returns the list of final segments of this list, longest first.
+
+
tails() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the tails of this list.
+
+
tails() - Method in class fj.data.Stream
+
+
Returns a stream of the suffixes of this stream.
+
+
take(int) - Method in class fj.data.List
+
+
Takes the given number of elements from the head of this list if they are available.
+
+
take() - Static method in class fj.data.List
+
+
Provides a first-class version of take.
+
+
take(int) - Method in class fj.data.Seq
+
+
Takes the given number of elements from the head of this sequence if they are available.
+
+
take(int) - Method in class fj.data.Stream
+
+
Returns the first n elements from the head of this stream.
+
+
takeLower(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeUpper(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns the first elements of the head of this list that match the given predicate function.
+
+
takeWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the first elements of the head of this stream that match the given predicate function.
+
+
tell(W) - Method in class fj.data.Writer
+
 
+
then(F<A, B>, Equal<B>) - Method in interface fj.Equal.Definition
+
+
Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
+
+
then(F<A, B>, Ord<B>) - Method in interface fj.Ord.Definition
+
+
Refine this ord definition: compares using self and if objects are equal compares using given Ord.
+
+
three(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of three elements.
+
+
Three<V,A> - Class in fj.data.fingertrees
+
+
A three-element prefix or suffix of a finger tree.
+
+
titleCase(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
titleCase(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
to(Actor<A>) - Method in class fj.control.parallel.Promise
+
+
Promises to send a value to the given actor in the future.
+
+
toArray() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.HashMap
+
 
+
toArray() - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray(Class<A[]>) - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray() - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray() - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element array if this is a failing value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.Validation
+
+
Returns a single element array if this is a success value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.vector.V2
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V3
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V4
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V5
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V6
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V7
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V8
+
+
Returns an array with the elements of this vector.
+
+
toArrayObject() - Method in class fj.data.List
+
 
+
toBoolean(char) - Static method in class fj.data.hamt.BitSet
+
 
+
toBoolean(int) - Static method in class fj.data.hamt.BitSet
+
 
+
toChar - Static variable in enum fj.Digit
+
+
First-class conversion from a digit to a character.
+
+
toChar() - Method in enum fj.Digit
+
+
Converts this digit to a character.
+
+
toCollection() - Method in class fj.data.Array.ImmutableProjection
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Array
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Either.LeftProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.Either.RightProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.HashMap
+
+
Projects an immutable collection of this hash map.
+
+
toCollection() - Method in class fj.data.HashSet
+
+
Projects an immutable collection of this hash set.
+
+
toCollection() - Method in class fj.data.List.Buffer
+
+
Projects an immutable collection of this buffer.
+
+
toCollection() - Method in class fj.data.List
+
+
Projects an immutable collection of this list.
+
+
toCollection() - Method in class fj.data.NonEmptyList
+
+
Projects an immutable collection of this non-empty list.
+
+
toCollection() - Method in class fj.data.Option
+
+
Projects an immutable collection of this optional value.
+
+
toCollection() - Method in class fj.data.Stream
+
+
Projects an immutable collection of this stream.
+
+
toCollection() - Method in class fj.data.Tree
+
+
Projects an immutable collection of this tree.
+
+
toComparator() - Method in class fj.Ord
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node2
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node3
+
 
+
toEither(F0<X>) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Array
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.List
+
+
Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither(X) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither() - Static method in class fj.data.Option
+
+
A first-class version of the toEither method.
+
+
toEither(F0<X>) - Method in class fj.data.Stream
+
+
Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
+
+
toEither() - Method in class fj.data.Validation
+
+
Returns an either projection of this validation.
+
+
toForest() - Method in class fj.data.TreeZipper
+
+
Returns the forest containing this location.
+
+
toFunction() - Method in class fj.data.Stream
+
+
Converts this stream to a function of natural numbers.
+
+
toInt(boolean) - Static method in class fj.data.hamt.BitSet
+
 
+
toInt() - Method in enum fj.Ordering
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HNat
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HZero
+
 
+
toJavaArray() - Method in class fj.data.Array
+
+
Deprecated. +
As of release 4.6, use Array.array(Class).
+
+
+
toJavaArray() - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.6, use List.array(Class).
+
+
+
toJavaArray() - Method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.6, use Stream.array(Class).
+
+
+
toJavaHashSet() - Method in class fj.data.Set
+
+
Returns a java.util.HashSet representation of this set.
+
+
toJavaList() - Method in class fj.data.Array
+
+
Returns a java.util.ArrayList projection of this array.
+
+
toJavaList() - Method in class fj.data.DList
+
+
Converts the DList to a standard java.util.List.
+
+
toJavaList() - Method in class fj.data.HashSet
+
 
+
toJavaList() - Method in class fj.data.List
+
 
+
toJavaList() - Method in class fj.data.Seq
+
+
Converts the sequence to a java.util.List
+
+
toJavaList() - Method in class fj.data.Set
+
+
Returns a java.util.List representation of this set.
+
+
toJavaList() - Method in class fj.data.Stream
+
+
Returns a java.util.List projection of this stream.
+
+
toJavaSet() - Method in class fj.data.HashSet
+
 
+
toJavaSet() - Method in class fj.data.Set
+
+
Returns a java.util.Set representation of this set.
+
+
toJavaTreeSet() - Method in class fj.data.Set
+
+
Returns a java.util.TreeSet representation of this set.
+
+
toList() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a list projection of this array.
+
+
toList() - Method in class fj.data.Array
+
+
Returns a list projection of this array.
+
+
toList() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.hamt.BitSet
+
 
+
toList(Ord<K>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the list of key-value pairs, ordered by key.
+
+
toList() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a list of key-value pairs.
+
+
toList() - Method in class fj.data.HashMap
+
 
+
toList() - Method in class fj.data.HashSet
+
+
Returns a list projection of this hash set.
+
+
toList() - Method in class fj.data.List.Buffer
+
+
Returns an immutable list projection of this buffer.
+
+
toList() - Method in class fj.data.NonEmptyList
+
+
Returns a List projection of this list.
+
+
toList() - Method in class fj.data.Option
+
+
Returns a list projection of this optional value.
+
+
toList() - Method in class fj.data.PriorityQueue
+
+
Returns a list of products with priority k and value a.
+
+
toList() - Method in class fj.data.Seq
+
+
Converts this sequence to a List
+
+
toList() - Method in class fj.data.Set
+
+
Returns a list representation of this set.
+
+
toList() - Method in class fj.data.Stream
+
+
Returns a list projection of this stream.
+
+
toList() - Method in class fj.data.TreeMap
+
 
+
toList() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element list if this is a failing value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Validation
+
+
Returns a single element list if this is a success value, otherwise an empty list.
+
+
toList_() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that takes a non-empty list to a list.
+
+
toListReverse() - Method in class fj.data.Set
+
+
Returns a list representation of this set in reverse order.
+
+
toListReverse() - Method in class fj.data.TreeMap
+
 
+
toLong - Static variable in enum fj.Digit
+
+
First-class conversion from digit to a long.
+
+
toLong() - Method in enum fj.Digit
+
+
Converts this digit to a long.
+
+
toLowerCase - Static variable in class fj.function.Characters
+
 
+
toMap() - Method in class fj.data.HashMap
+
 
+
toMutableMap() - Method in class fj.data.TreeMap
+
+
A mutable map projection of this tree map.
+
+
toNonEmptyList() - Method in class fj.data.vector.V2
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V3
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V4
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V5
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V6
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V7
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V8
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNull() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or if there is no value, returns null.
+
+
toOption() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an option projection of this array; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Array
+
+
Returns an option projection of this array; None if empty, or the first element in + Some.
+
+
toOption() - Method in class fj.data.Either.LeftProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.Either.RightProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.HashMap
+
 
+
toOption() - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.headOption()
+
+
+
toOption() - Method in class fj.data.Stream
+
+
Returns an option projection of this stream; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value in Some if there is one, otherwise None.
+
+
toOption() - Method in class fj.data.Validation
+
+
Returns the success value in Some if there is one, otherwise None.
+
+
top() - Method in class fj.data.PriorityQueue
+
+
If the tree is not empty, returns the node with highest priority otherwise returns nothing.
+
+
topDequeue() - Method in class fj.data.PriorityQueue
+
+
Returns a tuple of the node with the highest priority and the rest of the priority queue.
+
+
topN() - Method in class fj.data.PriorityQueue
+
+
Returns all the elements of the queue with the highest (same) priority.
+
+
toSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
+
+
toSafeValidation(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toStandardList() - Method in class fj.data.IterableW
+
+
Returns a java.util.List implementation for this iterable.
+
+
toStream() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a stream projection of this array.
+
+
toStream() - Method in class fj.data.Array
+
+
Returns a stream projection of this array.
+
+
toStream() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream(A) - Method in class fj.data.Enumerator
+
+
Returns a stream of the values from this enumerator, starting at the given value, counting up.
+
+
toStream() - Method in class fj.data.fingertrees.Deep
+
 
+
toStream() - Method in class fj.data.fingertrees.Digit
+
 
+
toStream() - Method in class fj.data.fingertrees.Empty
+
 
+
toStream() - Method in class fj.data.fingertrees.FingerTree
+
 
+
toStream() - Method in class fj.data.fingertrees.Four
+
 
+
toStream() - Method in class fj.data.fingertrees.Node
+
 
+
toStream() - Method in class fj.data.fingertrees.Node2
+
 
+
toStream() - Method in class fj.data.fingertrees.Node3
+
 
+
toStream() - Method in class fj.data.fingertrees.One
+
 
+
toStream() - Method in class fj.data.fingertrees.Single
+
 
+
toStream() - Method in class fj.data.fingertrees.Three
+
 
+
toStream() - Method in class fj.data.fingertrees.Two
+
 
+
toStream() - Method in class fj.data.hamt.BitSet
+
+
Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
+
+
toStream() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a stream of key-value pairs.
+
+
toStream() - Method in class fj.data.hamt.Node
+
 
+
toStream() - Method in class fj.data.HashMap
+
 
+
toStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to streams.
+
+
toStream() - Method in class fj.data.LazyString
+
+
Gives a stream representation of this lazy string.
+
+
toStream() - Method in class fj.data.List
+
+
Returns a stream projection of this list.
+
+
toStream() - Method in class fj.data.Option
+
+
Returns a stream projection of this optional value.
+
+
toStream() - Method in class fj.data.PriorityQueue
+
+
Returns a stream of products with priority k and value a.
+
+
toStream() - Method in class fj.data.Seq
+
+
Converts this sequence to a Stream
+
+
toStream() - Method in class fj.data.Set
+
+
Returns a stream representation of this set.
+
+
toStream() - Method in class fj.data.TreeMap
+
 
+
toStream() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element stream if this is a failing value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.Validation
+
+
Returns a single element stream if this is a success value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.vector.V2
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V3
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V4
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V5
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V6
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V7
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V8
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.Zipper
+
+
Returns the Stream representation of this zipper.
+
+
toStream_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to a stream of its elements.
+
+
toStreamReverse() - Method in class fj.data.Set
+
+
Returns a stream representation of this set in reverse order.
+
+
toStreamReverse() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Array
+
 
+
toString() - Method in class fj.data.Either
+
 
+
toString() - Method in class fj.data.fingertrees.Deep
+
 
+
toString() - Method in class fj.data.fingertrees.Digit
+
 
+
toString() - Method in class fj.data.fingertrees.Empty
+
 
+
toString() - Method in class fj.data.fingertrees.Four
+
 
+
toString() - Method in class fj.data.fingertrees.Node2
+
 
+
toString() - Method in class fj.data.fingertrees.Node3
+
 
+
toString() - Method in class fj.data.fingertrees.One
+
 
+
toString() - Method in class fj.data.fingertrees.Single
+
 
+
toString() - Method in class fj.data.fingertrees.Three
+
 
+
toString() - Method in class fj.data.fingertrees.Two
+
 
+
toString() - Method in class fj.data.hamt.BitSet
+
 
+
toString() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
toString() - Method in class fj.data.hamt.Node
+
 
+
toString - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to String.
+
+
toString() - Method in class fj.data.LazyString
+
 
+
toString() - Method in class fj.data.List
+
+
Obtain a string representation of this list using the toString implementations of the members.
+
+
toString() - Method in class fj.data.Natural
+
 
+
toString() - Method in class fj.data.NonEmptyList
+
 
+
toString() - Method in class fj.data.Option
+
 
+
toString() - Method in class fj.data.PriorityQueue
+
 
+
toString() - Method in class fj.data.Seq
+
 
+
toString() - Method in class fj.data.Set
+
 
+
toString() - Method in class fj.data.Stream
+
 
+
toString() - Method in class fj.data.Tree
+
 
+
toString() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Validation
+
 
+
toString - Static variable in class fj.function.Characters
+
 
+
toString() - Method in class fj.P1
+
 
+
toString() - Method in class fj.P2
+
 
+
toString() - Method in class fj.P3
+
 
+
toString() - Method in class fj.P4
+
 
+
toString() - Method in class fj.P5
+
 
+
toString() - Method in class fj.P6
+
 
+
toString() - Method in class fj.P7
+
 
+
toString() - Method in class fj.P8
+
 
+
toString() - Method in class fj.parser.Result
+
 
+
toString() - Method in class fj.Unit
+
 
+
toStringEager() - Method in class fj.data.LazyString
+
+
Returns the String representation of this lazy string.
+
+
toStringEager() - Method in class fj.data.Stream
+
 
+
toStringLazy() - Method in class fj.data.LazyString
+
 
+
toStringLazy() - Method in class fj.data.Stream
+
 
+
toTitleCase - Static variable in class fj.function.Characters
+
 
+
toTree() - Method in class fj.data.fingertrees.Digit
+
+
Returns the tree representation of this digit.
+
+
toTree() - Method in class fj.data.TreeZipper
+
+
Returns the tree containing this location.
+
+
toTry(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toUpperCase - Static variable in class fj.function.Characters
+
 
+
toValidation(X) - Method in class fj.data.Option
+
 
+
toVector() - Method in class fj.data.fingertrees.Node2
+
 
+
toVector() - Method in class fj.data.fingertrees.Node3
+
 
+
toZipper() - Method in class fj.data.IterableW
+
 
+
Trampoline<A> - Class in fj.control
+
+
A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
+
+
Trampoline() - Constructor for class fj.control.Trampoline
+
 
+
traversal() - Static method in class fj.data.List.Optic
+
+
Monomorphic traversal
+
+
Traversal<S,A> - Class in fj.data.optic
+
 
+
Traversal(PTraversal<S, S, A, A>) - Constructor for class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F3<A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F4<A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<A, A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traverse(List<A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
+
Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
+
+
traverseEither(F<A, Either<E, B>>) - Method in class fj.data.List
+
+
Traverse through the List with given function.
+
+
traverseEither(F<A, Either<L, B>>) - Method in class fj.data.Option
+
 
+
traverseEither(F<A, Either<X, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Either
+
+
traverseEither(F<B, Either<X, C>>) - Method in class fj.P2
+
 
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.List
+
 
+
traverseIO(F<A, IO<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
traverseIO(F<B, IO<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with a function that has IO effect
+
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.List
+
 
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Option
+
 
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Stream
+
+
Traversable instance of Stream for IO.
+
+
traverseIO(F<T, IO<C>>) - Method in class fj.data.Validation
+
 
+
traverseIO(F<B, IO<C>>) - Method in class fj.P2
+
 
+
traverseIOLeft(F<A, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for IO.
+
+
traverseIORight(F<B, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for IO.
+
+
traverseList(F<A, List<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<B, List<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.List
+
 
+
traverseList(F<A, List<B>>) - Method in class fj.data.Option
+
 
+
traverseList(F<T, List<C>>) - Method in class fj.data.Validation
+
 
+
traverseList(F<A, List<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for List
+
+
traverseList(F<B, List<C>>) - Method in class fj.P2
+
 
+
traverseListLeft(F<A, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for List.
+
+
traverseListRight(F<B, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for List.
+
+
traverseOption(F<A, Option<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseOption(F<B, Option<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Traverses through the List with the given function
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Option
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Stream
+
+
Traversable instance of Stream for Option.
+
+
traverseOption(F<T, Option<C>>) - Method in class fj.data.Validation
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Option
+
+
traverseOption(F<B, Option<C>>) - Method in class fj.P2
+
 
+
traverseOptionLeft(F<A, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Option.
+
+
traverseOptionRight(F<B, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Option.
+
+
traverseP1(F<B, P1<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.List
+
 
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.Option
+
 
+
traverseP1(F<T, P1<C>>) - Method in class fj.data.Validation
+
 
+
traversePromise(F<A, Promise<B>>) - Method in class fj.data.List
+
 
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.Option
+
 
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Option
+
 
+
traverseSet() - Method in class fj.data.Option
+
 
+
traverseStream(F<A, Stream<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseStream(F<B, Stream<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.List
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.Option
+
 
+
traverseStream(F<T, Stream<C>>) - Method in class fj.data.Validation
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Stream
+
+
traverseStream(F<B, Stream<C>>) - Method in class fj.P2
+
 
+
traverseStreamLeft(F<A, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Stream.
+
+
traverseStreamRight(F<B, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Stream.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
 
+
traverseV2(F<A, V2<B>>) - Method in class fj.data.List
+
 
+
traverseValidation(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.List
+
 
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.data.Option
+
 
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Validation
+
+
Tree<A> - Class in fj.data
+
+
Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
+
+
treeEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Tree type.
+
+
treeHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Tree type.
+
+
treeK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Tree.
+
+
treeK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a Tree.
+
+
treeM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Trees.
+
+
treeM() - Method in class fj.F2W
+
+
Promotes this function to a function on Trees.
+
+
TreeMap<K,V> - Class in fj.data
+
+
An immutable, in-memory map, backed by a red-black tree.
+
+
treeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
treeMap(Ord<K>, List<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Deprecated. +
As of release 4.5, use TreeMap.iterableTreeMap(Ord, Iterable)
+
+
+
treeMapEqual(Equal<K>, Equal<V>) - Static method in class fj.Equal
+
 
+
treeMapHash(Hash<K>, Hash<V>) - Static method in class fj.Hash
+
 
+
treeMapShow(Show<K>, Show<V>) - Static method in class fj.Show
+
+
A show instance for the TreeMap type.
+
+
TreeSet_List() - Static method in class fj.data.Java
+
+
A function that converts tree sets to lists.
+
+
treeShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Tree type.
+
+
TreeZipper<A> - Class in fj.data
+
+
Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.
+
+
treeZipper(Tree<A>, Stream<Tree<A>>, Stream<Tree<A>>, Stream<P3<Stream<Tree<A>>, A, Stream<Tree<A>>>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
+
+
treeZipper() - Static method in class fj.data.TreeZipper
+
+
First-class constructor for tree zippers.
+
+
treeZipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the TreeZipper type.
+
+
treeZipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the TreeZipper type.
+
+
treeZipperK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a TreeZipper.
+
+
treeZipperK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a TreeZipper.
+
+
TRUE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
Try - Class in fj
+
+
Created by mperry on 24/07/2014.
+
+
Try0<A,Z extends java.lang.Exception> - Interface in fj.function
+
+
A product of A which may throw an Exception.
+
+
Try1<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function from A to B that may throw an Exception.
+
+
Try2<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-2 from A and B to C that may throw an Exception.
+
+
Try3<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-3 from A, B and C to D that may throw an Exception.
+
+
Try4<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
+
+
Try5<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
+
+
Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
+
+
Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
+
+
Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
+
+
Try_F(Try1<A, B, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_F() - Static method in class fj.data.Conversions
+
 
+
Try_IO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_IO() - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO() - Static method in class fj.data.Conversions
+
 
+
TryEffect - Class in fj
+
+
Created by mperry on 29/08/2014.
+
+
TryEffect0<Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect1<A,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect2<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect3<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect4<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect_P(TryEffect0<E>) - Static method in class fj.data.Conversions
+
 
+
tryNext() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the next element, or throws an error if there are no more elements.
+
+
tryPrevious() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the previous element, or throws an error if there are no more elements.
+
+
tuple(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Uncurries this function to a function on tuples.
+
+
tuple() - Method in class fj.F2W
+
+
Uncurries this function to a function on tuples.
+
+
tuple(F<A, F<B, C>>) - Static method in class fj.P2
+
+
Transforms a curried function of arity-2 to a function of a product-2
+
+
tuple(F2<A, B, C>) - Static method in class fj.P2
+
+
Transforms an uncurried function of arity-2 to a function of a product-2
+
+
two(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of two elements.
+
+
Two<V,A> - Class in fj.data.fingertrees
+
+
A two-element prefix or suffix of a finger tree.
+
+
typeParameterTree(Type) - Static method in class fj.Class
+
+
Provides type parameter information as a Tree of the type expression.
+
+
+ + + +

U

+
+
uncons(B, F2<A, FingerTree<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Performs a reduction on this finger tree using the given arguments.
+
+
uncons(F2<A, List<A>, B>, B) - Method in class fj.data.List
+
 
+
uncons(B, F<A, F<P1<Stream<A>>, B>>) - Method in class fj.data.Stream
+
+
Performs a reduction on this stream using the given arguments.
+
+
uncurryF2() - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF2(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF3() - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF3(F<A, F<B, F<C, D>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF4() - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF4(F<A, F<B, F<C, F<D, E>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF5() - Static method in class fj.Function
+
+
Uncurry a function of arity-5.
+
+
uncurryF5(F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6() - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF7() - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF8() - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
uncurryF8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
undefined() - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.List
+
+
Unfolds across the given function starting at the given value to produce a list.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.Stream
+
+
Unfolds across the given function starting at the given value to produce a stream.
+
+
unfoldTree(F<B, P2<A, P1<Stream<B>>>>) - Static method in class fj.data.Tree
+
+
Builds a tree from a seed value.
+
+
unicodeIdentiferPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
unicodeIdentiferStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
union(Set<A>) - Method in class fj.data.Set
+
+
Add all the elements of the given set to this set.
+
+
union() - Static method in class fj.data.Set
+
+
A first class function for Set.union(Set).
+
+
union(TreeMap<K, V>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
union(Iterable<P2<K, V>>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
unit(A) - Static method in class fj.control.db.DB
+
+
Constructs a database action that returns the given value completely intact.
+
+
unit(A) - Static method in class fj.data.IOFunctions
+
 
+
unit(F<A, B>) - Static method in class fj.data.Reader
+
 
+
unit(F<S, P2<S, A>>) - Static method in class fj.data.State
+
 
+
unit(A, W, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(A, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(B) - Static method in class fj.data.Writer
+
 
+
Unit - Class in fj
+
+
The unit type which has only one value.
+
+
unit() - Static method in class fj.Unit
+
+
The only value of the unit type.
+
+
unitMonoid - Static variable in class fj.Monoid
+
+
A monoid for the Unit value.
+
+
unitOrd - Static variable in class fj.Ord
+
+
An order instance for the Unit type.
+
+
units(F<S, S>) - Static method in class fj.data.State
+
 
+
unitSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup for the Unit value.
+
+
unless(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
unlines(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by newlines.
+
+
unlines(List<String>) - Static method in class fj.function.Strings
+
 
+
unlines() - Static method in class fj.function.Strings
+
 
+
unlines_() - Static method in class fj.data.LazyString
+
 
+
unlineShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for streams that splits into lines.
+
+
unqueue(B, F2<P2<K, A>, PriorityQueue<K, A>, B>) - Method in class fj.data.PriorityQueue
+
+
Performs a reduction on this priority queue using the given arguments.
+
+
Unsafe() - Constructor for class fj.data.List.Unsafe
+
 
+
untuple(F<P2<A, B>, C>) - Static method in class fj.P2
+
+
Transforms a function of a product-2 to an uncurried function or arity-2.
+
+
unwords(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by spaces.
+
+
unzip(Array<P2<A, B>>) - Static method in class fj.data.Array
+
+
Transforms an array of pairs into an array of first components and an array of second components.
+
+
unzip(List<P2<A, B>>) - Static method in class fj.data.List
+
+
Transforms a list of pairs into a list of first components and a list of second components.
+
+
unzip(NonEmptyList<P2<A, B>>) - Static method in class fj.data.NonEmptyList
+
+
Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
+
+
unzip(Stream<P2<A, B>>) - Static method in class fj.data.Stream
+
+
Transforms a stream of pairs into a stream of first components and a stream of second components.
+
+
update(int, A) - Method in class fj.data.Seq
+
+
Replace the element at the given index with the supplied value.
+
+
update(A, F<A, A>) - Method in class fj.data.Set
+
+
Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
+
+
update(K, F<V, V>) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it.
+
+
update(K, F<V, V>, V) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
+
+
upper(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
upper(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
+ + + +

V

+
+
v() - Method in class fj.data.hlist.HPre.HAnd
+
 
+
v() - Method in class fj.data.hlist.HPre.HCond
+
 
+
v() - Method in class fj.data.hlist.HPre.HEq
+
 
+
v() - Method in class fj.data.hlist.HPre.HOr
+
 
+
V - Class in fj.data.vector
+
+
Functions across vectors.
+
+
v(A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(A, A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v(P1<A>, P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v2() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-2.
+
+
V2<A> - Class in fj.data.vector
+
+
A vector-2.
+
+
v2Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-2.
+
+
v2Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-2.
+
+
v2Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-2.
+
+
v3() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-3.
+
+
V3<A> - Class in fj.data.vector
+
+
A vector-3.
+
+
v3Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-3.
+
+
v3Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-3.
+
+
v3Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-3.
+
+
v4() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-4.
+
+
V4<A> - Class in fj.data.vector
+
+
A vector-4.
+
+
v4Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-4.
+
+
v4Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-4.
+
+
v4Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-4.
+
+
v5() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-5.
+
+
V5<A> - Class in fj.data.vector
+
+
A vector-5.
+
+
v5Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-5.
+
+
v5Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-5.
+
+
v5Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-5.
+
+
V6<A> - Class in fj.data.vector
+
+
A vector-6.
+
+
v6Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-6.
+
+
v6Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-6.
+
+
v6Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-6.
+
+
V7<A> - Class in fj.data.vector
+
+
A vector-7.
+
+
v7Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-7.
+
+
v7Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-7.
+
+
v7Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-7.
+
+
V8<A> - Class in fj.data.vector
+
+
A vector-8.
+
+
v8Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-8.
+
+
v8Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-8.
+
+
v8Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-8.
+
+
Validation<E,T> - Class in fj.data
+
+
Isomorphic to Either but has renamed functions and represents failure on the left and success on the right.
+
+
Validation(Either<E, T>) - Constructor for class fj.data.Validation
+
 
+
validation() - Method in class fj.data.Validation.FailProjection
+
+
Returns the underlying validation.
+
+
validation(F<E, X>, F<T, X>) - Method in class fj.data.Validation
+
+
The catamorphism for validation.
+
+
validation(Either<E, T>) - Static method in class fj.data.Validation
+
+
Construct a validation using the given either value.
+
+
validation() - Static method in class fj.data.Validation
+
+
Returns a function that constructs a validation with an either.
+
+
Validation.FailProjection<E,T> - Class in fj.data
+
+
A failing projection of a validation.
+
+
validationEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Validation type.
+
+
validationHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Validation type.
+
+
validationOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Validation type.
+
+
validationShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Validation type.
+
+
value() - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Eval
+
+
Evaluates the computation and return its result.
+
+
value() - Method in class fj.data.fingertrees.One
+
+
Returns the single element in this digit.
+
+
value() - Method in class fj.data.fingertrees.Single
+
+
Returns the single element of this tree.
+
+
value() - Method in class fj.data.Writer
+
 
+
value(A) - Static method in class fj.parser.Parser
+
+
Constructs a parser that always returns the given value.
+
+
value() - Method in class fj.parser.Result
+
+
The parsed value.
+
+
valueE(F0<String>) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(String) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Either.RightProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueE(String) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueOf(String) - Static method in enum fj.Digit
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum fj.Ordering
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Method in class fj.data.fingertrees.Four
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Three
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Two
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.HashMap
+
+
Returns all values in this hash map.
+
+
values() - Method in class fj.data.TreeMap
+
+
Returns all values in this tree map.
+
+
values() - Static method in enum fj.Digit
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum fj.Ordering
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
vary(F<? super A, ? extends B>) - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
vary() - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
Vector_List() - Static method in class fj.data.Java
+
+
A function that converts vectors to lists.
+
+
Visitor - Class in fj.function
+
+
The essence of the visitor design pattern expressed polymorphically.
+
+
visitor(List<F<A, Option<B>>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
+
+
Void - Class in fj
+
+
A logically uninhabited data type.
+
+
voided(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
vzip(V2<A>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V3<A>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V4<A>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V5<A>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V6<A>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V7<A>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V8<A>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
+ + + +

W

+
+
weakMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
+
+
weakMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a WeakReference
+
+
when(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
whitespace(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
whitespace(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
withs(F<S, S>) - Method in class fj.data.State
+
 
+
words() - Method in class fj.data.LazyString
+
+
Splits this lazy string into words by spaces.
+
+
wrap() - Static method in class fj.data.Array
+
+
First-class wrapper function for arrays.
+
+
wrap(Iterable<A>) - Static method in class fj.data.IterableW
+
+
Wraps the given iterable.
+
+
wrap() - Static method in class fj.data.IterableW
+
+
Provides a function that wraps the given iterable.
+
+
writer(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state writer given a connection URL.
+
+
writer(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new writer that writes the database via the given Connector.
+
+
Writer<W,A> - Class in fj.data
+
+
Created by MarkPerry on 7/07/2014.
+
+
writerEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
 
+
+ + + +

X

+
+
xmap(F<P1<A>, P1<B>>, F<P1<B>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given bijective transformation across this strategy (Exponential Functor pattern).
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.data.Enumerator
+
+
Invariant functor map over this enumerator.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Monoid
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xmap(F<I, Z>, F<Z, I>) - Method in class fj.parser.Parser
+
+
Maps the parse input type through an invariant functor.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Semigroup
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xor(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
xor - Static variable in class fj.function.Booleans
+
+
Curried form of logical xor (nonequivalence).
+
+
xor(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using exclusive disjunction
+
+
+ + + +

Z

+
+
zapp(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
+
+
zapp(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
+
+
zero() - Method in class fj.data.fingertrees.Measured
+
+
Returns the identity measurement for the monoid.
+
+
ZERO - Static variable in class fj.data.Natural
+
+
The natural number zero
+
+
zero() - Method in class fj.Monoid
+
+
The zero value for this monoid.
+
+
zip(Array<B>) - Method in class fj.data.Array
+
+
Zips this array with the given array to produce an array of pairs.
+
+
zip(Iterable<B>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable to produce a iterable of pairs.
+
+
zip(List<B>) - Method in class fj.data.List
+
+
Zips this list with the given list to produce a list of pairs.
+
+
zip() - Static method in class fj.data.List
+
+
The first-class version of the zip function.
+
+
zip(NonEmptyList<B>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list to produce a list of pairs.
+
+
zip(Stream<B>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream to produce a stream of pairs.
+
+
zip(V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zipArrayM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
+
+
zipArrayM() - Method in class fj.F2W
+
+
Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
+
+
zipIndex() - Method in class fj.data.Array
+
+
Zips this array with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.IterableW
+
+
Zips this iterable with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.List
+
+
Zips this list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.Stream
+
+
Zips this stream with the index of its element as a pair.
+
+
zipIterableM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two iterables, applying the function lock-step over both iterables.
+
+
zipIterableM() - Method in class fj.F2W
+
+
Promotes this function to zip two iterables, applying the function lock-step over both iterables.
+
+
zipListM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two lists, applying the function lock-step over both lists.
+
+
zipListM() - Method in class fj.F2W
+
+
Promotes this function to zip two lists, applying the function lock-step over both lists.
+
+
zipNelM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
+
+
zipNelM() - Method in class fj.F2W
+
+
Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
+
+
Zipper<A> - Class in fj.data
+
+
Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream.
+
+
zipper(Stream<A>, A, Stream<A>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper with the given streams before and after the focus, and the given focused item.
+
+
zipper(P3<Stream<A>, A, Stream<A>>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper from the given triple.
+
+
zipper() - Static method in class fj.data.Zipper
+
+
First-class constructor of zippers.
+
+
zipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Zipper type.
+
+
zipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Zipper type.
+
+
zipperK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Zipper.
+
+
zipperK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a Zipper.
+
+
zipSetM(F2<A, B, C>, Ord<C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two sets, applying the function lock-step over both sets.
+
+
zipSetM(Ord<C>) - Method in class fj.F2W
+
+
Promotes this function to zip two sets, applying the function lock-step over both sets.
+
+
zipStreamM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two streams, applying the function lock-step over both streams.
+
+
zipStreamM() - Method in class fj.F2W
+
+
Promotes this function to zip two streams, applying the function lock-step over both streams.
+
+
zipTreeM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two trees, applying the function lock-step over both trees.
+
+
zipTreeM() - Method in class fj.F2W
+
+
Promotes this function to zip two trees, applying the function lock-step over both trees.
+
+
zipTreeZipperM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
+
+
zipTreeZipperM() - Method in class fj.F2W
+
+
Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
+
+
zipWith(Trampoline<B>, F2<A, B, C>) - Method in class fj.control.Trampoline
+
+
Combines two trampolines so they run cooperatively.
+
+
zipWith(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Iterable<B>, F<A, F<B, C>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(Iterable<B>, F2<A, B, C>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith() - Static method in class fj.data.List
+
+
Provides a first-class version of zipWith
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Partially-applied version of zipWith.
+
+
zipWith() - Static method in class fj.data.Stream
+
+
A first-class version of the zipWith function.
+
+
zipWith(Tree<B>, F2<A, B, C>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(Tree<B>, F<A, F<B, C>>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(TreeZipper<B>, F2<A, B, C>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(TreeZipper<B>, F<A, F<B, C>>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(F<A, F<B, C>>, V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(Zipper<B>, F2<A, B, C>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWith(Zipper<B>, F<A, F<B, C>>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWithFocus() - Method in class fj.data.TreeZipper
+
+
Zips the nodes in this zipper with a boolean that indicates whether that node has focus.
+
+
zipWithFocus() - Method in class fj.data.Zipper
+
+
Zips the elements of this zipper with a boolean that indicates whether that element has focus.
+
+
zipZipperM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
+
+
zipZipperM() - Method in class fj.F2W
+
+
Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
+
+
+ + + +

_

+
+
_(B) - Static method in class fj.data.$
+
+
Deprecated. +
JDK 8 warns '_' may not be supported after SE 8. As of release 4.4, use $.constant(B) (note the synonym $.__(B)).
+
+
+
_1() - Method in class fj.data.$
+
 
+
_1() - Method in class fj.data.vector.V2
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.P1
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P2
+
+
Access the first element of the product.
+
+
_1() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_1() - Method in class fj.P3
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P4
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P5
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P6
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P7
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P8
+
+
Access the first element of the product.
+
+
_1_() - Method in class fj.P2
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P3
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P4
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P5
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P6
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P7
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P8
+
+
Returns the 1-product projection over the first element.
+
+
_1p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _1.
+
+
_2() - Method in class fj.data.vector.V2
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V3
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V4
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V5
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V6
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V7
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V8
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.P2
+
+
Access the second element of the product.
+
+
_2() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_2() - Method in class fj.P3
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P4
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P5
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P6
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P7
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P8
+
+
Access the second element of the product.
+
+
_2_() - Method in class fj.P2
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P3
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P4
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P5
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P6
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P7
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P8
+
+
Returns the 1-product projection over the second element.
+
+
_2p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _2.
+
+
_3() - Method in class fj.data.vector.V3
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V4
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V5
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V6
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V7
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V8
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.P3
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P4
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P5
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P6
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P7
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P8
+
+
Access the third element of the product.
+
+
_3_() - Method in class fj.P3
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P4
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P5
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P6
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P7
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P8
+
+
Returns the 1-product projection over the third element.
+
+
_4() - Method in class fj.data.vector.V4
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V5
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V6
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V7
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V8
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.P4
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P5
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P6
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P7
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P8
+
+
Access the fourth element of the product.
+
+
_4_() - Method in class fj.P4
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fourth element.
+
+
_5() - Method in class fj.data.vector.V5
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V6
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V7
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V8
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.P5
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P6
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P7
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P8
+
+
Access the fifth element of the product.
+
+
_5_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fifth element.
+
+
_6() - Method in class fj.data.vector.V6
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V7
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V8
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.P6
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P7
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P8
+
+
Access the sixth element of the product.
+
+
_6_() - Method in class fj.P6
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P7
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P8
+
+
Returns the 1-product projection over the sixth element.
+
+
_7() - Method in class fj.data.vector.V7
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.data.vector.V8
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.P7
+
+
Access the seventh element of the product.
+
+
_7() - Method in class fj.P8
+
+
Access the seventh element of the product.
+
+
_7_() - Method in class fj.P7
+
+
Returns the 1-product projection over the seventh element.
+
+
_7_() - Method in class fj.P8
+
+
Returns the 1-product projection over the seventh element.
+
+
_8() - Method in class fj.data.vector.V8
+
+
Returns the eighth element of this vector.
+
+
_8() - Method in class fj.P8
+
+
Access the eighth element of the product.
+
+
_8_() - Method in class fj.P8
+
+
Returns the 1-product projection over the eighth element.
+
+
__(B) - Static method in class fj.data.$
+
 
+
__1() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.P1
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P2
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P3
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P4
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P5
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P6
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P7
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P8
+
+
Returns a function that returns the first element of a product.
+
+
__2() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.P2
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P3
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P4
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P5
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P6
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P7
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P8
+
+
Returns a function that returns the second element of a product.
+
+
__3() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.P3
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P4
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P5
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P6
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P7
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P8
+
+
Returns a function that returns the third element of a product.
+
+
__4() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.P4
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P5
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P6
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P7
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P8
+
+
Returns a function that returns the fourth element of a product.
+
+
__5() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.P5
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P6
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P7
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P8
+
+
Returns a function that returns the fifth element of a product.
+
+
__6() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.P6
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P7
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P8
+
+
Returns a function that returns the sixth element of a product.
+
+
__7() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.P7
+
+
Returns a function that returns the seventh element of a product.
+
+
__7() - Static method in class fj.P8
+
+
Returns a function that returns the seventh element of a product.
+
+
__8() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the eighth element of a vector.
+
+
__8() - Static method in class fj.P8
+
+
Returns a function that returns the eighth element of a product.
+
+
+$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _ 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/index.html b/javadoc/4.8/functionaljava/index.html new file mode 100644 index 0000000..95938d1 --- /dev/null +++ b/javadoc/4.8/functionaljava/index.html @@ -0,0 +1,75 @@ + + + + + +core 4.8 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8/functionaljava/overview-frame.html b/javadoc/4.8/functionaljava/overview-frame.html new file mode 100644 index 0000000..2faad25 --- /dev/null +++ b/javadoc/4.8/functionaljava/overview-frame.html @@ -0,0 +1,32 @@ + + + + + +Overview List (core 4.8 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/4.8/functionaljava/overview-summary.html b/javadoc/4.8/functionaljava/overview-summary.html new file mode 100644 index 0000000..74435c3 --- /dev/null +++ b/javadoc/4.8/functionaljava/overview-summary.html @@ -0,0 +1,205 @@ + + + + + +Overview (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

core 4.8 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj +
Types that set the premise for the existence of Functional Java.
+
fj.control +
Functional control abstractions.
+
fj.control.db +
Abstractions for JDBC connections.
+
fj.control.parallel +
Parallelization strategies.
+
fj.data +
Common algebraic data types.
+
fj.data.fingertrees +
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
fj.data.hamt 
fj.data.hlist +
Type-safe, extensible, heterogeneous lists
+
fj.data.optic +
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
fj.data.vector +
Fixed-length vectors
+
fj.function +
A prelude of commonly used first-class functions
+
fj.parser +
Parser combinators.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/overview-tree.html b/javadoc/4.8/functionaljava/overview-tree.html new file mode 100644 index 0000000..798ad7a --- /dev/null +++ b/javadoc/4.8/functionaljava/overview-tree.html @@ -0,0 +1,446 @@ + + + + + +Class Hierarchy (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/package-list b/javadoc/4.8/functionaljava/package-list new file mode 100644 index 0000000..1ef325a --- /dev/null +++ b/javadoc/4.8/functionaljava/package-list @@ -0,0 +1,12 @@ +fj +fj.control +fj.control.db +fj.control.parallel +fj.data +fj.data.fingertrees +fj.data.hamt +fj.data.hlist +fj.data.optic +fj.data.vector +fj.function +fj.parser diff --git a/javadoc/4.8/functionaljava/script.js b/javadoc/4.8/functionaljava/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8/functionaljava/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8/functionaljava/serialized-form.html b/javadoc/4.8/functionaljava/serialized-form.html new file mode 100644 index 0000000..f35c984 --- /dev/null +++ b/javadoc/4.8/functionaljava/serialized-form.html @@ -0,0 +1,150 @@ + + + + + +Serialized Form (core 4.8 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+
    +
  • +

    Package fj.data

    +
      +
    • + + +

      Class fj.data.Natural extends java.lang.Number implements Serializable

      +
      +
      serialVersionUID:
      +
      -588673650944359682L
      +
      +
        +
      • +

        Serialized Fields

        +
          +
        • +

          value

          +
          java.math.BigInteger value
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8/functionaljava/stylesheet.css b/javadoc/4.8/functionaljava/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8/functionaljava/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} From d662b68b5ab40289a20789236a87b60bd38bd9af Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Giraudeau Date: Mon, 8 Oct 2018 18:19:55 +0200 Subject: [PATCH 05/10] Add 4.8.1 javadoc --- .../allclasses-frame.html | 19 + .../allclasses-noframe.html | 19 + .../constant-values.html | 120 + .../deprecated-list.html | 120 + .../fj/java/util/ListUtil.html | 334 + .../fj/java/util/package-frame.html | 20 + .../fj/java/util/package-summary.html | 140 + .../fj/java/util/package-tree.html | 129 + .../functionaljava-java-core/help-doc.html | 217 + .../functionaljava-java-core/index-all.html | 159 + .../4.8.1/functionaljava-java-core/index.html | 72 + .../overview-tree.html | 133 + .../functionaljava-java-core/package-list | 1 + .../4.8.1/functionaljava-java-core/script.js | 30 + .../functionaljava-java-core/stylesheet.css | 574 + .../allclasses-frame.html | 20 + .../allclasses-noframe.html | 20 + .../functionaljava-java8/constant-values.html | 120 + .../functionaljava-java8/deprecated-list.html | 120 + .../fj/data/Collectors.html | 259 + .../functionaljava-java8/fj/data/Java8.html | 640 + .../fj/data/package-frame.html | 21 + .../fj/data/package-summary.html | 144 + .../fj/data/package-tree.html | 130 + .../4.8.1/functionaljava-java8/help-doc.html | 217 + .../4.8.1/functionaljava-java8/index-all.html | 257 + javadoc/4.8.1/functionaljava-java8/index.html | 72 + .../functionaljava-java8/overview-tree.html | 134 + .../4.8.1/functionaljava-java8/package-list | 1 + javadoc/4.8.1/functionaljava-java8/script.js | 30 + .../4.8.1/functionaljava-java8/stylesheet.css | 574 + .../allclasses-frame.html | 37 + .../allclasses-noframe.html | 37 + .../constant-values.html | 122 + .../deprecated-list.html | 156 + .../fj/data/test/PropertyAssert.html | 236 + .../fj/data/test/package-frame.html | 20 + .../fj/data/test/package-summary.html | 142 + .../fj/data/test/package-tree.html | 135 + .../fj/test/Arbitrary.html | 2646 +++ .../fj/test/Arg.html | 329 + .../fj/test/Bool.html | 375 + .../fj/test/CheckResult.html | 713 + .../fj/test/Cogen.html | 2006 ++ .../fj/test/Gen.html | 1497 ++ .../fj/test/Property.html | 2514 +++ .../fj/test/Rand.html | 468 + .../fj/test/Result.html | 610 + .../fj/test/Shrink.html | 1680 ++ .../fj/test/Variant.html | 270 + .../fj/test/package-frame.html | 30 + .../fj/test/package-summary.html | 225 + .../fj/test/package-tree.html | 145 + .../fj/test/reflect/Category.html | 223 + .../fj/test/reflect/Check.html | 497 + .../fj/test/reflect/CheckParams.html | 309 + .../fj/test/reflect/Main.html | 245 + .../fj/test/reflect/Name.html | 221 + .../fj/test/reflect/NoCheck.html | 166 + .../fj/test/reflect/package-frame.html | 28 + .../fj/test/reflect/package-summary.html | 227 + .../fj/test/reflect/package-tree.html | 143 + .../fj/test/runner/PropertyTestRunner.html | 329 + .../fj/test/runner/package-frame.html | 20 + .../fj/test/runner/package-summary.html | 140 + .../fj/test/runner/package-tree.html | 139 + .../functionaljava-quickcheck/help-doc.html | 223 + .../functionaljava-quickcheck/index-all.html | 2127 +++ .../functionaljava-quickcheck/index.html | 75 + .../overview-frame.html | 24 + .../overview-summary.html | 154 + .../overview-tree.html | 163 + .../functionaljava-quickcheck/package-list | 4 + .../4.8.1/functionaljava-quickcheck/script.js | 30 + .../functionaljava-quickcheck/stylesheet.css | 574 + .../functionaljava/allclasses-frame.html | 230 + .../functionaljava/allclasses-noframe.html | 230 + .../4.8.1/functionaljava/constant-values.html | 205 + .../4.8.1/functionaljava/deprecated-list.html | 327 + javadoc/4.8.1/functionaljava/fj/Bottom.html | 401 + javadoc/4.8.1/functionaljava/fj/Class.html | 373 + javadoc/4.8.1/functionaljava/fj/Digit.html | 637 + javadoc/4.8.1/functionaljava/fj/Effect.html | 384 + .../fj/Equal.AltDefinition.html | 263 + .../functionaljava/fj/Equal.Definition.html | 291 + javadoc/4.8.1/functionaljava/fj/Equal.html | 1651 ++ javadoc/4.8.1/functionaljava/fj/F.html | 236 + javadoc/4.8.1/functionaljava/fj/F0.html | 224 + .../4.8.1/functionaljava/fj/F1Functions.html | 1691 ++ .../4.8.1/functionaljava/fj/F1W.F1WFunc.html | 316 + javadoc/4.8.1/functionaljava/fj/F1W.html | 1710 ++ javadoc/4.8.1/functionaljava/fj/F2.html | 239 + .../4.8.1/functionaljava/fj/F2Functions.html | 742 + .../4.8.1/functionaljava/fj/F2W.F2WFunc.html | 319 + javadoc/4.8.1/functionaljava/fj/F2W.html | 813 + javadoc/4.8.1/functionaljava/fj/F3.html | 242 + .../4.8.1/functionaljava/fj/F3Functions.html | 249 + javadoc/4.8.1/functionaljava/fj/F3W.html | 248 + javadoc/4.8.1/functionaljava/fj/F4.html | 245 + .../4.8.1/functionaljava/fj/F4Functions.html | 249 + javadoc/4.8.1/functionaljava/fj/F4W.html | 248 + javadoc/4.8.1/functionaljava/fj/F5.html | 251 + .../4.8.1/functionaljava/fj/F5Functions.html | 249 + javadoc/4.8.1/functionaljava/fj/F5W.html | 248 + javadoc/4.8.1/functionaljava/fj/F6.html | 254 + .../4.8.1/functionaljava/fj/F6Functions.html | 249 + javadoc/4.8.1/functionaljava/fj/F6W.html | 248 + javadoc/4.8.1/functionaljava/fj/F7.html | 257 + .../4.8.1/functionaljava/fj/F7Functions.html | 249 + javadoc/4.8.1/functionaljava/fj/F7W.html | 248 + javadoc/4.8.1/functionaljava/fj/F8.html | 260 + .../4.8.1/functionaljava/fj/F8Functions.html | 247 + javadoc/4.8.1/functionaljava/fj/F8W.html | 248 + javadoc/4.8.1/functionaljava/fj/Function.html | 2162 +++ javadoc/4.8.1/functionaljava/fj/Hash.html | 1264 ++ javadoc/4.8.1/functionaljava/fj/LcgRng.html | 330 + .../fj/Monoid.AltDefinition.html | 263 + .../functionaljava/fj/Monoid.Definition.html | 329 + javadoc/4.8.1/functionaljava/fj/Monoid.html | 1441 ++ .../functionaljava/fj/Ord.AltDefinition.html | 298 + .../functionaljava/fj/Ord.Definition.html | 427 + javadoc/4.8.1/functionaljava/fj/Ord.html | 1439 ++ javadoc/4.8.1/functionaljava/fj/Ordering.html | 401 + javadoc/4.8.1/functionaljava/fj/P.html | 1057 ++ javadoc/4.8.1/functionaljava/fj/P1.html | 952 + javadoc/4.8.1/functionaljava/fj/P2.Optic.html | 291 + javadoc/4.8.1/functionaljava/fj/P2.html | 1079 ++ javadoc/4.8.1/functionaljava/fj/P3.html | 686 + javadoc/4.8.1/functionaljava/fj/P4.html | 746 + javadoc/4.8.1/functionaljava/fj/P5.html | 806 + javadoc/4.8.1/functionaljava/fj/P6.html | 866 + javadoc/4.8.1/functionaljava/fj/P7.html | 926 + javadoc/4.8.1/functionaljava/fj/P8.html | 984 + .../4.8.1/functionaljava/fj/Primitive.html | 1121 ++ javadoc/4.8.1/functionaljava/fj/Rng.html | 315 + .../fj/Semigroup.AltDefinition.html | 263 + .../fj/Semigroup.Definition.html | 294 + .../4.8.1/functionaljava/fj/Semigroup.html | 1356 ++ javadoc/4.8.1/functionaljava/fj/Show.html | 1759 ++ javadoc/4.8.1/functionaljava/fj/Try.html | 434 + .../4.8.1/functionaljava/fj/TryEffect.html | 340 + javadoc/4.8.1/functionaljava/fj/Unit.html | 260 + javadoc/4.8.1/functionaljava/fj/Void.html | 239 + .../functionaljava/fj/control/Trampoline.html | 604 + .../fj/control/db/Connector.html | 275 + .../functionaljava/fj/control/db/DB.html | 459 + .../functionaljava/fj/control/db/DbState.html | 358 + .../fj/control/db/package-frame.html | 22 + .../fj/control/db/package-summary.html | 163 + .../fj/control/db/package-tree.html | 137 + .../fj/control/package-frame.html | 20 + .../fj/control/package-summary.html | 151 + .../fj/control/package-tree.html | 135 + .../fj/control/parallel/Actor.html | 371 + .../fj/control/parallel/Callables.html | 731 + .../fj/control/parallel/ParModule.html | 1412 ++ .../fj/control/parallel/Promise.html | 864 + .../fj/control/parallel/Strategy.html | 1118 ++ .../fj/control/parallel/package-frame.html | 24 + .../fj/control/parallel/package-summary.html | 175 + .../fj/control/parallel/package-tree.html | 139 + javadoc/4.8.1/functionaljava/fj/data/$.html | 300 + .../fj/data/Array.ImmutableProjection.html | 679 + .../4.8.1/functionaljava/fj/data/Array.html | 1719 ++ .../functionaljava/fj/data/Conversions.html | 1607 ++ .../4.8.1/functionaljava/fj/data/DList.html | 474 + .../fj/data/Either.LeftProjection.html | 794 + .../fj/data/Either.RightProjection.html | 761 + .../4.8.1/functionaljava/fj/data/Either.html | 944 + .../functionaljava/fj/data/Enumerator.html | 858 + .../4.8.1/functionaljava/fj/data/Eval.html | 450 + .../4.8.1/functionaljava/fj/data/HashMap.html | 1116 ++ .../4.8.1/functionaljava/fj/data/HashSet.html | 805 + javadoc/4.8.1/functionaljava/fj/data/IO.html | 237 + .../functionaljava/fj/data/IOFunctions.html | 1011 + javadoc/4.8.1/functionaljava/fj/data/IOW.html | 339 + .../functionaljava/fj/data/IterableW.html | 851 + .../fj/data/Iteratee.Input.html | 294 + .../fj/data/Iteratee.IterV.html | 389 + .../functionaljava/fj/data/Iteratee.html | 222 + .../4.8.1/functionaljava/fj/data/Java.html | 3648 ++++ .../functionaljava/fj/data/LazyString.html | 983 + .../functionaljava/fj/data/List.Buffer.html | 483 + .../functionaljava/fj/data/List.Optic.html | 323 + .../functionaljava/fj/data/List.Unsafe.html | 239 + .../4.8.1/functionaljava/fj/data/List.html | 3771 ++++ .../4.8.1/functionaljava/fj/data/Natural.html | 930 + .../functionaljava/fj/data/NonEmptyList.html | 1041 + .../functionaljava/fj/data/Option.Optic.html | 274 + .../4.8.1/functionaljava/fj/data/Option.html | 2227 +++ .../functionaljava/fj/data/PriorityQueue.html | 646 + .../4.8.1/functionaljava/fj/data/Reader.html | 366 + .../4.8.1/functionaljava/fj/data/SafeIO.html | 229 + javadoc/4.8.1/functionaljava/fj/data/Seq.html | 1011 + javadoc/4.8.1/functionaljava/fj/data/Set.html | 1370 ++ .../4.8.1/functionaljava/fj/data/State.html | 479 + .../4.8.1/functionaljava/fj/data/Stream.html | 3302 ++++ .../4.8.1/functionaljava/fj/data/Tree.html | 909 + .../4.8.1/functionaljava/fj/data/TreeMap.html | 1018 + .../functionaljava/fj/data/TreeZipper.html | 1368 ++ .../fj/data/Validation.FailProjection.html | 678 + .../functionaljava/fj/data/Validation.html | 2499 +++ .../4.8.1/functionaljava/fj/data/Writer.html | 380 + .../4.8.1/functionaljava/fj/data/Zipper.html | 1286 ++ .../fj/data/fingertrees/Deep.html | 727 + .../fj/data/fingertrees/Digit.html | 480 + .../fj/data/fingertrees/Empty.html | 667 + .../fj/data/fingertrees/FingerTree.html | 870 + .../fj/data/fingertrees/Four.html | 419 + .../fj/data/fingertrees/MakeTree.html | 544 + .../fj/data/fingertrees/Measured.html | 390 + .../fj/data/fingertrees/Node.html | 399 + .../fj/data/fingertrees/Node2.html | 396 + .../fj/data/fingertrees/Node3.html | 396 + .../fj/data/fingertrees/One.html | 419 + .../fj/data/fingertrees/Single.html | 687 + .../fj/data/fingertrees/Three.html | 419 + .../fj/data/fingertrees/Two.html | 419 + .../fj/data/fingertrees/package-frame.html | 33 + .../fj/data/fingertrees/package-summary.html | 236 + .../fj/data/fingertrees/package-tree.html | 157 + .../functionaljava/fj/data/hamt/BitSet.html | 811 + .../fj/data/hamt/HashArrayMappedTrie.html | 606 + .../functionaljava/fj/data/hamt/Node.html | 358 + .../fj/data/hamt/package-frame.html | 22 + .../fj/data/hamt/package-summary.html | 157 + .../fj/data/hamt/package-tree.html | 137 + .../fj/data/hlist/HList.Apply.html | 392 + .../fj/data/hlist/HList.HAppend.html | 304 + .../fj/data/hlist/HList.HCons.html | 324 + .../fj/data/hlist/HList.HFoldr.html | 323 + .../fj/data/hlist/HList.HNil.html | 298 + .../functionaljava/fj/data/hlist/HList.html | 384 + .../fj/data/hlist/HPre.HAdd.html | 298 + .../fj/data/hlist/HPre.HAnd.html | 306 + .../fj/data/hlist/HPre.HBool.html | 204 + .../fj/data/hlist/HPre.HCond.html | 285 + .../fj/data/hlist/HPre.HEq.html | 323 + .../fj/data/hlist/HPre.HFalse.html | 205 + .../fj/data/hlist/HPre.HNat.html | 332 + .../fj/data/hlist/HPre.HOr.html | 306 + .../fj/data/hlist/HPre.HSucc.html | 277 + .../fj/data/hlist/HPre.HTrue.html | 205 + .../fj/data/hlist/HPre.HZero.html | 273 + .../functionaljava/fj/data/hlist/HPre.html | 344 + .../fj/data/hlist/package-frame.html | 37 + .../fj/data/hlist/package-summary.html | 253 + .../fj/data/hlist/package-tree.html | 161 + .../functionaljava/fj/data/optic/Fold.html | 524 + .../functionaljava/fj/data/optic/Getter.html | 457 + .../functionaljava/fj/data/optic/Iso.html | 624 + .../functionaljava/fj/data/optic/Lens.html | 770 + .../fj/data/optic/Optional.html | 817 + .../functionaljava/fj/data/optic/PIso.html | 844 + .../functionaljava/fj/data/optic/PLens.html | 730 + .../fj/data/optic/POptional.html | 790 + .../functionaljava/fj/data/optic/PPrism.html | 802 + .../functionaljava/fj/data/optic/PSetter.html | 426 + .../fj/data/optic/PTraversal.html | 908 + .../functionaljava/fj/data/optic/Prism.html | 522 + .../functionaljava/fj/data/optic/Setter.html | 419 + .../fj/data/optic/Traversal.html | 723 + .../fj/data/optic/package-frame.html | 33 + .../fj/data/optic/package-summary.html | 247 + .../fj/data/optic/package-tree.html | 166 + .../functionaljava/fj/data/package-frame.html | 65 + .../fj/data/package-summary.html | 413 + .../functionaljava/fj/data/package-tree.html | 191 + .../functionaljava/fj/data/vector/V.html | 547 + .../functionaljava/fj/data/vector/V2.html | 647 + .../functionaljava/fj/data/vector/V3.html | 732 + .../functionaljava/fj/data/vector/V4.html | 772 + .../functionaljava/fj/data/vector/V5.html | 812 + .../functionaljava/fj/data/vector/V6.html | 852 + .../functionaljava/fj/data/vector/V7.html | 892 + .../functionaljava/fj/data/vector/V8.html | 932 + .../fj/data/vector/package-frame.html | 27 + .../fj/data/vector/package-summary.html | 193 + .../fj/data/vector/package-tree.html | 142 + .../fj/function/BigIntegers.html | 402 + .../functionaljava/fj/function/Booleans.html | 775 + .../fj/function/Characters.html | 563 + .../functionaljava/fj/function/Doubles.html | 502 + .../functionaljava/fj/function/Effect0.html | 220 + .../functionaljava/fj/function/Effect1.html | 222 + .../functionaljava/fj/function/Effect2.html | 224 + .../functionaljava/fj/function/Effect3.html | 226 + .../functionaljava/fj/function/Effect4.html | 228 + .../functionaljava/fj/function/Effect5.html | 230 + .../functionaljava/fj/function/Effect6.html | 232 + .../functionaljava/fj/function/Effect7.html | 234 + .../functionaljava/fj/function/Effect8.html | 236 + .../functionaljava/fj/function/Integers.html | 502 + .../functionaljava/fj/function/Longs.html | 321 + .../functionaljava/fj/function/Strings.html | 467 + .../functionaljava/fj/function/Try0.html | 231 + .../functionaljava/fj/function/Try1.html | 233 + .../functionaljava/fj/function/Try2.html | 235 + .../functionaljava/fj/function/Try3.html | 237 + .../functionaljava/fj/function/Try4.html | 239 + .../functionaljava/fj/function/Try5.html | 241 + .../functionaljava/fj/function/Try6.html | 243 + .../functionaljava/fj/function/Try7.html | 245 + .../functionaljava/fj/function/Try8.html | 247 + .../fj/function/TryEffect0.html | 225 + .../fj/function/TryEffect1.html | 227 + .../fj/function/TryEffect2.html | 229 + .../fj/function/TryEffect3.html | 231 + .../fj/function/TryEffect4.html | 233 + .../fj/function/TryEffect5.html | 235 + .../fj/function/TryEffect6.html | 237 + .../fj/function/TryEffect7.html | 239 + .../fj/function/TryEffect8.html | 241 + .../functionaljava/fj/function/Visitor.html | 393 + .../fj/function/package-frame.html | 57 + .../fj/function/package-summary.html | 366 + .../fj/function/package-tree.html | 172 + .../functionaljava/fj/package-frame.html | 89 + .../functionaljava/fj/package-summary.html | 555 + .../4.8.1/functionaljava/fj/package-tree.html | 238 + .../fj/parser/Parser.CharsParser.html | 1503 ++ .../fj/parser/Parser.StreamParser.html | 331 + .../functionaljava/fj/parser/Parser.html | 949 + .../functionaljava/fj/parser/Result.html | 524 + .../fj/parser/package-frame.html | 23 + .../fj/parser/package-summary.html | 170 + .../fj/parser/package-tree.html | 138 + javadoc/4.8.1/functionaljava/help-doc.html | 223 + javadoc/4.8.1/functionaljava/index-all.html | 15676 ++++++++++++++++ javadoc/4.8.1/functionaljava/index.html | 75 + .../4.8.1/functionaljava/overview-frame.html | 32 + .../functionaljava/overview-summary.html | 205 + .../4.8.1/functionaljava/overview-tree.html | 446 + javadoc/4.8.1/functionaljava/package-list | 12 + javadoc/4.8.1/functionaljava/script.js | 30 + .../4.8.1/functionaljava/serialized-form.html | 150 + javadoc/4.8.1/functionaljava/stylesheet.css | 574 + 337 files changed, 180032 insertions(+) create mode 100644 javadoc/4.8.1/functionaljava-java-core/allclasses-frame.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/allclasses-noframe.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/constant-values.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/deprecated-list.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/fj/java/util/ListUtil.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/help-doc.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/index-all.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/index.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/overview-tree.html create mode 100644 javadoc/4.8.1/functionaljava-java-core/package-list create mode 100644 javadoc/4.8.1/functionaljava-java-core/script.js create mode 100644 javadoc/4.8.1/functionaljava-java-core/stylesheet.css create mode 100644 javadoc/4.8.1/functionaljava-java8/allclasses-frame.html create mode 100644 javadoc/4.8.1/functionaljava-java8/allclasses-noframe.html create mode 100644 javadoc/4.8.1/functionaljava-java8/constant-values.html create mode 100644 javadoc/4.8.1/functionaljava-java8/deprecated-list.html create mode 100644 javadoc/4.8.1/functionaljava-java8/fj/data/Collectors.html create mode 100644 javadoc/4.8.1/functionaljava-java8/fj/data/Java8.html create mode 100644 javadoc/4.8.1/functionaljava-java8/fj/data/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-java8/fj/data/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-java8/fj/data/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-java8/help-doc.html create mode 100644 javadoc/4.8.1/functionaljava-java8/index-all.html create mode 100644 javadoc/4.8.1/functionaljava-java8/index.html create mode 100644 javadoc/4.8.1/functionaljava-java8/overview-tree.html create mode 100644 javadoc/4.8.1/functionaljava-java8/package-list create mode 100644 javadoc/4.8.1/functionaljava-java8/script.js create mode 100644 javadoc/4.8.1/functionaljava-java8/stylesheet.css create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/allclasses-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/allclasses-noframe.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/constant-values.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/deprecated-list.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/PropertyAssert.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arbitrary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arg.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Bool.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/CheckResult.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Cogen.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Gen.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Property.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Rand.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Result.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Shrink.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/Variant.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Category.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Check.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/CheckParams.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Main.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Name.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/NoCheck.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/help-doc.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/index-all.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/index.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/overview-frame.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/overview-summary.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/overview-tree.html create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/package-list create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/script.js create mode 100644 javadoc/4.8.1/functionaljava-quickcheck/stylesheet.css create mode 100644 javadoc/4.8.1/functionaljava/allclasses-frame.html create mode 100644 javadoc/4.8.1/functionaljava/allclasses-noframe.html create mode 100644 javadoc/4.8.1/functionaljava/constant-values.html create mode 100644 javadoc/4.8.1/functionaljava/deprecated-list.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Bottom.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Class.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Digit.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Effect.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Equal.AltDefinition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Equal.Definition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Equal.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F0.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F1Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F1W.F1WFunc.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F1W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F2Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F2W.F2WFunc.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F2W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F3Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F3W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F4Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F4W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F5Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F5W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F6Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F6W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F7Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F7W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F8Functions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/F8W.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Function.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Hash.html create mode 100644 javadoc/4.8.1/functionaljava/fj/LcgRng.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Monoid.AltDefinition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Monoid.Definition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Monoid.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Ord.AltDefinition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Ord.Definition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Ord.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Ordering.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P1.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P2.Optic.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/P8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Primitive.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Rng.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Semigroup.AltDefinition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Semigroup.Definition.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Semigroup.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Show.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Try.html create mode 100644 javadoc/4.8.1/functionaljava/fj/TryEffect.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Unit.html create mode 100644 javadoc/4.8.1/functionaljava/fj/Void.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/Trampoline.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/Connector.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/DB.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/DbState.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/db/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/Actor.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/Callables.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/ParModule.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/Promise.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/Strategy.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/control/parallel/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/$.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Array.ImmutableProjection.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Array.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Conversions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/DList.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Either.LeftProjection.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Either.RightProjection.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Either.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Enumerator.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Eval.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/HashMap.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/HashSet.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/IO.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/IOFunctions.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/IOW.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/IterableW.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Iteratee.Input.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Iteratee.IterV.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Iteratee.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Java.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/LazyString.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/List.Buffer.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/List.Optic.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/List.Unsafe.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/List.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Natural.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/NonEmptyList.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Option.Optic.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Option.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/PriorityQueue.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Reader.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/SafeIO.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Seq.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Set.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/State.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Stream.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/TreeMap.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/TreeZipper.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Validation.FailProjection.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Validation.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Writer.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/Zipper.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Deep.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Digit.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Empty.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/FingerTree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Four.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/MakeTree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Measured.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/One.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Single.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Three.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/Two.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/BitSet.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/HashArrayMappedTrie.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/Node.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hamt/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.Apply.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HAppend.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HCons.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HFoldr.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HNil.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HList.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAdd.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAnd.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HBool.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HCond.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HEq.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HFalse.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HNat.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HOr.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HSucc.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HTrue.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HZero.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/hlist/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Fold.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Getter.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Iso.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Lens.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Optional.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/PIso.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/PLens.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/POptional.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/PPrism.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/PSetter.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/PTraversal.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Prism.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Setter.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/Traversal.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/optic/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/V8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/data/vector/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/BigIntegers.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Booleans.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Characters.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Doubles.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect0.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect1.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Effect8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Integers.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Longs.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Strings.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try0.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try1.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Try8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect0.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect1.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect2.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect3.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect4.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect5.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect6.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect7.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/TryEffect8.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/Visitor.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/function/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/Parser.CharsParser.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/Parser.StreamParser.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/Parser.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/Result.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/package-frame.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/package-summary.html create mode 100644 javadoc/4.8.1/functionaljava/fj/parser/package-tree.html create mode 100644 javadoc/4.8.1/functionaljava/help-doc.html create mode 100644 javadoc/4.8.1/functionaljava/index-all.html create mode 100644 javadoc/4.8.1/functionaljava/index.html create mode 100644 javadoc/4.8.1/functionaljava/overview-frame.html create mode 100644 javadoc/4.8.1/functionaljava/overview-summary.html create mode 100644 javadoc/4.8.1/functionaljava/overview-tree.html create mode 100644 javadoc/4.8.1/functionaljava/package-list create mode 100644 javadoc/4.8.1/functionaljava/script.js create mode 100644 javadoc/4.8.1/functionaljava/serialized-form.html create mode 100644 javadoc/4.8.1/functionaljava/stylesheet.css diff --git a/javadoc/4.8.1/functionaljava-java-core/allclasses-frame.html b/javadoc/4.8.1/functionaljava-java-core/allclasses-frame.html new file mode 100644 index 0000000..6364df8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/allclasses-frame.html @@ -0,0 +1,19 @@ + + + + + +All Classes (java-core 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java-core/allclasses-noframe.html b/javadoc/4.8.1/functionaljava-java-core/allclasses-noframe.html new file mode 100644 index 0000000..7da2e2f --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/allclasses-noframe.html @@ -0,0 +1,19 @@ + + + + + +All Classes (java-core 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java-core/constant-values.html b/javadoc/4.8.1/functionaljava-java-core/constant-values.html new file mode 100644 index 0000000..891d70f --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/deprecated-list.html b/javadoc/4.8.1/functionaljava-java-core/deprecated-list.html new file mode 100644 index 0000000..16a7bd5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/fj/java/util/ListUtil.html b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/ListUtil.html new file mode 100644 index 0000000..411a75a --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/ListUtil.html @@ -0,0 +1,334 @@ + + + + + +ListUtil (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.java.util
+

Class ListUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.java.util.ListUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ListUtil
+extends java.lang.Object
    +
    Created by MarkPerry on 28/08/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ListUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.List<B>bind(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A> java.util.List<A>filter(java.util.List<A> list, + fj.F<A,java.lang.Boolean> f) 
      static <A,B> java.util.List<B>flatMap(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A,B> Bfold(java.util.List<A> list, + fj.F2<B,A,B> f, + B b) 
      static <A,B> java.util.List<B>map(java.util.List<A> list, + fj.F<A,B> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ListUtil

        +
        public ListUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        map

        +
        public static <A,B> java.util.List<B> map(java.util.List<A> list,
+                                          fj.F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> java.util.List<A> filter(java.util.List<A> list,
+                                           fj.F<A,java.lang.Boolean> f)
        +
        • +
      + + + + + +
        +
      • +

        fold

        +
        public static <A,B> B fold(java.util.List<A> list,
+                           fj.F2<B,A,B> f,
+                           B b)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> java.util.List<B> flatMap(java.util.List<A> list,
+                                              fj.F<A,java.util.List<B>> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.List<B> bind(java.util.List<A> list,
+                                           fj.F<A,java.util.List<B>> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-frame.html b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-frame.html new file mode 100644 index 0000000..28fe6ef --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.java.util (java-core 4.8.1 API) + + + + + +

fj.java.util

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-summary.html b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-summary.html new file mode 100644 index 0000000..a862507 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-summary.html @@ -0,0 +1,140 @@ + + + + + +fj.java.util (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package fj.java.util

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ListUtil +
    Created by MarkPerry on 28/08/2015.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-tree.html b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-tree.html new file mode 100644 index 0000000..6e80691 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/fj/java/util/package-tree.html @@ -0,0 +1,129 @@ + + + + + +fj.java.util Class Hierarchy (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.java.util

+
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/help-doc.html b/javadoc/4.8.1/functionaljava-java-core/help-doc.html new file mode 100644 index 0000000..52f978d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/index-all.html b/javadoc/4.8.1/functionaljava-java-core/index-all.html new file mode 100644 index 0000000..18640b8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/index-all.html @@ -0,0 +1,159 @@ + + + + + +Index (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
B F L M  + + +

B

+
+
bind(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

F

+
+
filter(List<A>, F<A, Boolean>) - Static method in class fj.java.util.ListUtil
+
 
+
fj.java.util - package fj.java.util
+
 
+
flatMap(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
fold(List<A>, F2<B, A, B>, B) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

L

+
+
ListUtil - Class in fj.java.util
+
+
Created by MarkPerry on 28/08/2015.
+
+
ListUtil() - Constructor for class fj.java.util.ListUtil
+
 
+
+ + + +

M

+
+
map(List<A>, F<A, B>) - Static method in class fj.java.util.ListUtil
+
 
+
+B F L M 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/index.html b/javadoc/4.8.1/functionaljava-java-core/index.html new file mode 100644 index 0000000..086f1ab --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/index.html @@ -0,0 +1,72 @@ + + + + + +java-core 4.8.1 API + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="fj/java/util/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8.1/functionaljava-java-core/overview-tree.html b/javadoc/4.8.1/functionaljava-java-core/overview-tree.html new file mode 100644 index 0000000..11837f3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/overview-tree.html @@ -0,0 +1,133 @@ + + + + + +Class Hierarchy (java-core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java-core/package-list b/javadoc/4.8.1/functionaljava-java-core/package-list new file mode 100644 index 0000000..01c82ea --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/package-list @@ -0,0 +1 @@ +fj.java.util diff --git a/javadoc/4.8.1/functionaljava-java-core/script.js b/javadoc/4.8.1/functionaljava-java-core/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8.1/functionaljava-java-core/stylesheet.css b/javadoc/4.8.1/functionaljava-java-core/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java-core/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8.1/functionaljava-java8/allclasses-frame.html b/javadoc/4.8.1/functionaljava-java8/allclasses-frame.html new file mode 100644 index 0000000..67583d4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/allclasses-frame.html @@ -0,0 +1,20 @@ + + + + + +All Classes (java8 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java8/allclasses-noframe.html b/javadoc/4.8.1/functionaljava-java8/allclasses-noframe.html new file mode 100644 index 0000000..1aa5253 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/allclasses-noframe.html @@ -0,0 +1,20 @@ + + + + + +All Classes (java8 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java8/constant-values.html b/javadoc/4.8.1/functionaljava-java8/constant-values.html new file mode 100644 index 0000000..54ddcde --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/deprecated-list.html b/javadoc/4.8.1/functionaljava-java8/deprecated-list.html new file mode 100644 index 0000000..b89f73c --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/fj/data/Collectors.html b/javadoc/4.8.1/functionaljava-java8/fj/data/Collectors.html new file mode 100644 index 0000000..a07285e --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/fj/data/Collectors.html @@ -0,0 +1,259 @@ + + + + + +Collectors (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Collectors

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Collectors
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Collectors
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Array<A>>toArray() 
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.List<A>>toList() 
      static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Stream<A>>toStream() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        toList

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.List<A>> toList()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Array<A>> toArray()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static <A> java.util.stream.Collector<A,fj.data.List.Buffer<A>,fj.data.Stream<A>> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/fj/data/Java8.html b/javadoc/4.8.1/functionaljava-java8/fj/data/Java8.html new file mode 100644 index 0000000..b3639ff --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/fj/data/Java8.html @@ -0,0 +1,640 @@ + + + + + +Java8 (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Java8

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java8
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java8
+extends java.lang.Object
    +
    Created by mperry on 3/06/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> fj.F<java.util.function.BiFunction<A,B,C>,fj.F2<A,B,C>>BiFunction_F2() 
      static <A,B,C> fj.F2<A,B,C>BiFunction_F2(java.util.function.BiFunction<A,B,C> f) 
      static <A> fj.F<java.util.function.Consumer<A>,fj.F<A,fj.Unit>>Consumer_F() 
      static <A> fj.F<A,fj.Unit>Consumer_F(java.util.function.Consumer<A> c) 
      static <A,B> fj.F<fj.F<A,B>,java.util.function.Function<A,B>>F_Function() 
      static <A,B> java.util.function.Function<A,B>F_Function(fj.F<A,B> f) 
      static <A,B,C> fj.F<fj.F2<A,B,C>,java.util.function.BiFunction<A,B,C>>F2_BiFunction() 
      static <A,B,C> java.util.function.BiFunction<A,B,C>F2_BiFunction(fj.F2<A,B,C> f) 
      static <A,B> fj.F<java.util.function.Function<A,B>,fj.F<A,B>>Function_F() 
      static <A,B> fj.F<A,B>Function_F(java.util.function.Function<A,B> f) 
      static <A> java.util.stream.Stream<A>Iterable_JavaStream(java.lang.Iterable<A> it) 
      static <A> java.util.stream.Stream<A>Iterator_JavaStream(java.util.Iterator<A> it) 
      static <A> fj.data.Array<A>JavaStream_Array(java.util.stream.Stream<A> s) 
      static <A> fj.data.List<A>JavaStream_List(java.util.stream.Stream<A> s) 
      static <A> fj.data.Stream<A>JavaStream_Stream(java.util.stream.Stream<A> s) 
      static <A> java.util.stream.Stream<A>List_JavaStream(fj.data.List<A> list) 
      static <A> fj.F<fj.data.Option<A>,java.util.Optional<A>>Option_Optional() 
      static <A> java.util.Optional<A>Option_Optional(fj.data.Option<A> o) +
      Convert an Option to Optional.
      +
      static <A> fj.F<java.util.Optional<A>,fj.data.Option<A>>Optional_Option() 
      static <A> fj.data.Option<A>Optional_Option(java.util.Optional<A> o) 
      static <A> fj.F<fj.P1<A>,java.util.function.Supplier<A>>P1_Supplier() 
      static <A> java.util.function.Supplier<A>P1_Supplier(fj.P1<A> p) 
      static <A> fj.F<fj.data.Stream<A>,java.util.stream.Stream<A>>Stream_JavaStream() 
      static <A> java.util.stream.Stream<A>Stream_JavaStream(fj.data.Stream<A> s) 
      static <A> fj.F<java.util.function.Supplier<A>,fj.P1<A>>Supplier_P1() 
      static <A> fj.P1<A>Supplier_P1(java.util.function.Supplier<A> s) 
      static <A,E extends java.lang.Exception>
      fj.F<fj.function.Try0<A,E>,java.util.function.Supplier<fj.data.Validation<E,A>>>      		TryCatch0_Supplier() 
      static <A,E extends java.lang.Exception>
      java.util.function.Supplier<fj.data.Validation<E,A>>      		TryCatch0_Supplier(fj.function.Try0<A,E> t) 
      static <A,B,E extends java.lang.Exception>
      fj.F<fj.function.Try1<A,B,E>,java.util.function.Function<A,fj.data.Validation<E,B>>>      		TryCatch1_Function() 
      static <A,B,E extends java.lang.Exception>
      java.util.function.Function<A,fj.data.Validation<E,B>>      		TryCatch1_Function(fj.function.Try1<A,B,E> t) 
      static <A,B,C,E extends java.lang.Exception>
      fj.F<fj.function.Try2<A,B,C,E>,java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>>      		TryCatch2_BiFunction() 
      static <A,B,C,E extends java.lang.Exception>
      java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>      		TryCatch2_BiFunction(fj.function.Try2<A,B,C,E> t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> fj.P1<A> Supplier_P1(java.util.function.Supplier<A> s)
        +
        • +
      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> fj.F<java.util.function.Supplier<A>,fj.P1<A>> Supplier_P1()
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> java.util.function.Supplier<A> P1_Supplier(fj.P1<A> p)
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> fj.F<fj.P1<A>,java.util.function.Supplier<A>> P1_Supplier()
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> fj.F<A,B> Function_F(java.util.function.Function<A,B> f)
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> fj.F<java.util.function.Function<A,B>,fj.F<A,B>> Function_F()
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> java.util.function.Function<A,B> F_Function(fj.F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> fj.F<fj.F<A,B>,java.util.function.Function<A,B>> F_Function()
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> fj.F2<A,B,C> BiFunction_F2(java.util.function.BiFunction<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> fj.F<java.util.function.BiFunction<A,B,C>,fj.F2<A,B,C>> BiFunction_F2()
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> java.util.function.BiFunction<A,B,C> F2_BiFunction(fj.F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> fj.F<fj.F2<A,B,C>,java.util.function.BiFunction<A,B,C>> F2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> java.util.function.Supplier<fj.data.Validation<E,A>> TryCatch0_Supplier(fj.function.Try0<A,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> fj.F<fj.function.Try0<A,E>,java.util.function.Supplier<fj.data.Validation<E,A>>> TryCatch0_Supplier()
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> java.util.function.Function<A,fj.data.Validation<E,B>> TryCatch1_Function(fj.function.Try1<A,B,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> fj.F<fj.function.Try1<A,B,E>,java.util.function.Function<A,fj.data.Validation<E,B>>> TryCatch1_Function()
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> java.util.function.BiFunction<A,B,fj.data.Validation<E,C>> TryCatch2_BiFunction(fj.function.Try2<A,B,C,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> fj.F<fj.function.Try2<A,B,C,E>,java.util.function.BiFunction<A,B,fj.data.Validation<E,C>>> TryCatch2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        List_JavaStream

        +
        public static <A> java.util.stream.Stream<A> List_JavaStream(fj.data.List<A> list)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> fj.data.Option<A> Optional_Option(java.util.Optional<A> o)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> fj.F<java.util.Optional<A>,fj.data.Option<A>> Optional_Option()
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> java.util.Optional<A> Option_Optional(fj.data.Option<A> o)
        +
        Convert an Option to Optional. Will throw a NullPointerException if the Option is some(null).
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> fj.F<fj.data.Option<A>,java.util.Optional<A>> Option_Optional()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> fj.F<java.util.function.Consumer<A>,fj.F<A,fj.Unit>> Consumer_F()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> fj.F<A,fj.Unit> Consumer_F(java.util.function.Consumer<A> c)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Stream_JavaStream(fj.data.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        Iterable_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterable_JavaStream(java.lang.Iterable<A> it)
        +
        • +
      + + + +
        +
      • +

        Iterator_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterator_JavaStream(java.util.Iterator<A> it)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> fj.F<fj.data.Stream<A>,java.util.stream.Stream<A>> Stream_JavaStream()
        +
        • +
      + + + +
        +
      • +

        JavaStream_Stream

        +
        public static <A> fj.data.Stream<A> JavaStream_Stream(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_List

        +
        public static <A> fj.data.List<A> JavaStream_List(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_Array

        +
        public static <A> fj.data.Array<A> JavaStream_Array(java.util.stream.Stream<A> s)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/fj/data/package-frame.html b/javadoc/4.8.1/functionaljava-java8/fj/data/package-frame.html new file mode 100644 index 0000000..75c263e --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/fj/data/package-frame.html @@ -0,0 +1,21 @@ + + + + + +fj.data (java8 4.8.1 API) + + + + + +

fj.data

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-java8/fj/data/package-summary.html b/javadoc/4.8.1/functionaljava-java8/fj/data/package-summary.html new file mode 100644 index 0000000..680e932 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/fj/data/package-summary.html @@ -0,0 +1,144 @@ + + + + + +fj.data (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package fj.data

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Collectors 
    Java8 +
    Created by mperry on 3/06/2014.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/fj/data/package-tree.html b/javadoc/4.8.1/functionaljava-java8/fj/data/package-tree.html new file mode 100644 index 0000000..793a965 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/fj/data/package-tree.html @@ -0,0 +1,130 @@ + + + + + +fj.data Class Hierarchy (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data

+
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/help-doc.html b/javadoc/4.8.1/functionaljava-java8/help-doc.html new file mode 100644 index 0000000..e3d187d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/index-all.html b/javadoc/4.8.1/functionaljava-java8/index-all.html new file mode 100644 index 0000000..77121d9 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/index-all.html @@ -0,0 +1,257 @@ + + + + + +Index (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
B C F I J L O P S T  + + +

B

+
+
BiFunction_F2(BiFunction<A, B, C>) - Static method in class fj.data.Java8
+
 
+
BiFunction_F2() - Static method in class fj.data.Java8
+
 
+
+ + + +

C

+
+
Collectors - Class in fj.data
+
 
+
Consumer_F() - Static method in class fj.data.Java8
+
 
+
Consumer_F(Consumer<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

F

+
+
F2_BiFunction(F2<A, B, C>) - Static method in class fj.data.Java8
+
 
+
F2_BiFunction() - Static method in class fj.data.Java8
+
 
+
F_Function(F<A, B>) - Static method in class fj.data.Java8
+
 
+
F_Function() - Static method in class fj.data.Java8
+
 
+
fj.data - package fj.data
+
 
+
Function_F(Function<A, B>) - Static method in class fj.data.Java8
+
 
+
Function_F() - Static method in class fj.data.Java8
+
 
+
+ + + +

I

+
+
Iterable_JavaStream(Iterable<A>) - Static method in class fj.data.Java8
+
 
+
Iterator_JavaStream(Iterator<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

J

+
+
Java8 - Class in fj.data
+
+
Created by mperry on 3/06/2014.
+
+
JavaStream_Array(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_List(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_Stream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

L

+
+
List_JavaStream(List<A>) - Static method in class fj.data.Java8
+
 
+
+ + + +

O

+
+
Option_Optional(Option<A>) - Static method in class fj.data.Java8
+
+
Convert an Option to Optional.
+
+
Option_Optional() - Static method in class fj.data.Java8
+
 
+
Optional_Option(Optional<A>) - Static method in class fj.data.Java8
+
 
+
Optional_Option() - Static method in class fj.data.Java8
+
 
+
+ + + +

P

+
+
P1_Supplier(P1<A>) - Static method in class fj.data.Java8
+
 
+
P1_Supplier() - Static method in class fj.data.Java8
+
 
+
+ + + +

S

+
+
Stream_JavaStream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
Stream_JavaStream() - Static method in class fj.data.Java8
+
 
+
Supplier_P1(Supplier<A>) - Static method in class fj.data.Java8
+
 
+
Supplier_P1() - Static method in class fj.data.Java8
+
 
+
+ + + +

T

+
+
toArray() - Static method in class fj.data.Collectors
+
 
+
toList() - Static method in class fj.data.Collectors
+
 
+
toStream() - Static method in class fj.data.Collectors
+
 
+
TryCatch0_Supplier(Try0<A, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch0_Supplier() - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function(Try1<A, B, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function() - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction(Try2<A, B, C, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction() - Static method in class fj.data.Java8
+
 
+
+B C F I J L O P S T 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/index.html b/javadoc/4.8.1/functionaljava-java8/index.html new file mode 100644 index 0000000..547feef --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/index.html @@ -0,0 +1,72 @@ + + + + + +java8 4.8.1 API + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="fj/data/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8.1/functionaljava-java8/overview-tree.html b/javadoc/4.8.1/functionaljava-java8/overview-tree.html new file mode 100644 index 0000000..bb22fb6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/overview-tree.html @@ -0,0 +1,134 @@ + + + + + +Class Hierarchy (java8 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-java8/package-list b/javadoc/4.8.1/functionaljava-java8/package-list new file mode 100644 index 0000000..bf3020d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/package-list @@ -0,0 +1 @@ +fj.data diff --git a/javadoc/4.8.1/functionaljava-java8/script.js b/javadoc/4.8.1/functionaljava-java8/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8.1/functionaljava-java8/stylesheet.css b/javadoc/4.8.1/functionaljava-java8/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-java8/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8.1/functionaljava-quickcheck/allclasses-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/allclasses-frame.html new file mode 100644 index 0000000..23bf84d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/allclasses-frame.html @@ -0,0 +1,37 @@ + + + + + +All Classes (quickcheck 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/allclasses-noframe.html b/javadoc/4.8.1/functionaljava-quickcheck/allclasses-noframe.html new file mode 100644 index 0000000..61f514f --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/allclasses-noframe.html @@ -0,0 +1,37 @@ + + + + + +All Classes (quickcheck 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/constant-values.html b/javadoc/4.8.1/functionaljava-quickcheck/constant-values.html new file mode 100644 index 0000000..685e0d4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/constant-values.html @@ -0,0 +1,122 @@ + + + + + +Constant Field Values (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/deprecated-list.html b/javadoc/4.8.1/functionaljava-quickcheck/deprecated-list.html new file mode 100644 index 0000000..a85ea5d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/deprecated-list.html @@ -0,0 +1,156 @@ + + + + + +Deprecated List (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/PropertyAssert.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/PropertyAssert.html new file mode 100644 index 0000000..f8d996c --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/PropertyAssert.html @@ -0,0 +1,236 @@ + + + + + +PropertyAssert (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.test
+

Class PropertyAssert

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.test.PropertyAssert
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PropertyAssert
+extends java.lang.Object
    +
    Created by MarkPerry on 18/12/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static fj.UnitassertResult(Property p) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        assertResult

        +
        public static fj.Unit assertResult(Property p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-frame.html new file mode 100644 index 0000000..90fc1d9 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.data.test (quickcheck 4.8.1 API) + + + + + +

fj.data.test

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-summary.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-summary.html new file mode 100644 index 0000000..b3edaf3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-summary.html @@ -0,0 +1,142 @@ + + + + + +fj.data.test (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.test

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    PropertyAssert +
    Created by MarkPerry on 18/12/2014.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-tree.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-tree.html new file mode 100644 index 0000000..d2be955 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/data/test/package-tree.html @@ -0,0 +1,135 @@ + + + + + +fj.data.test Class Hierarchy (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arbitrary.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arbitrary.html new file mode 100644 index 0000000..42c78c1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arbitrary.html @@ -0,0 +1,2646 @@ + + + + + +Arbitrary (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Arbitrary

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arbitrary
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arbitrary
+extends java.lang.Object
    +
    Common Gen helper functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Gen<java.lang.String>arbAlphaNumString +
      An arbitrary implementation for string values with alpha-numeric characters.
      +
      static Gen<java.math.BigDecimal>arbBigDecimal +
      An arbitrary implementation for big decimals.
      +
      static Gen<java.math.BigInteger>arbBigInteger +
      An arbitrary implementation for big integers.
      +
      static Gen<java.util.BitSet>arbBitSet +
      An arbitrary implementation for bit sets.
      +
      static Gen<java.lang.Boolean>arbBoolean +
      An arbitrary implementation for boolean values.
      +
      static Gen<java.lang.Byte>arbByte +
      An arbitrary implementation for byte values.
      +
      static Gen<java.lang.Byte>arbByteBoundaries +
      An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
      +
      static Gen<java.util.Calendar>arbCalendar +
      An arbitrary implementation for calendars.
      +
      static Gen<java.lang.Character>arbCharacter +
      An arbitrary implementation for character values.
      +
      static Gen<java.lang.Character>arbCharacterBoundaries +
      An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
      +
      static Gen<java.util.Date>arbDate +
      An arbitrary implementation for dates.
      +
      static Gen<java.lang.Double>arbDouble +
      An arbitrary implementation for double values.
      +
      static Gen<java.lang.Double>arbDoubleBoundaries +
      An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
      +
      static Gen<java.lang.Float>arbFloat +
      An arbitrary implementation for float values.
      +
      static Gen<java.lang.Float>arbFloatBoundaries +
      An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
      +
      static Gen<java.util.GregorianCalendar>arbGregorianCalendar +
      An arbitrary implementation for gregorian calendars.
      +
      static Gen<java.lang.Integer>arbInteger +
      An arbitrary implementation for integer values.
      +
      static Gen<java.lang.Integer>arbIntegerBoundaries +
      An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
      +
      static Gen<java.util.Locale>arbLocale +
      An arbitrary implementation for locales.
      +
      static Gen<java.lang.Long>arbLong +
      An arbitrary implementation for long values.
      +
      static Gen<java.lang.Long>arbLongBoundaries +
      An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
      +
      static Gen<fj.data.Natural>arbNatural +
      An arbitrary implementation for naturals.
      +
      static Gen<java.util.Properties>arbProperties +
      An arbitrary implementation for properties.
      +
      static Gen<java.lang.Short>arbShort +
      An arbitrary implementation for short values.
      +
      static Gen<java.lang.Short>arbShortBoundaries +
      An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
      +
      static Gen<java.sql.Date>arbSQLDate +
      An arbitrary implementation for SQL dates.
      +
      static Gen<java.lang.String>arbString +
      An arbitrary implementation for string values.
      +
      static Gen<java.lang.StringBuffer>arbStringBuffer +
      An arbitrary implementation for string buffer values.
      +
      static Gen<java.lang.StringBuilder>arbStringBuilder +
      An arbitrary implementation for string builder values.
      +
      static Gen<java.lang.Throwable>arbThrowable +
      An arbitrary implementation for throwables.
      +
      static Gen<java.sql.Time>arbTime +
      An arbitrary implementation for SQL times.
      +
      static Gen<java.sql.Timestamp>arbTimestamp +
      An arbitrary implementation for SQL time stamps.
      +
      static Gen<java.lang.String>arbUSASCIIString +
      An arbitrary implementation for string values with characters in the US-ASCII range.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Arbitrary() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Gen<fj.data.Array<A>>arbArray(Gen<A> aa) +
      Returns an arbitrary implementation for arrays.
      +
      static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>>arbArrayBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for array blocking queues.
      +
      static <A> Gen<java.util.ArrayList<A>>arbArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for array lists.
      +
      static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>>arbConcurrentHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for concurrent hash maps.
      +
      static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>>arbConcurrentLinkedQueue(Gen<A> aa) +
      Returns an arbitrary implementation for concurrent linked queues.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>>arbCopyOnWriteArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array lists.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>>arbCopyOnWriteArraySet(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      Gen<java.util.concurrent.DelayQueue<A>>      		arbDelayQueue(Gen<A> aa) +
      Returns an arbitrary implementation for delay queues.
      +
      static <A,B> Gen<fj.data.Either<A,B>>arbEither(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for the disjoint union.
      +
      static <K extends java.lang.Enum<K>,V>
      Gen<java.util.EnumMap<K,V>>      		arbEnumMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for enum maps.
      +
      static <A extends java.lang.Enum<A>>
      Gen<java.util.EnumSet<A>>      		arbEnumSet(Gen<A> aa) +
      Returns an arbitrary implementation for enum sets.
      +
      static <A extends java.lang.Enum<A>>
      Gen<A>      		arbEnumValue(java.lang.Class<A> clazz) +
      Returns an arbitrary implementation for a Java enumeration.
      +
      static <A,B> Gen<fj.F<A,B>>arbF(Cogen<A> c, + Gen<B> a) +
      An arbitrary for functions.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2(Cogen<A> ca, + Cogen<B> cb, + Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2Invariant(Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3Invariant(Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4Invariant(Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5Invariant(Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6Invariant(Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7Invariant(Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Cogen<H> ch, + Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8Invariant(Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B> Gen<fj.F<A,B>>arbFInvariant(Gen<B> a) +
      An arbitrary for functions.
      +
      static <A> Gen<Gen<A>>arbGen(Gen<A> aa) +
      Returns an arbitrary implementation for generators.
      +
      static <K,V> Gen<java.util.HashMap<K,V>>arbHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash maps.
      +
      static <A> Gen<java.util.HashSet<A>>arbHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <K,V> Gen<java.util.Hashtable<K,V>>arbHashtable(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash tables.
      +
      static <K,V> Gen<java.util.IdentityHashMap<K,V>>arbIdentityHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for identity hash maps.
      +
      static <K,V> Gen<java.util.TreeMap<K,V>>arbJavaTreeMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for java.util tree maps.
      +
      static <A> Gen<fj.LcgRng>arbLcgRng() +
      An arbitrary for the LcgRng.
      +
      static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>>arbLinkedBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for linked blocking queues.
      +
      static <K,V> Gen<java.util.LinkedHashMap<K,V>>arbLinkedHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for linked hash maps.
      +
      static <A> Gen<java.util.LinkedHashSet<A>>arbLinkedHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <A> Gen<java.util.LinkedList<A>>arbLinkedList(Gen<A> aa) +
      Returns an arbitrary implementation for linked lists.
      +
      static <A> Gen<fj.data.List<A>>arbList(Gen<A> aa) +
      Returns an arbitrary implementation for lists.
      +
      static <A> Gen<fj.data.List<java.lang.Boolean>>arbListBoolean() +
      Returns an arbitrary list of booleans.
      +
      static <A> Gen<fj.data.List<java.lang.Double>>arbListDouble() +
      Returns an arbitrary list of doubles.
      +
      static <A> Gen<fj.data.List<java.lang.Integer>>arbListInteger() +
      Returns an arbitrary list of integers.
      +
      static <A> Gen<fj.data.List<java.lang.String>>arbListString() +
      Returns an arbitrary list of strings.
      +
      static <A> Gen<fj.data.NonEmptyList<A>>arbNonEmptyList(Gen<A> aa) 
      static <A> Gen<fj.data.Option<A>>arbOption(Gen<A> aa) +
      Returns an arbitrary implementation for optional values.
      +
      static <A> Gen<fj.P1<A>>arbP1(Gen<A> aa) +
      Returns an arbitrary implementation for product-1 values.
      +
      static <A,B> Gen<fj.P2<A,B>>arbP2(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for product-2 values.
      +
      static <A,B,C> Gen<fj.P3<A,B,C>>arbP3(Gen<A> aa, + Gen<B> ab, + Gen<C> ac) +
      Returns an arbitrary implementation for product-3 values.
      +
      static <A,B,C,D> Gen<fj.P4<A,B,C,D>>arbP4(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad) +
      Returns an arbitrary implementation for product-4 values.
      +
      static <A,B,C,D,E>
      Gen<fj.P5<A,B,C,D,E>>      		arbP5(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae) +
      Returns an arbitrary implementation for product-5 values.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.P6<A,B,C,D,E,F$>>      		arbP6(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af) +
      Returns an arbitrary implementation for product-6 values.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.P7<A,B,C,D,E,F$,G>>      		arbP7(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag) +
      Returns an arbitrary implementation for product-7 values.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.P8<A,B,C,D,E,F$,G,H>>      		arbP8(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah) +
      Returns an arbitrary implementation for product-8 values.
      +
      static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>>arbPriorityBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static <A> Gen<java.util.PriorityQueue<A>>arbPriorityQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority queues.
      +
      static <A,B> Gen<fj.data.Reader<A,B>>arbReader(Cogen<A> aa, + Gen<B> ab) 
      static <A> Gen<fj.data.Seq<A>>arbSeq(Gen<A> aa) +
      Returns an arbitrary implementation for sequences.
      +
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa) 
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa, + int max) 
      static <A> Gen<java.util.Stack<A>>arbStack(Gen<A> aa) +
      Returns an arbitrary implementation for stacks.
      +
      static <S,A> Gen<fj.data.State<S,A>>arbState(Gen<S> as, + Cogen<S> cs, + Gen<A> aa) +
      An arbitrary for state.
      +
      static <A> Gen<fj.data.Stream<A>>arbStream(Gen<A> aa) +
      Returns an arbitrary implementation for streams.
      +
      static <A> Gen<java.util.concurrent.SynchronousQueue<A>>arbSynchronousQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static Gen<java.lang.Throwable>arbThrowable(Gen<java.lang.String> as) +
      Returns an arbitrary implementation for throwables.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for tree maps.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + Gen<java.lang.Integer> ai) +
      Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + int maxSize) +
      Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<fj.data.List<fj.P2<K,V>>> al) +
      Returns an arbitrary implementation for tree maps.
      +
      static <A> Gen<java.util.TreeSet<A>>arbTreeSet(Gen<A> aa) +
      Returns an arbitrary implementation for tree sets.
      +
      static <A,B> Gen<fj.data.Validation<A,B>>arbValidation(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary Validation for the given arbitrary parameters.
      +
      static <A> Gen<java.util.Vector<A>>arbVector(Gen<A> aa) +
      Returns an arbitrary implementation for vectors.
      +
      static <K,V> Gen<java.util.WeakHashMap<K,V>>arbWeakHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for weak hash maps.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        arbBoolean

        +
        public static final Gen<java.lang.Boolean> arbBoolean
        +
        An arbitrary implementation for boolean values.
        +
        • +
      + + + +
        +
      • +

        arbInteger

        +
        public static final Gen<java.lang.Integer> arbInteger
        +
        An arbitrary implementation for integer values.
        +
        • +
      + + + +
        +
      • +

        arbIntegerBoundaries

        +
        public static final Gen<java.lang.Integer> arbIntegerBoundaries
        +
        An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbLong

        +
        public static final Gen<java.lang.Long> arbLong
        +
        An arbitrary implementation for long values.
        +
        • +
      + + + +
        +
      • +

        arbLongBoundaries

        +
        public static final Gen<java.lang.Long> arbLongBoundaries
        +
        An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbByte

        +
        public static final Gen<java.lang.Byte> arbByte
        +
        An arbitrary implementation for byte values.
        +
        • +
      + + + +
        +
      • +

        arbByteBoundaries

        +
        public static final Gen<java.lang.Byte> arbByteBoundaries
        +
        An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbShort

        +
        public static final Gen<java.lang.Short> arbShort
        +
        An arbitrary implementation for short values.
        +
        • +
      + + + +
        +
      • +

        arbShortBoundaries

        +
        public static final Gen<java.lang.Short> arbShortBoundaries
        +
        An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbCharacter

        +
        public static final Gen<java.lang.Character> arbCharacter
        +
        An arbitrary implementation for character values.
        +
        • +
      + + + +
        +
      • +

        arbCharacterBoundaries

        +
        public static final Gen<java.lang.Character> arbCharacterBoundaries
        +
        An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
        +
        • +
      + + + +
        +
      • +

        arbDouble

        +
        public static final Gen<java.lang.Double> arbDouble
        +
        An arbitrary implementation for double values.
        +
        • +
      + + + +
        +
      • +

        arbDoubleBoundaries

        +
        public static final Gen<java.lang.Double> arbDoubleBoundaries
        +
        An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbFloat

        +
        public static final Gen<java.lang.Float> arbFloat
        +
        An arbitrary implementation for float values.
        +
        • +
      + + + +
        +
      • +

        arbFloatBoundaries

        +
        public static final Gen<java.lang.Float> arbFloatBoundaries
        +
        An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbString

        +
        public static final Gen<java.lang.String> arbString
        +
        An arbitrary implementation for string values.
        +
        • +
      + + + +
        +
      • +

        arbUSASCIIString

        +
        public static final Gen<java.lang.String> arbUSASCIIString
        +
        An arbitrary implementation for string values with characters in the US-ASCII range.
        +
        • +
      + + + +
        +
      • +

        arbAlphaNumString

        +
        public static final Gen<java.lang.String> arbAlphaNumString
        +
        An arbitrary implementation for string values with alpha-numeric characters.
        +
        • +
      + + + +
        +
      • +

        arbStringBuffer

        +
        public static final Gen<java.lang.StringBuffer> arbStringBuffer
        +
        An arbitrary implementation for string buffer values.
        +
        • +
      + + + +
        +
      • +

        arbStringBuilder

        +
        public static final Gen<java.lang.StringBuilder> arbStringBuilder
        +
        An arbitrary implementation for string builder values.
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static final Gen<java.lang.Throwable> arbThrowable
        +
        An arbitrary implementation for throwables.
        +
        • +
      + + + +
        +
      • +

        arbBitSet

        +
        public static final Gen<java.util.BitSet> arbBitSet
        +
        An arbitrary implementation for bit sets.
        +
        • +
      + + + +
        +
      • +

        arbCalendar

        +
        public static final Gen<java.util.Calendar> arbCalendar
        +
        An arbitrary implementation for calendars.
        +
        • +
      + + + +
        +
      • +

        arbDate

        +
        public static final Gen<java.util.Date> arbDate
        +
        An arbitrary implementation for dates.
        +
        • +
      + + + +
        +
      • +

        arbGregorianCalendar

        +
        public static final Gen<java.util.GregorianCalendar> arbGregorianCalendar
        +
        An arbitrary implementation for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        arbProperties

        +
        public static final Gen<java.util.Properties> arbProperties
        +
        An arbitrary implementation for properties.
        +
        • +
      + + + +
        +
      • +

        arbSQLDate

        +
        public static final Gen<java.sql.Date> arbSQLDate
        +
        An arbitrary implementation for SQL dates.
        +
        • +
      + + + +
        +
      • +

        arbTime

        +
        public static final Gen<java.sql.Time> arbTime
        +
        An arbitrary implementation for SQL times.
        +
        • +
      + + + +
        +
      • +

        arbTimestamp

        +
        public static final Gen<java.sql.Timestamp> arbTimestamp
        +
        An arbitrary implementation for SQL time stamps.
        +
        • +
      + + + +
        +
      • +

        arbBigInteger

        +
        public static final Gen<java.math.BigInteger> arbBigInteger
        +
        An arbitrary implementation for big integers.
        +
        • +
      + + + +
        +
      • +

        arbBigDecimal

        +
        public static final Gen<java.math.BigDecimal> arbBigDecimal
        +
        An arbitrary implementation for big decimals.
        +
        • +
      + + + +
        +
      • +

        arbNatural

        +
        public static final Gen<fj.data.Natural> arbNatural
        +
        An arbitrary implementation for naturals.
        +
        • +
      + + + +
        +
      • +

        arbLocale

        +
        public static final Gen<java.util.Locale> arbLocale
        +
        An arbitrary implementation for locales.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Arbitrary

        +
        public Arbitrary()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        arbF

        +
        public static <A,B> Gen<fj.F<A,B>> arbF(Cogen<A> c,
+                                        Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        c - The cogen for the function domain.
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbReader

        +
        public static <A,B> Gen<fj.data.Reader<A,B>> arbReader(Cogen<A> aa,
+                                                       Gen<B> ab)
        +
        • +
      + + + +
        +
      • +

        arbState

        +
        public static <S,A> Gen<fj.data.State<S,A>> arbState(Gen<S> as,
+                                                     Cogen<S> cs,
+                                                     Gen<A> aa)
        +
        An arbitrary for state.
        +
        • +
      + + + +
        +
      • +

        arbLcgRng

        +
        public static <A> Gen<fj.LcgRng> arbLcgRng()
        +
        An arbitrary for the LcgRng.
        +
        • +
      + + + +
        +
      • +

        arbFInvariant

        +
        public static <A,B> Gen<fj.F<A,B>> arbFInvariant(Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2(Cogen<A> ca,
+                                              Cogen<B> cb,
+                                              Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2Invariant

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2Invariant(Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc,
+                                                  Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3Invariant

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3Invariant(Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd,
+                                                      Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4Invariant

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4Invariant(Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5(Cogen<A> ca,
+                                                            Cogen<B> cb,
+                                                            Cogen<C> cc,
+                                                            Cogen<D> cd,
+                                                            Cogen<E> ce,
+                                                            Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5Invariant

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5Invariant(Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf,
+                                                                Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6Invariant

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6Invariant(Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg,
+                                                                    Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7Invariant

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7Invariant(Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch,
+                                                                        Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        ch - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8Invariant

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8Invariant(Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbGen

        +
        public static <A> Gen<Gen<A>> arbGen(Gen<A> aa)
        +
        Returns an arbitrary implementation for generators.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the generator is defined.
        +
        Returns:
        +
        An arbitrary implementation for generators.
        +
        +
        • +
      + + + +
        +
      • +

        arbOption

        +
        public static <A> Gen<fj.data.Option<A>> arbOption(Gen<A> aa)
        +
        Returns an arbitrary implementation for optional values.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the optional value is defined.
        +
        Returns:
        +
        An arbitrary implementation for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        arbEither

        +
        public static <A,B> Gen<fj.data.Either<A,B>> arbEither(Gen<A> aa,
+                                                       Gen<B> ab)
        +
        Returns an arbitrary implementation for the disjoint union.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        ab - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        Returns:
        +
        An arbitrary implementation for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        arbList

        +
        public static <A> Gen<fj.data.List<A>> arbList(Gen<A> aa)
        +
        Returns an arbitrary implementation for lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the list is defined.
        +
        Returns:
        +
        An arbitrary implementation for lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbListInteger

        +
        public static <A> Gen<fj.data.List<java.lang.Integer>> arbListInteger()
        +
        Returns an arbitrary list of integers.
        +
        • +
      + + + +
        +
      • +

        arbListString

        +
        public static <A> Gen<fj.data.List<java.lang.String>> arbListString()
        +
        Returns an arbitrary list of strings.
        +
        • +
      + + + +
        +
      • +

        arbListBoolean

        +
        public static <A> Gen<fj.data.List<java.lang.Boolean>> arbListBoolean()
        +
        Returns an arbitrary list of booleans.
        +
        • +
      + + + +
        +
      • +

        arbListDouble

        +
        public static <A> Gen<fj.data.List<java.lang.Double>> arbListDouble()
        +
        Returns an arbitrary list of doubles.
        +
        • +
      + + + +
        +
      • +

        arbNonEmptyList

        +
        public static <A> Gen<fj.data.NonEmptyList<A>> arbNonEmptyList(Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbValidation

        +
        public static <A,B> Gen<fj.data.Validation<A,B>> arbValidation(Gen<A> aa,
+                                                               Gen<B> ab)
        +
        Returns an arbitrary Validation for the given arbitrary parameters.
        +
        • +
      + + + +
        +
      • +

        arbStream

        +
        public static <A> Gen<fj.data.Stream<A>> arbStream(Gen<A> aa)
        +
        Returns an arbitrary implementation for streams.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stream is defined.
        +
        Returns:
        +
        An arbitrary implementation for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arbArray

        +
        public static <A> Gen<fj.data.Array<A>> arbArray(Gen<A> aa)
        +
        Returns an arbitrary implementation for arrays.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array is defined.
        +
        Returns:
        +
        An arbitrary implementation for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        arbSeq

        +
        public static <A> Gen<fj.data.Seq<A>> arbSeq(Gen<A> aa)
        +
        Returns an arbitrary implementation for sequences.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the sequence is defined.
        +
        Returns:
        +
        An arbitrary implementation for sequences.
        +
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa,
+                                             int max)
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static Gen<java.lang.Throwable> arbThrowable(Gen<java.lang.String> as)
        +
        Returns an arbitrary implementation for throwables.
        +
        +
        Parameters:
        +
        as - An arbitrary used for the throwable message.
        +
        Returns:
        +
        An arbitrary implementation for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayList

        +
        public static <A> Gen<java.util.ArrayList<A>> arbArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array list is defined.
        +
        Returns:
        +
        An arbitrary implementation for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumValue

        +
        public static <A extends java.lang.Enum<A>> Gen<A> arbEnumValue(java.lang.Class<A> clazz)
        +
        Returns an arbitrary implementation for a Java enumeration.
        +
        +
        Parameters:
        +
        clazz - The type of enum to return an arbitrary of.
        +
        Returns:
        +
        An arbitrary for instances of the supplied enum type.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Gen<java.util.EnumMap<K,V>> arbEnumMap(Gen<K> ak,
+                                                                                     Gen<V> av)
        +
        Returns an arbitrary implementation for enum maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the enum map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the enum map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumSet

        +
        public static <A extends java.lang.Enum<A>> Gen<java.util.EnumSet<A>> arbEnumSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for enum sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the enum set is defined.
        +
        Returns:
        +
        An arbitrary implementation for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashMap

        +
        public static <K,V> Gen<java.util.HashMap<K,V>> arbHashMap(Gen<K> ak,
+                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashSet

        +
        public static <A> Gen<java.util.HashSet<A>> arbHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashtable

        +
        public static <K,V> Gen<java.util.Hashtable<K,V>> arbHashtable(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for hash tables.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash table's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the hash table's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        arbIdentityHashMap

        +
        public static <K,V> Gen<java.util.IdentityHashMap<K,V>> arbIdentityHashMap(Gen<K> ak,
+                                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for identity hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the identity hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the identity hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashMap

        +
        public static <K,V> Gen<java.util.LinkedHashMap<K,V>> arbLinkedHashMap(Gen<K> ak,
+                                                                       Gen<V> av)
        +
        Returns an arbitrary implementation for linked hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the linked hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the linked hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashSet

        +
        public static <A> Gen<java.util.LinkedHashSet<A>> arbLinkedHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedList

        +
        public static <A> Gen<java.util.LinkedList<A>> arbLinkedList(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked list is defined.
        +
        Returns:
        +
        An arbitrary implementation for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityQueue

        +
        public static <A> Gen<java.util.PriorityQueue<A>> arbPriorityQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbStack

        +
        public static <A> Gen<java.util.Stack<A>> arbStack(Gen<A> aa)
        +
        Returns an arbitrary implementation for stacks.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stack is defined.
        +
        Returns:
        +
        An arbitrary implementation for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        arbJavaTreeMap

        +
        public static <K,V> Gen<java.util.TreeMap<K,V>> arbJavaTreeMap(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for java.util tree maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the tree map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the tree map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<fj.data.List<fj.P2<K,V>>> al)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         Gen<java.lang.Integer> ai)
        +
        Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         int maxSize)
        +
        Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
        +
        • +
      + + + +
        +
      • +

        arbTreeSet

        +
        public static <A> Gen<java.util.TreeSet<A>> arbTreeSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for tree sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the tree set is defined.
        +
        Returns:
        +
        An arbitrary implementation for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbVector

        +
        public static <A> Gen<java.util.Vector<A>> arbVector(Gen<A> aa)
        +
        Returns an arbitrary implementation for vectors.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the vector is defined.
        +
        Returns:
        +
        An arbitrary implementation for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        arbWeakHashMap

        +
        public static <K,V> Gen<java.util.WeakHashMap<K,V>> arbWeakHashMap(Gen<K> ak,
+                                                                   Gen<V> av)
        +
        Returns an arbitrary implementation for weak hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the weak hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the weak hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>> arbArrayBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for array blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentHashMap

        +
        public static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>> arbConcurrentHashMap(Gen<K> ak,
+                                                                                          Gen<V> av)
        +
        Returns an arbitrary implementation for concurrent hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the concurrent hash map's keys + are defined.
        +
        av - An arbitrary implementation for the type over which the concurrent hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentLinkedQueue

        +
        public static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>> arbConcurrentLinkedQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for concurrent linked queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the concurrent linked queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArrayList

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>> arbCopyOnWriteArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array list is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArraySet

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>> arbCopyOnWriteArraySet(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array set is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Gen<java.util.concurrent.DelayQueue<A>> arbDelayQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for delay queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the delay queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>> arbLinkedBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>> arbPriorityBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbSynchronousQueue

        +
        public static <A> Gen<java.util.concurrent.SynchronousQueue<A>> arbSynchronousQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbP1

        +
        public static <A> Gen<fj.P1<A>> arbP1(Gen<A> aa)
        +
        Returns an arbitrary implementation for product-1 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the product-1 is defined.
        +
        Returns:
        +
        An arbitrary implementation for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP2

        +
        public static <A,B> Gen<fj.P2<A,B>> arbP2(Gen<A> aa,
+                                          Gen<B> ab)
        +
        Returns an arbitrary implementation for product-2 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP3

        +
        public static <A,B,C> Gen<fj.P3<A,B,C>> arbP3(Gen<A> aa,
+                                              Gen<B> ab,
+                                              Gen<C> ac)
        +
        Returns an arbitrary implementation for product-3 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP4

        +
        public static <A,B,C,D> Gen<fj.P4<A,B,C,D>> arbP4(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Gen<C> ac,
+                                                  Gen<D> ad)
        +
        Returns an arbitrary implementation for product-4 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP5

        +
        public static <A,B,C,D,E> Gen<fj.P5<A,B,C,D,E>> arbP5(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Gen<D> ad,
+                                                      Gen<E> ae)
        +
        Returns an arbitrary implementation for product-5 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP6

        +
        public static <A,B,C,D,E,F$> Gen<fj.P6<A,B,C,D,E,F$>> arbP6(Gen<A> aa,
+                                                            Gen<B> ab,
+                                                            Gen<C> ac,
+                                                            Gen<D> ad,
+                                                            Gen<E> ae,
+                                                            Gen<F$> af)
        +
        Returns an arbitrary implementation for product-6 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP7

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.P7<A,B,C,D,E,F$,G>> arbP7(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Gen<F$> af,
+                                                                Gen<G> ag)
        +
        Returns an arbitrary implementation for product-7 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP8

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.P8<A,B,C,D,E,F$,G,H>> arbP8(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Gen<G> ag,
+                                                                    Gen<H> ah)
        +
        Returns an arbitrary implementation for product-8 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ah - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arg.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arg.html new file mode 100644 index 0000000..a1f77f5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Arg.html @@ -0,0 +1,329 @@ + + + + + +Arg (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Arg<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arg<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arg<T>
+extends java.lang.Object
    +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<Arg<?>>argShow +
      The rendering of an argument (uses Object.toString() for the argument value).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> Arg<T>arg(T value, + int shrinks) +
      Construct a property argument with the given value and number of shrinks.
      +
      intshrinks() +
      Returns the argument's number of shrinks following falsification.
      +
      java.lang.Objectvalue() +
      Returns the argument's value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        argShow

        +
        public static final fj.Show<Arg<?>> argShow
        +
        The rendering of an argument (uses Object.toString() for the argument value).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        arg

        +
        public static <T> Arg<T> arg(T value,
+                             int shrinks)
        +
        Construct a property argument with the given value and number of shrinks.
        +
        +
        Parameters:
        +
        value - The value to construct an argument with.
        +
        shrinks - The number of shrinks to construct an argument with.
        +
        Returns:
        +
        A new argument.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public java.lang.Object value()
        +
        Returns the argument's value.
        +
        +
        Returns:
        +
        The argument's value.
        +
        +
        • +
      + + + +
        +
      • +

        shrinks

        +
        public int shrinks()
        +
        Returns the argument's number of shrinks following falsification.
        +
        +
        Returns:
        +
        The argument's number of shrinks following falsification.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Bool.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Bool.html new file mode 100644 index 0000000..be5f121 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Bool.html @@ -0,0 +1,375 @@ + + + + + +Bool (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Bool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Bool
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bool
+extends java.lang.Object
    +
    A boolean wrapper that works well with properties.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Boolbool(boolean b) +
      Construct a Bool from the given value.
      +
      Propertyimplies(Bool c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(boolean c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(fj.F0<Property> p) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(Property p) +
      Returns a property that produces a result only if this value is true.
      +
      booleanis() +
      Returns true if this value is true, false otherwise.
      +
      booleanisNot() +
      Returns false if this value is true, true otherwise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        is

        +
        public boolean is()
        +
        Returns true if this value is true, false otherwise.
        +
        +
        Returns:
        +
        true if this value is true, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNot

        +
        public boolean isNot()
        +
        Returns false if this value is true, true otherwise.
        +
        +
        Returns:
        +
        false if this value is true, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(fj.F0<Property> p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Property p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Bool c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(boolean c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        bool

        +
        public static Bool bool(boolean b)
        +
        Construct a Bool from the given value.
        +
        +
        Parameters:
        +
        b - The value to construct a Bool with.
        +
        Returns:
        +
        A Bool from the given value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/CheckResult.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/CheckResult.html new file mode 100644 index 0000000..6df9b02 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/CheckResult.html @@ -0,0 +1,713 @@ + + + + + +CheckResult (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class CheckResult

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.CheckResult
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class CheckResult
+extends java.lang.Object
    +
    An enumeration of the possible results after checking a property. A CheckResult may + be in one of six states: +
      +
    1. Passed
      2. +
    2. Proven
      3. +
    3. Falsified
      4. +
    4. Exhausted
      5. +
    5. Exception executing the property
      6. +
    6. Exception generating values to check the property
      7. +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<CheckResult>summary +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
      +
      intdiscarded() +
      Returns the number of discarded checks of the property in this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
      +
      static CheckResultexhausted(int succeeded, + int discarded) +
      Returns a result that the property been exhausted in checking.
      +
      static CheckResultfalsified(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been falsified.
      +
      static CheckResultgenException(java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that generating values to check the property threw an exception.
      +
      booleanisExhausted() +
      Returns true if this result is exhausted, false otherwise.
      +
      booleanisFalsified() +
      Returns true if this result is falsified, false otherwise.
      +
      booleanisGenException() +
      Returns true if this result is an exception during generating of values for + property checking, false otherwise.
      +
      booleanisPassed() +
      Returns true if this result is passed, false otherwise.
      +
      booleanisPropException() +
      Returns true if this result is an exception during property execution, + false otherwise.
      +
      booleanisProven() +
      Returns true if this result is proven, false otherwise.
      +
      static CheckResultpassed(int succeeded, + int discarded) +
      Returns a result that the property has passed.
      +
      static CheckResultpropException(fj.data.List<Arg<?>> args, + java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that checking the property threw an exception.
      +
      static CheckResultproven(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been proven.
      +
      intsucceeded() +
      Returns the number of succeeded checks of the property in this result.
      +
      static fj.Show<CheckResult>summary(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        summary

        +
        public static final fj.Show<CheckResult> summary
        +
        A rendering of a check result that summarises in one line.
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static final fj.Show<CheckResult> summaryEx
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        passed

        +
        public static CheckResult passed(int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has passed.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has passed.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static CheckResult proven(fj.data.List<Arg<?>> args,
+                                 int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has been proven.
        +
        +
        Parameters:
        +
        args - The arguments used to prove the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been proven.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static CheckResult falsified(fj.data.List<Arg<?>> args,
+                                    int succeeded,
+                                    int discarded)
        +
        Returns a result that the property has been falsified.
        +
        +
        Parameters:
        +
        args - The arguments used to falsify the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been falsified.
        +
        +
        • +
      + + + +
        +
      • +

        exhausted

        +
        public static CheckResult exhausted(int succeeded,
+                                    int discarded)
        +
        Returns a result that the property been exhausted in checking.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been exhausted in checking.
        +
        +
        • +
      + + + +
        +
      • +

        propException

        +
        public static CheckResult propException(fj.data.List<Arg<?>> args,
+                                        java.lang.Throwable ex,
+                                        int succeeded,
+                                        int discarded)
        +
        Returns a result that checking the property threw an exception.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception was thrown.
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that checking the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        genException

        +
        public static CheckResult genException(java.lang.Throwable ex,
+                                       int succeeded,
+                                       int discarded)
        +
        Returns a result that generating values to check the property threw an exception.
        +
        +
        Parameters:
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that generating values to check the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        isPassed

        +
        public boolean isPassed()
        +
        Returns true if this result is passed, false otherwise.
        +
        +
        Returns:
        +
        true if this result is passed, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven, false otherwise.
        +
        +
        Returns:
        +
        true if this result is proven, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified, false otherwise.
        +
        +
        Returns:
        +
        true if this result is falsified, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isExhausted

        +
        public boolean isExhausted()
        +
        Returns true if this result is exhausted, false otherwise.
        +
        +
        Returns:
        +
        true if this result is exhausted, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isPropException

        +
        public boolean isPropException()
        +
        Returns true if this result is an exception during property execution, + false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during property execution, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isGenException

        +
        public boolean isGenException()
        +
        Returns true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        Returns:
        +
        The arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        Returns:
        +
        The execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        • +
      + + + +
        +
      • +

        succeeded

        +
        public int succeeded()
        +
        Returns the number of succeeded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of succeeded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        discarded

        +
        public int discarded()
        +
        Returns the number of discarded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of discarded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        summary

        +
        public static fj.Show<CheckResult> summary(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line.
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line.
        +
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static fj.Show<CheckResult> summaryEx(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line but throws an exception in + the result is a failure (falsified, property exception or generator exception).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Cogen.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Cogen.html new file mode 100644 index 0000000..e686c01 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Cogen.html @@ -0,0 +1,2006 @@ + + + + + +Cogen (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Cogen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Cogen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Cogen<A>
+extends java.lang.Object
    +
    Transforms a type and a generator to produce a new generator. This function is used to generate + gen functions.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        cogenBoolean

        +
        public static final Cogen<java.lang.Boolean> cogenBoolean
        +
        A cogen for booleans.
        +
        • +
      + + + +
        +
      • +

        cogenInteger

        +
        public static final Cogen<java.lang.Integer> cogenInteger
        +
        A cogen for integers.
        +
        • +
      + + + +
        +
      • +

        cogenByte

        +
        public static final Cogen<java.lang.Byte> cogenByte
        +
        A cogen for bytes.
        +
        • +
      + + + +
        +
      • +

        cogenShort

        +
        public static final Cogen<java.lang.Short> cogenShort
        +
        A cogen for shorts.
        +
        • +
      + + + +
        +
      • +

        cogenLong

        +
        public static final Cogen<java.lang.Long> cogenLong
        +
        A cogen for longs.
        +
        • +
      + + + +
        +
      • +

        cogenCharacter

        +
        public static final Cogen<java.lang.Character> cogenCharacter
        +
        A cogen for characters.
        +
        • +
      + + + +
        +
      • +

        cogenFloat

        +
        public static final Cogen<java.lang.Float> cogenFloat
        +
        A cogen for floats.
        +
        • +
      + + + +
        +
      • +

        cogenDouble

        +
        public static final Cogen<java.lang.Double> cogenDouble
        +
        A cogen for doubles.
        +
        • +
      + + + +
        +
      • +

        cogenString

        +
        public static final Cogen<java.lang.String> cogenString
        +
        A cogen for strings.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuffer

        +
        public static final Cogen<java.lang.StringBuffer> cogenStringBuffer
        +
        A cogen for string buffers.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuilder

        +
        public static final Cogen<java.lang.StringBuilder> cogenStringBuilder
        +
        A cogen for string builders.
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static final Cogen<java.lang.Throwable> cogenThrowable
        +
        A cogen for throwables.
        +
        • +
      + + + +
        +
      • +

        cogenBitSet

        +
        public static final Cogen<java.util.BitSet> cogenBitSet
        +
        A cogen for bit sets.
        +
        • +
      + + + +
        +
      • +

        cogenCalendar

        +
        public static final Cogen<java.util.Calendar> cogenCalendar
        +
        A cogen for calendars.
        +
        • +
      + + + +
        +
      • +

        cogenDate

        +
        public static final Cogen<java.util.Date> cogenDate
        +
        A cogen for dates.
        +
        • +
      + + + +
        +
      • +

        cogenGregorianCalendar

        +
        public static final Cogen<java.util.GregorianCalendar> cogenGregorianCalendar
        +
        A cogen for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        cogenProperties

        +
        public static final Cogen<java.util.Properties> cogenProperties
        +
        A cogen for properties.
        +
        • +
      + + + +
        +
      • +

        cogenSQLDate

        +
        public static final Cogen<java.sql.Date> cogenSQLDate
        +
        • +
      + + + +
        +
      • +

        cogenTimestamp

        +
        public static final Cogen<java.sql.Timestamp> cogenTimestamp
        +
        • +
      + + + +
        +
      • +

        cogenTime

        +
        public static final Cogen<java.sql.Time> cogenTime
        +
        • +
      + + + +
        +
      • +

        cogenBigInteger

        +
        public static final Cogen<java.math.BigInteger> cogenBigInteger
        +
        • +
      + + + +
        +
      • +

        cogenBigDecimal

        +
        public static final Cogen<java.math.BigDecimal> cogenBigDecimal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Cogen

        +
        public Cogen()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cogen

        +
        public abstract <B> Gen<B> cogen(A a,
+                                 Gen<B> g)
        +
        Transforms the given value and generator to a new generator with a high probability of being + independent.
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A new generator with a high probability of being independent.
        +
        +
        • +
      + + + + + +
        +
      • +

        cogen

        +
        public final <B> fj.F<Gen<B>,Gen<B>> cogen(A a)
        +
        A curried version of cogen(Object, Gen).
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        Returns:
        +
        A curried version of cogen(Object, Gen).
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public final <B> Cogen<B> compose(fj.F<B,A> f)
        +
        Composes the given function with this cogen to produce a new cogen.
        +
        +
        Parameters:
        +
        f - The function to compose.
        +
        Returns:
        +
        A new cogen composed with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <B> Cogen<B> contramap(fj.F<B,A> f)
        +
        Contra-maps this cogen using the given function.
        +
        +
        Parameters:
        +
        f - The function to co-map with.
        +
        Returns:
        +
        A contra-mapped cogen.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF

        +
        public static <A,B> Cogen<fj.F<A,B>> cogenF(Gen<A> a,
+                                            Cogen<B> c)
        +
        A cogen for a function.
        +
        +
        Parameters:
        +
        a - A gen for the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF2

        +
        public static <A,B,C> Cogen<fj.F2<A,B,C>> cogenF2(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Cogen<C> c)
        +
        A cogen for a function-2.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-2.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF3

        +
        public static <A,B,C,D> Cogen<fj.F3<A,B,C,D>> cogenF3(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Cogen<D> c)
        +
        A cogen for a function-3.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-3.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF4

        +
        public static <A,B,C,D,E> Cogen<fj.F4<A,B,C,D,E>> cogenF4(Gen<A> aa,
+                                                          Gen<B> ab,
+                                                          Gen<C> ac,
+                                                          Gen<D> ad,
+                                                          Cogen<E> c)
        +
        A cogen for a function-4.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-4.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF5

        +
        public static <A,B,C,D,E,F$> Cogen<fj.F5<A,B,C,D,E,F$>> cogenF5(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Cogen<F$> c)
        +
        A cogen for a function-5.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-5.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF6

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.F6<A,B,C,D,E,F$,G>> cogenF6(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Cogen<G> c)
        +
        A cogen for a function-6.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-6.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF7

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.F7<A,B,C,D,E,F$,G,H>> cogenF7(Gen<A> aa,
+                                                                        Gen<B> ab,
+                                                                        Gen<C> ac,
+                                                                        Gen<D> ad,
+                                                                        Gen<E> ae,
+                                                                        Gen<F$> af,
+                                                                        Gen<G> ag,
+                                                                        Cogen<H> c)
        +
        A cogen for a function-7.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-7.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Cogen<fj.F8<A,B,C,D,E,F$,G,H,I>> cogenF8(Gen<A> aa,
+                                                                            Gen<B> ab,
+                                                                            Gen<C> ac,
+                                                                            Gen<D> ad,
+                                                                            Gen<E> ae,
+                                                                            Gen<F$> af,
+                                                                            Gen<G> ag,
+                                                                            Gen<H> ah,
+                                                                            Cogen<I> c)
        +
        A cogen for a function-8.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        ah - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-8.
        +
        +
        • +
      + + + +
        +
      • +

        cogenOption

        +
        public static <A> Cogen<fj.data.Option<A>> cogenOption(Cogen<A> ca)
        +
        A cogen for the optional value.
        +
        +
        Parameters:
        +
        ca - A cogen for the type of the optional value.
        +
        Returns:
        +
        A cogen for the optional value.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEither

        +
        public static <A,B> Cogen<fj.data.Either<A,B>> cogenEither(Cogen<A> ca,
+                                                           Cogen<B> cb)
        +
        A cogen for the disjoint union.
        +
        +
        Parameters:
        +
        ca - A cogen for one side of the disjoint union.
        +
        cb - A cogen for one side of the disjoint union.
        +
        Returns:
        +
        A cogen for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        cogenList

        +
        public static <A> Cogen<fj.data.List<A>> cogenList(Cogen<A> ca)
        +
        A cogen for lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the list.
        +
        Returns:
        +
        A cogen for lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStream

        +
        public static <A> Cogen<fj.data.Stream<A>> cogenStream(Cogen<A> ca)
        +
        A cogen for streams.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the stream.
        +
        Returns:
        +
        A cogen for streams.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLcgRng

        +
        public static Cogen<fj.LcgRng> cogenLcgRng()
        +
        A cogen for the provided LcgRng
        +
        +
        Returns:
        +
        A cogen for the provided LcgRng.
        +
        +
        • +
      + + + +
        +
      • +

        cogenState

        +
        public static <S,A> Cogen<fj.data.State<S,A>> cogenState(Gen<S> as,
+                                                         fj.F2<S,A,java.lang.Long> f)
        +
        A cogen for state.
        +
        • +
      + + + +
        +
      • +

        cogenArray

        +
        public static <A> Cogen<fj.data.Array<A>> cogenArray(Cogen<A> ca)
        +
        A cogen for arrays.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array.
        +
        Returns:
        +
        A cogen for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static Cogen<java.lang.Throwable> cogenThrowable(Cogen<java.lang.String> cs)
        +
        A cogen for throwables.
        +
        +
        Parameters:
        +
        cs - A cogen for the throwable message.
        +
        Returns:
        +
        A cogen for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayList

        +
        public static <A> Cogen<java.util.ArrayList<A>> cogenArrayList(Cogen<A> ca)
        +
        A cogen for array lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array list.
        +
        Returns:
        +
        A cogen for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Cogen<java.util.EnumMap<K,V>> cogenEnumMap(Cogen<K> ck,
+                                                                                         Cogen<V> cv)
        +
        A cogen for enum maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumSet

        +
        public static <A extends java.lang.Enum<A>> Cogen<java.util.EnumSet<A>> cogenEnumSet(Cogen<A> c)
        +
        A cogen for enum sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the enum set.
        +
        Returns:
        +
        A cogen for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashMap

        +
        public static <K,V> Cogen<java.util.HashMap<K,V>> cogenHashMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashSet

        +
        public static <A> Cogen<java.util.HashSet<A>> cogenHashSet(Cogen<A> c)
        +
        A cogen for hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the hash set.
        +
        Returns:
        +
        A cogen for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashtable

        +
        public static <K,V> Cogen<java.util.Hashtable<K,V>> cogenHashtable(Cogen<K> ck,
+                                                                   Cogen<V> cv)
        +
        A cogen for hash tables.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenIdentityHashMap

        +
        public static <K,V> Cogen<java.util.IdentityHashMap<K,V>> cogenIdentityHashMap(Cogen<K> ck,
+                                                                               Cogen<V> cv)
        +
        A cogen for identity hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashMap

        +
        public static <K,V> Cogen<java.util.LinkedHashMap<K,V>> cogenLinkedHashMap(Cogen<K> ck,
+                                                                           Cogen<V> cv)
        +
        A cogen for linked hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashSet

        +
        public static <A> Cogen<java.util.LinkedHashSet<A>> cogenLinkedHashSet(Cogen<A> c)
        +
        A cogen for linked hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked hash set.
        +
        Returns:
        +
        A cogen for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedList

        +
        public static <A> Cogen<java.util.LinkedList<A>> cogenLinkedList(Cogen<A> c)
        +
        A cogen for linked lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked list.
        +
        Returns:
        +
        A cogen for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityQueue

        +
        public static <A> Cogen<java.util.PriorityQueue<A>> cogenPriorityQueue(Cogen<A> c)
        +
        A cogen for priority queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority queue.
        +
        Returns:
        +
        A cogen for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStack

        +
        public static <A> Cogen<java.util.Stack<A>> cogenStack(Cogen<A> c)
        +
        A cogen for stacks.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the stack.
        +
        Returns:
        +
        A cogen for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeMap

        +
        public static <K,V> Cogen<java.util.TreeMap<K,V>> cogenTreeMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for tree maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeSet

        +
        public static <A> Cogen<java.util.TreeSet<A>> cogenTreeSet(Cogen<A> c)
        +
        A cogen for tree sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the tree set.
        +
        Returns:
        +
        A cogen for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenVector

        +
        public static <A> Cogen<java.util.Vector<A>> cogenVector(Cogen<A> c)
        +
        A cogen for vectors.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the vector.
        +
        Returns:
        +
        A cogen for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        cogenWeakHashMap

        +
        public static <K,V> Cogen<java.util.WeakHashMap<K,V>> cogenWeakHashMap(Cogen<K> ck,
+                                                                       Cogen<V> cv)
        +
        A cogen for weak hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.ArrayBlockingQueue<A>> cogenArrayBlockingQueue(Cogen<A> c)
        +
        A cogen for array blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the array blocking queue.
        +
        Returns:
        +
        A cogen for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentHashMap

        +
        public static <K,V> Cogen<java.util.concurrent.ConcurrentHashMap<K,V>> cogenConcurrentHashMap(Cogen<K> ck,
+                                                                                              Cogen<V> cv)
        +
        A cogen for concurrent hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentLinkedQueue

        +
        public static <A> Cogen<java.util.concurrent.ConcurrentLinkedQueue<A>> cogenConcurrentLinkedQueue(Cogen<A> c)
        +
        A cogen for concurrent linked queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the concurrent linked queue.
        +
        Returns:
        +
        A cogen for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArrayList

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArrayList<A>> cogenCopyOnWriteArrayList(Cogen<A> c)
        +
        A cogen for copy-on-write array lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array list.
        +
        Returns:
        +
        A cogen for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArraySet

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArraySet<A>> cogenCopyOnWriteArraySet(Cogen<A> c)
        +
        A cogen for copy-on-write array sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array set.
        +
        Returns:
        +
        A cogen for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Cogen<java.util.concurrent.DelayQueue<A>> cogenDelayQueue(Cogen<A> c)
        +
        A cogen for delay queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the delay queue.
        +
        Returns:
        +
        A cogen for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.LinkedBlockingQueue<A>> cogenLinkedBlockingQueue(Cogen<A> c)
        +
        A cogen for linked blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked blocking queue.
        +
        Returns:
        +
        A cogen for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.PriorityBlockingQueue<A>> cogenPriorityBlockingQueue(Cogen<A> c)
        +
        A cogen for priority blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority blocking queue.
        +
        Returns:
        +
        A cogen for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenSynchronousQueue

        +
        public static <A> Cogen<java.util.concurrent.SynchronousQueue<A>> cogenSynchronousQueue(Cogen<A> c)
        +
        A cogen for synchronous queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the synchronous queue.
        +
        Returns:
        +
        A cogen for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP1

        +
        public static <A> Cogen<fj.P1<A>> cogenP1(Cogen<A> ca)
        +
        A cogen for product-1 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-1 is defined.
        +
        Returns:
        +
        A cogen for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP2

        +
        public static <A,B> Cogen<fj.P2<A,B>> cogenP2(Cogen<A> ca,
+                                              Cogen<B> cb)
        +
        A cogen for product-2 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-2 is defined.
        +
        cb - A cogen for one of the types over which the product-2 is defined.
        +
        Returns:
        +
        A cogen for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP3

        +
        public static <A,B,C> Cogen<fj.P3<A,B,C>> cogenP3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc)
        +
        A cogen for product-3 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-3 is defined.
        +
        cb - A cogen for one of the types over which the product-3 is defined.
        +
        cc - A cogen for one of the types over which the product-3 is defined.
        +
        Returns:
        +
        A cogen for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP4

        +
        public static <A,B,C,D> Cogen<fj.P4<A,B,C,D>> cogenP4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd)
        +
        A cogen for product-4 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-4 is defined.
        +
        cb - A cogen for one of the types over which the product-4 is defined.
        +
        cc - A cogen for one of the types over which the product-4 is defined.
        +
        cd - A cogen for one of the types over which the product-4 is defined.
        +
        Returns:
        +
        A cogen for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP5

        +
        public static <A,B,C,D,E> Cogen<fj.P5<A,B,C,D,E>> cogenP5(Cogen<A> ca,
+                                                          Cogen<B> cb,
+                                                          Cogen<C> cc,
+                                                          Cogen<D> cd,
+                                                          Cogen<E> ce)
        +
        A cogen for product-5 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-5 is defined.
        +
        cb - A cogen for one of the types over which the product-5 is defined.
        +
        cc - A cogen for one of the types over which the product-5 is defined.
        +
        cd - A cogen for one of the types over which the product-5 is defined.
        +
        ce - A cogen for one of the types over which the product-5 is defined.
        +
        Returns:
        +
        A cogen for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP6

        +
        public static <A,B,C,D,E,F$> Cogen<fj.P6<A,B,C,D,E,F$>> cogenP6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf)
        +
        A cogen for product-6 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-6 is defined.
        +
        cb - A cogen for one of the types over which the product-6 is defined.
        +
        cc - A cogen for one of the types over which the product-6 is defined.
        +
        cd - A cogen for one of the types over which the product-6 is defined.
        +
        ce - A cogen for one of the types over which the product-6 is defined.
        +
        cf - A cogen for one of the types over which the product-6 is defined.
        +
        Returns:
        +
        A cogen for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP7

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.P7<A,B,C,D,E,F$,G>> cogenP7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg)
        +
        A cogen for product-7 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-7 is defined.
        +
        cb - A cogen for one of the types over which the product-7 is defined.
        +
        cc - A cogen for one of the types over which the product-7 is defined.
        +
        cd - A cogen for one of the types over which the product-7 is defined.
        +
        ce - A cogen for one of the types over which the product-7 is defined.
        +
        cf - A cogen for one of the types over which the product-7 is defined.
        +
        cg - A cogen for one of the types over which the product-7 is defined.
        +
        Returns:
        +
        A cogen for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP8

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.P8<A,B,C,D,E,F$,G,H>> cogenP8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch)
        +
        A cogen for product-8 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-8 is defined.
        +
        cb - A cogen for one of the types over which the product-8 is defined.
        +
        cc - A cogen for one of the types over which the product-8 is defined.
        +
        cd - A cogen for one of the types over which the product-8 is defined.
        +
        ce - A cogen for one of the types over which the product-8 is defined.
        +
        cf - A cogen for one of the types over which the product-8 is defined.
        +
        cg - A cogen for one of the types over which the product-8 is defined.
        +
        ch - A cogen for one of the types over which the product-8 is defined.
        +
        Returns:
        +
        A cogen for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Gen.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Gen.html new file mode 100644 index 0000000..ef88208 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Gen.html @@ -0,0 +1,1497 @@ + + + + + +Gen (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Gen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Gen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Gen<A>
+extends java.lang.Object
    +

    A generator for values of the type of the given type parameter (A). Generation + of a value accepts a general 'size' argument (integer), a random generator and + returns an optional value of the type parameter. Several generators are provided, + allowing various forms of composition of generators.

    A user typically creates an arbitrary to return a generator using the 'combinator methods' below. For example, + suppose a class Person: +

    
+class Person {
+  final int age;
+  final String name;
+  final boolean male;
+
+  Person(final int age, final String name, final boolean male) {
+    this.age = age;
+    this.name = name;
+    this.male = male;
+  }
+}
+
    +

    In a case like this one, a user may create a generator over Person by + invoking the bind(F) methods — in this case, bind(Gen , Gen , F) the one + that takes two generator arguments}, since the class has one more than two fields (the bind + method is invoked on a generator adding the extra one to the count as they are composed). The + class fields are of types for which there exist generators (on Gen so those can be + used to compose a generator for Person:

    +
    
+static Gen&lt;Person&gt; personArbitrary() {
+  return arbInteger.bind(arbString(), arbBoolean(),
+      // compose the generators
+      {int age =&gt; {String name =&gt; {boolean male =&gt; new Person(age, name, male)}}};
+}
+
    +

    + The example above uses Java 7 closure syntax. Here is the same example using objects instead: +

    
+static Gen&lt;Person&gt; personArbitrary() {
+  return arbInteger.bind(arbString, arbBoolean,
+      // compose the generators
+      new F&lt;Integer, F&lt;String, F&lt;Boolean, Person&gt;&gt;&gt;() {
+        public F&lt;String, F&lt;Boolean, Person&gt;&gt; f(final Integer age) {
+          return new F&lt;String, F&lt;Boolean, Person&gt;&gt;() {
+            public F&lt;Boolean, Person&gt; f(final String name) {
+              return new F&lt;Boolean, Person&gt;() {
+                public Person f(final Boolean male) {
+                  return new Person(age, name, male);
+                }
+              };
+            }
+          };
+        }
+      });
+}
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      <B> Gen<B>apply(Gen<fj.F<A,B>> gf) +
      Function application within this generator to produce a new generator.
      +
      <B> Gen<B>bind(fj.F<A,Gen<B>> f) +
      Binds the given function across this generator to produce a new generator.
      +
      <B,C> Gen<C>bind(Gen<B> gb, + fj.F<A,fj.F<B,C>> f) +
      Binds the given function across this generator and the given generator to produce a new + generator.
      +
      <B,C,D> Gen<D>bind(Gen<B> gb, + Gen<C> gc, + fj.F<A,fj.F<B,fj.F<C,D>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E> Gen<E>bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$>
      Gen<F$>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G>
      Gen<G>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H>
      Gen<H>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H,I>
      Gen<I>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + Gen<H> gh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      static Gen<java.lang.Double>choose(double from, + double to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Integer>choose(int from, + int to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Long>choose(long from, + long to) 
      static <A> Gen<fj.data.List<A>>combinationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<A>elements(A... as) +
      Returns a generator that produces values from the given arguments.
      +
      static <A> Gen<A>elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as) +
      Returns a generator that produces values from the given frequency and value pairs.
      +
      static <A> Gen<A>fail() +
      Returns a generator that never returns a value.
      +
      Gen<A>filter(fj.F<A,java.lang.Boolean> f) +
      Returns a generator that produces values that meet the given predicate.
      +
      fj.Unitforeach(java.lang.Integer i, + Rand r, + fj.F<A,fj.Unit> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      voidforeachDoEffect(java.lang.Integer i, + Rand r, + fj.function.Effect1<A> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      static <A> Gen<A>frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs) +
      Returns a generator that uses values from the given frequency and generator pairs.
      +
      static <A> Gen<A>gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f) +
      Returns a generator that uses the given function.
      +
      Agen(int i, + Rand r) +
      Applies the given size and random generator to produce a value.
      +
      static <A> Gen<A>join(Gen<Gen<A>> g) +
      Joins the generator of generators through a bind(F) operation.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g, + int x) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf1(Gen<A> g) +
      Returns a generator of non empty lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOfSorted(Gen<A> g, + int x, + fj.Ord<A> ord) 
      <B> Gen<B>map(fj.F<A,B> f) +
      Maps the given function across this generator.
      +
      static <A> Gen<A>oneOf(fj.data.List<Gen<A>> gs) +
      Returns a generator that produces values from one of the given generators on subsequent + requests.
      +
      static <A> Gen<A>parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f) +
      Constructs a generator that can access its construction arguments — size and random + generator.
      +
      static <A> Gen<fj.data.List<A>>permutationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<fj.data.List<A>>pick(int n, + fj.data.List<A> as) +
      Deprecated.  +
      As of release 4.6, use combinationOf(int, fj.data.List<A>)
      +
      +
      static <A> Gen<A>pickOne(fj.data.List<A> as) +
      Returns a generator that picks one element from the given list.
      +
      static <A,B> Gen<fj.F<A,B>>promote(fj.F<A,Gen<B>> f) +
      Promotes the given function to a generator for functions.
      +
      Gen<A>resize(int s) +
      Resizes this generator with the given size.
      +
      static <A> Gen<fj.data.List<A>>selectionOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<fj.data.List<A>>sequence(fj.data.List<Gen<A>> gs) +
      Sequence the given generators through a bind(F) operation.
      +
      static <A> Gen<fj.data.List<A>>sequenceN(int n, + Gen<A> g) +
      Sequences the given generator the given number of times through a bind(F) operation.
      +
      static <A> Gen<A>sized(fj.F<java.lang.Integer,Gen<A>> f) +
      Constructs a generator that can access its size construction arguments.
      +
      static <A> Gen<fj.data.List<A>>someCombinationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someOf(fj.data.List<A> as) +
      Deprecated.  +
      As of release 4.6, use someCombinationOf(fj.data.List<A>)
      +
      +
      static <A> Gen<fj.data.List<A>>somePermutationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someSelectionOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someWordOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<A>value(A a) +
      Returns a generator that always produces the given value.
      +
      static <A> Gen<fj.data.List<A>>wordOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        gen

        +
        public A gen(int i,
+             Rand r)
        +
        Applies the given size and random generator to produce a value.
        +
        +
        Parameters:
        +
        i - The size to use to produce the value.
        +
        r - The random generator to use to produce the value..
        +
        Returns:
        +
        A generated value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Gen<B> map(fj.F<A,B> f)
        +
        Maps the given function across this generator.
        +
        +
        Parameters:
        +
        f - The function to map across this generator.
        +
        Returns:
        +
        A new generator after applying the mapping function.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Gen<A> filter(fj.F<A,java.lang.Boolean> f)
        +
        Returns a generator that produces values that meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to meet for the values produced by the generator.
        +
        Returns:
        +
        A generator that produces values that meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public fj.Unit foreach(java.lang.Integer i,
+                       Rand r,
+                       fj.F<A,fj.Unit> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(java.lang.Integer i,
+                            Rand r,
+                            fj.function.Effect1<A> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Gen<B> bind(fj.F<A,Gen<B>> f)
        +
        Binds the given function across this generator to produce a new generator.
        +
        +
        Parameters:
        +
        f - The function to bind across this generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Gen<C> bind(Gen<B> gb,
+                         fj.F<A,fj.F<B,C>> f)
        +
        Binds the given function across this generator and the given generator to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Gen<D> bind(Gen<B> gb,
+                           Gen<C> gc,
+                           fj.F<A,fj.F<B,fj.F<C,D>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E> Gen<E> bind(Gen<B> gb,
+                             Gen<C> gc,
+                             Gen<D> gd,
+                             fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$> Gen<F$> bind(Gen<B> gb,
+                                 Gen<C> gc,
+                                 Gen<D> gd,
+                                 Gen<E> ge,
+                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G> Gen<G> bind(Gen<B> gb,
+                                  Gen<C> gc,
+                                  Gen<D> gd,
+                                  Gen<E> ge,
+                                  Gen<F$> gf,
+                                  fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H> Gen<H> bind(Gen<B> gb,
+                                    Gen<C> gc,
+                                    Gen<D> gd,
+                                    Gen<E> ge,
+                                    Gen<F$> gf,
+                                    Gen<G> gg,
+                                    fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H,I> Gen<I> bind(Gen<B> gb,
+                                      Gen<C> gc,
+                                      Gen<D> gd,
+                                      Gen<E> ge,
+                                      Gen<F$> gf,
+                                      Gen<G> gg,
+                                      Gen<H> gh,
+                                      fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        gh - The eighth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Gen<B> apply(Gen<fj.F<A,B>> gf)
        +
        Function application within this generator to produce a new generator.
        +
        +
        Parameters:
        +
        gf - The generator over the function to apply to this generator.
        +
        Returns:
        +
        A new generator after function application.
        +
        +
        • +
      + + + +
        +
      • +

        resize

        +
        public Gen<A> resize(int s)
        +
        Resizes this generator with the given size.
        +
        +
        Parameters:
        +
        s - The new size of the generator.
        +
        Returns:
        +
        A new generator that uses the given size.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public static <A> Gen<A> gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f)
        +
        Returns a generator that uses the given function.
        +
        +
        Parameters:
        +
        f - The function to use for this generator.
        +
        Returns:
        +
        A new generator that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Gen<fj.data.List<A>> sequence(fj.data.List<Gen<A>> gs)
        +
        Sequence the given generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        gs - The generators to sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generators.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceN

        +
        public static <A> Gen<fj.data.List<A>> sequenceN(int n,
+                                                 Gen<A> g)
        +
        Sequences the given generator the given number of times through a bind(F) operation.
        +
        +
        Parameters:
        +
        n - The number of times to sequence the given generator.
        +
        g - The generator sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        parameterised

        +
        public static <A> Gen<A> parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f)
        +
        Constructs a generator that can access its construction arguments — size and random + generator.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its arguments.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + +
        +
      • +

        sized

        +
        public static <A> Gen<A> sized(fj.F<java.lang.Integer,Gen<A>> f)
        +
        Constructs a generator that can access its size construction arguments.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its size argument.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <A> Gen<A> value(A a)
        +
        Returns a generator that always produces the given value.
        +
        +
        Parameters:
        +
        a - The value to always produce.
        +
        Returns:
        +
        A generator that always produces the given value.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Integer> choose(int from,
+                                            int to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces values between the given range (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Long> choose(long from,
+                                         long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Double> choose(double from,
+                                           double to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces v
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public static <A> Gen<A> fail()
        +
        Returns a generator that never returns a value.
        +
        +
        Returns:
        +
        A generator that never returns a value.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Gen<A> join(Gen<Gen<A>> g)
        +
        Joins the generator of generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        g - The generator of generators to join.
        +
        Returns:
        +
        A new generator after joining the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        frequency

        +
        public static <A> Gen<A> frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs)
        +
        Returns a generator that uses values from the given frequency and generator pairs. The returned + generator will produce values from the generator in a pair with a higher frequency than a lower + frequency generator.
        +
        +
        Parameters:
        +
        gs - The pairs of frequency and generator from which to return values in the returned + generator.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and generator.
        +
        +
        • +
      + + + +
        +
      • +

        elemFrequency

        +
        public static <A> Gen<A> elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as)
        +
        Returns a generator that produces values from the given frequency and value pairs. The returned + generator will produce the value with a higher frequency than a lower one.
        +
        +
        Parameters:
        +
        as - The pairs of frequency and value from which to produce values.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and value.
        +
        +
        • +
      + + + + + +
        +
      • +

        elements

        +
        @SafeVarargs
+public static <A> Gen<A> elements(A... as)
        +
        Returns a generator that produces values from the given arguments.
        +
        +
        Parameters:
        +
        as - The values that the returned generator may produce.
        +
        Returns:
        +
        A generator that produces values from the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        oneOf

        +
        public static <A> Gen<A> oneOf(fj.data.List<Gen<A>> gs)
        +
        Returns a generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        Parameters:
        +
        gs - The list of generators to produce a value from.
        +
        Returns:
        +
        A generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g,
+                                              int x)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        x - An adjuster of size to apply to the given generator when producing values.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOfSorted

        +
        public static <A> Gen<fj.data.List<A>> listOfSorted(Gen<A> g,
+                                                    int x,
+                                                    fj.Ord<A> ord)
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOf1

        +
        public static <A> Gen<fj.data.List<A>> listOf1(Gen<A> g)
        +
        Returns a generator of non empty lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        pickOne

        +
        public static <A> Gen<A> pickOne(fj.data.List<A> as)
        +
        Returns a generator that picks one element from the given list. If the given list is empty, then the + returned generator will never produce a value.
        +
        +
        Parameters:
        +
        as - The list from which to pick an element.
        +
        Returns:
        +
        A generator that picks an element from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        pick

        +
        @Deprecated
+public static <A> Gen<fj.data.List<A>> pick(int n,
+                                                        fj.data.List<A> as)
        +
        Deprecated. As of release 4.6, use combinationOf(int, fj.data.List<A>)
        +
        Returns a generator of lists that picks the given number of elements from the given list. If + the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value. +

        + Note: pick is synonymous with combinationOf

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        combinationOf

        +
        public static <A> Gen<fj.data.List<A>> combinationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        selectionOf

        +
        public static <A> Gen<fj.data.List<A>> selectionOf(int n,
+                                                   fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        permutationOf

        +
        public static <A> Gen<fj.data.List<A>> permutationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        wordOf

        +
        public static <A> Gen<fj.data.List<A>> wordOf(int n,
+                                              fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someOf

        +
        @Deprecated
+public static <A> Gen<fj.data.List<A>> someOf(fj.data.List<A> as)
        +
        Deprecated. As of release 4.6, use someCombinationOf(fj.data.List<A>)
        +
        Returns a generator of lists that produces some of the values of the given list. +

        + Note: someOf is synonymous with someCombinationOf

        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someCombinationOf

        +
        public static <A> Gen<fj.data.List<A>> someCombinationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someSelectionOf

        +
        public static <A> Gen<fj.data.List<A>> someSelectionOf(int maxLength,
+                                                       fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somePermutationOf

        +
        public static <A> Gen<fj.data.List<A>> somePermutationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someWordOf

        +
        public static <A> Gen<fj.data.List<A>> someWordOf(int maxLength,
+                                                  fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        promote

        +
        public static <A,B> Gen<fj.F<A,B>> promote(fj.F<A,Gen<B>> f)
        +
        Promotes the given function to a generator for functions.
        +
        +
        Parameters:
        +
        f - The function to promote to a generator of functions.
        +
        Returns:
        +
        A generator for functions.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Property.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Property.html new file mode 100644 index 0000000..1663874 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Property.html @@ -0,0 +1,2514 @@ + + + + + +Property (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Property

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Property
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Property
+extends java.lang.Object
    +
    Represents an algebraic property about a program that may be checked for its truth value. For example, it is true that "for all integers (call it x) and + for all integers (call it y), then x + y is equivalent to y + x". This statement is a (algebraic) + property, proposition or theorem that, when checked, will at least (depending on arguments) fail + to be falsified — since there does not exist a counter-example to this statement.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Propertyand(Property p) +
      Performs a conjunction of this property with the given property.
      +
      CheckResultcheck() +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(int minSize, + int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
      +
      CheckResultcheck(int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using a standard random generator and the given + arguments to produce a result.
      +
      CheckResultcheck(Rand r) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(Rand r, + int minSize, + int maxSize) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
      +
      CheckResultcheck(Rand r, + int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using the given arguments and produces a result.
      +
      static Propertyexception(fj.F0<Property> p) +
      Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
      +
      static <A> Propertyforall(Gen<A> g, + Shrink<A> shrink, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static PropertyfromGen(Gen<Result> g) +
      Constructs a property from a generator of results.
      +
      Gen<Result>gen() +
      Returns a generator of results from this property.
      +
      static Propertyimplies(boolean b, + fj.F0<Property> p) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + boolean b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + fj.F0<java.lang.Boolean> b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      CheckResultmaxDiscarded(int maxDiscarded) +
      Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxDiscarded(Rand r, + int maxDiscarded) +
      Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxSize(int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultmaxSize(Rand r, + int maxSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultminSize(int minSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSize(Rand r, + int minSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSuccessful(int minSuccessful) +
      Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultminSuccessful(Rand r, + int minSuccessful) +
      Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      Propertyor(Property p) +
      Performs a disjunction of this property with the given property.
      +
      static Propertyprop(boolean b) +
      Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
      +
      static Propertyprop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f) +
      Returns a property from the given function.
      +
      Resultprop(int i, + Rand r) +
      Returns the result of applying the given size and random generator.
      +
      static Propertyprop(Result r) +
      Returns a property that always has the given result.
      +
      static <A> Propertyproperty(Gen<A> aa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> Propertyproperty(Gen<A> aa, + Shrink<A> sa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + Shrink<A> sa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      Propertysequence(Property p) +
      Performs a sequence of this property with the given property.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        prop

        +
        public Result prop(int i,
+                   Rand r)
        +
        Returns the result of applying the given size and random generator.
        +
        +
        Parameters:
        +
        i - The size to use to obtain a result.
        +
        r - The random generator to use to obtain a result.
        +
        Returns:
        +
        The result of applying the given size and random generator.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public Gen<Result> gen()
        +
        Returns a generator of results from this property.
        +
        +
        Returns:
        +
        A generator of results from this property.
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Property and(Property p)
        +
        Performs a conjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the conjunction with.
        +
        Returns:
        +
        A conjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Property or(Property p)
        +
        Performs a disjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the disjunction with.
        +
        Returns:
        +
        A disjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public Property sequence(Property p)
        +
        Performs a sequence of this property with the given property. The returned property holds if + and only if this property and the given property also hold. If one property does not hold, but + the other does, then the returned property will produce the same result and the property that + holds.
        +
        +
        Parameters:
        +
        p - The property to sequence this property with.
        +
        Returns:
        +
        A sequence of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given arguments and produces a result.
        +
        +
        Parameters:
        +
        r - The random generator to use for checking.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator and the given + arguments to produce a result.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check()
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(int minSuccessful)
        +
        Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(Rand r,
+                                 int minSuccessful)
        +
        Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(int maxDiscarded)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(Rand r,
+                                int maxDiscarded)
        +
        Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(int minSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(Rand r,
+                           int minSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(Rand r,
+                           int maxSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static Property implies(boolean b,
+                               fj.F0<Property> p)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given property.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, produces the given property.
        +
        p - The property to return if the condition satisfies.
        +
        Returns:
        +
        A property that produces a result only if the given condition satisfies.
        +
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      boolean b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given boolean b.
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      fj.F0<java.lang.Boolean> b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given lazy boolean b.
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f)
        +
        Returns a property from the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the returned property with.
        +
        Returns:
        +
        A property from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(Result r)
        +
        Returns a property that always has the given result.
        +
        +
        Parameters:
        +
        r - The result of the returned property.
        +
        Returns:
        +
        A property that always has the given result.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(boolean b)
        +
        Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, returns a property that is proven; otherwise, the + property is falsified.
        +
        Returns:
        +
        A property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fromGen

        +
        public static Property fromGen(Gen<Result> g)
        +
        Constructs a property from a generator of results.
        +
        +
        Parameters:
        +
        g - The generator of results to constructor a property with.
        +
        Returns:
        +
        A property from a generator of results.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public static <A> Property forall(Gen<A> g,
+                                  Shrink<A> shrink,
+                                  fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        g - The generator to produces values from to produce the property with.
        +
        shrink - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     Shrink<A> sa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    Shrink<A> sa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Property exception(fj.F0<Property> p)
        +
        Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        Parameters:
        +
        p - A property to evaluate to check for an exception.
        +
        Returns:
        +
        A property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Rand.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Rand.html new file mode 100644 index 0000000..6c1050f --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Rand.html @@ -0,0 +1,468 @@ + + + + + +Rand (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Rand

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Rand
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Rand
+extends java.lang.Object
    +
    A random number generator.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Randstandard +
      A standard random generator that uses Random.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      doublechoose(double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      doublechoose(long seed, + double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(long seed, + int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      longchoose(long from, + long to) 
      static Randrand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f, + fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g) +
      Deprecated.  +
      As of release 4.6, use rand(F, F, F).
      +
      +
      static Randrand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f, + fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g, + fj.F<java.lang.Long,Rand> onReseed) +
      Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
      +
      Randreseed(long seed) +
      Gives this random generator a new seed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        standard

        +
        public static final Rand standard
        +
        A standard random generator that uses Random.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        choose

        +
        public int choose(long seed,
+                  int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public int choose(int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public long choose(long from,
+                   long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(long seed,
+                     double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        reseed

        +
        public Rand reseed(long seed)
        +
        Gives this random generator a new seed.
        +
        +
        Parameters:
        +
        seed - The seed of the new random generator.
        +
        Returns:
        +
        A random generator with the given seed.
        +
        +
        • +
      + + + +
        +
      • +

        rand

        +
        @Deprecated
+public static Rand rand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f,
+                                    fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g)
        +
        Deprecated. As of release 4.6, use rand(F, F, F).
        +
        Constructs a random generator from the given functions that supply a range to produce a + result. +

        + Calling reseed(long) on an instance returned from this method will + result in an exception being thrown.

        +
        +
        Parameters:
        +
        f - The integer random generator.
        +
        g - The floating-point random generator.
        +
        Returns:
        +
        A random generator from the given functions that supply a range to produce a result.
        +
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public static Rand rand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f,
+                        fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g,
+                        fj.F<java.lang.Long,Rand> onReseed)
        +
        Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
        +
        +
        Parameters:
        +
        f - The integer random generator.
        +
        g - The floating-point random generator.
        +
        onReseed - Function to create a reseeded Rand.
        +
        Returns:
        +
        A random generator from the given functions that supply a range to produce a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Result.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Result.html new file mode 100644 index 0000000..83347e9 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Result.html @@ -0,0 +1,610 @@ + + + + + +Result (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Result

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Result
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Result
+extends java.lang.Object
    +
    The result of evaluating a property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      ResultaddArg(Arg<?> a) +
      Adds an argument to this result.
      +
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the potential arguments associated with this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the potential exception associated with this result.
      +
      static Resultexception(fj.data.List<Arg<?>> args, + java.lang.Throwable t) +
      Returns an exception result.
      +
      booleanfailed() +
      Returns true if this result is falsified or an exception; otherwise, + false.
      +
      static Resultfalsified(fj.data.List<Arg<?>> args) +
      Returns a falsified result.
      +
      booleanisException() +
      Returns true if this result is an exception; otherwise, false.
      +
      booleanisFalsified() +
      Returns true if this result is falsified; otherwise, false.
      +
      booleanisNoResult() +
      Returns true if this result is no result; otherwise, false.
      +
      booleanisProven() +
      Returns true if this result is proven; otherwise, false.
      +
      booleanisUnfalsified() +
      Returns true if this result is unfalsified; otherwise, false.
      +
      static ResultnoResult() +
      Returns a result representing no result.
      +
      static ResultnoResult(fj.data.Option<Result> r) +
      Returns a result from the given potential result.
      +
      booleanpassed() +
      Returns true if this result is unfalsified or proven; otherwise, + false.
      +
      static Resultproven(fj.data.List<Arg<?>> args) +
      Returns a proven result.
      +
      ResultprovenAsUnfalsified() +
      If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
      +
      fj.data.Option<Result>toOption() +
      Returns a potential result for this result.
      +
      static Resultunfalsified(fj.data.List<Arg<?>> args) +
      Returns an unfalsified result.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the potential arguments associated with this result. This will only have a value, if + and only if !noResult() holds.
        +
        +
        Returns:
        +
        The potential arguments associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the potential exception associated with this result. This will only have a value if and + only if this result is an exception result.
        +
        +
        Returns:
        +
        The potential exception associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        isUnfalsified

        +
        public boolean isUnfalsified()
        +
        Returns true if this result is unfalsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is unfalsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is falsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is proven; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isException

        +
        public boolean isException()
        +
        Returns true if this result is an exception; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is an exception; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isNoResult

        +
        public boolean isNoResult()
        +
        Returns true if this result is no result; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is no result; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        failed

        +
        public boolean failed()
        +
        Returns true if this result is falsified or an exception; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is falsified or an exception; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        passed

        +
        public boolean passed()
        +
        Returns true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        provenAsUnfalsified

        +
        public Result provenAsUnfalsified()
        +
        If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
        +
        +
        Returns:
        +
        If this result is proven, alter it to be unfalsified with the same arguments; + otherwise, return this.
        +
        +
        • +
      + + + +
        +
      • +

        addArg

        +
        public Result addArg(Arg<?> a)
        +
        Adds an argument to this result.
        +
        +
        Parameters:
        +
        a - The argument to add.
        +
        Returns:
        +
        A result with the new argument.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public fj.data.Option<Result> toOption()
        +
        Returns a potential result for this result. This will have a value if this result is + !noResult().
        +
        +
        Returns:
        +
        A potential result for this result.
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult(fj.data.Option<Result> r)
        +
        Returns a result from the given potential result.
        +
        +
        Parameters:
        +
        r - The potential result.
        +
        Returns:
        +
        The result that may be noResult().
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult()
        +
        Returns a result representing no result.
        +
        +
        Returns:
        +
        A result representing no result.
        +
        +
        • +
      + + + +
        +
      • +

        unfalsified

        +
        public static Result unfalsified(fj.data.List<Arg<?>> args)
        +
        Returns an unfalsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during the failure of falsification.
        +
        Returns:
        +
        An unfalsified result.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static Result falsified(fj.data.List<Arg<?>> args)
        +
        Returns a falsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during falsification.
        +
        Returns:
        +
        A falsified result.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static Result proven(fj.data.List<Arg<?>> args)
        +
        Returns a proven result.
        +
        +
        Parameters:
        +
        args - The arguments used during proof.
        +
        Returns:
        +
        A proven result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Result exception(fj.data.List<Arg<?>> args,
+                               java.lang.Throwable t)
        +
        Returns an exception result.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception occurred.
        +
        t - The exception that occurred.
        +
        Returns:
        +
        A exception result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Shrink.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Shrink.html new file mode 100644 index 0000000..dbf8800 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Shrink.html @@ -0,0 +1,1680 @@ + + + + + +Shrink (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Shrink<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Shrink<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Shrink<A>
+extends java.lang.Object
    +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure. This is used in falsification to produce the smallest counter-example, rather + than the first counter-example.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        shrinkLong

        +
        public static final Shrink<java.lang.Long> shrinkLong
        +
        A shrink strategy for longs using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkBoolean

        +
        public static final Shrink<java.lang.Boolean> shrinkBoolean
        +
        A shrink strategy for booleans using false as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkInteger

        +
        public static final Shrink<java.lang.Integer> shrinkInteger
        +
        A shrink strategy for integers using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkByte

        +
        public static final Shrink<java.lang.Byte> shrinkByte
        +
        A shrink strategy for bytes using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkCharacter

        +
        public static final Shrink<java.lang.Character> shrinkCharacter
        +
        A shrink strategy for characters using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkShort

        +
        public static final Shrink<java.lang.Short> shrinkShort
        +
        A shrink strategy for shorts using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkFloat

        +
        public static final Shrink<java.lang.Float> shrinkFloat
        +
        A shrink strategy for floats using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkDouble

        +
        public static final Shrink<java.lang.Double> shrinkDouble
        +
        A shrink strategy for doubles using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkString

        +
        public static final Shrink<java.lang.String> shrinkString
        +
        A shrink strategy for strings using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuffer

        +
        public static final Shrink<java.lang.StringBuffer> shrinkStringBuffer
        +
        A shrink strategy for string buffers using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuilder

        +
        public static final Shrink<java.lang.StringBuilder> shrinkStringBuilder
        +
        A shrink strategy for string builders using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static final Shrink<java.lang.Throwable> shrinkThrowable
        +
        A shrink strategy for throwables.
        +
        • +
      + + + +
        +
      • +

        shrinkBitSet

        +
        public static final Shrink<java.util.BitSet> shrinkBitSet
        +
        A shrink strategy for bit sets.
        +
        • +
      + + + +
        +
      • +

        shrinkCalendar

        +
        public static final Shrink<java.util.Calendar> shrinkCalendar
        +
        A shrink strategy for calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkDate

        +
        public static final Shrink<java.util.Date> shrinkDate
        +
        A shrink strategy for dates.
        +
        • +
      + + + +
        +
      • +

        shrinkGregorianCalendar

        +
        public static final Shrink<java.util.GregorianCalendar> shrinkGregorianCalendar
        +
        A shrink strategy for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkProperties

        +
        public static final Shrink<java.util.Properties> shrinkProperties
        +
        A shrink strategy for properties.
        +
        • +
      + + + +
        +
      • +

        shrinkSQLDate

        +
        public static final Shrink<java.sql.Date> shrinkSQLDate
        +
        A shrink strategy for SQL dates.
        +
        • +
      + + + +
        +
      • +

        shrinkTime

        +
        public static final Shrink<java.sql.Time> shrinkTime
        +
        A shrink strategy for SQL times.
        +
        • +
      + + + +
        +
      • +

        shrinkTimestamp

        +
        public static final Shrink<java.sql.Timestamp> shrinkTimestamp
        +
        A shrink strategy for SQL timestamps.
        +
        • +
      + + + +
        +
      • +

        shrinkBigInteger

        +
        public static final Shrink<java.math.BigInteger> shrinkBigInteger
        +
        A shrink strategy for big integers.
        +
        • +
      + + + +
        +
      • +

        shrinkBigDecimal

        +
        public static final Shrink<java.math.BigDecimal> shrinkBigDecimal
        +
        A shrink strategy for big decimals.
        +
        • +
      + + + +
        +
      • +

        shrinkNatural

        +
        public static final Shrink<fj.data.Natural> shrinkNatural
        +
        A shrink strategy for naturals.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        shrink

        +
        public fj.data.Stream<A> shrink(A a)
        +
        Returns a shrink of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to shrink.
        +
        Returns:
        +
        A shrink of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Shrink<B> map(fj.F<A,B> f,
+                         fj.F<B,A> g)
        +
        Creates a shrink from this shrink and the given symmetric transformations.
        +
        +
        Parameters:
        +
        f - A transformation from this shrink type to the new shrink type.
        +
        g - A transformation from the new shrink type to this shrink type.
        +
        Returns:
        +
        A shrink from this shrink and the given symmetric transformations.
        +
        +
        • +
      + + + +
        +
      • +

        shrink

        +
        public static <A> Shrink<A> shrink(fj.F<A,fj.data.Stream<A>> f)
        +
        Constructs a shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        Parameters:
        +
        f - A function that produces a tree of values given a value.
        +
        Returns:
        +
        A shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Shrink<A> empty()
        +
        Returns a shrink strategy that cannot be reduced further.
        +
        +
        Returns:
        +
        A shrink strategy that cannot be reduced further.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkOption

        +
        public static <A> Shrink<fj.data.Option<A>> shrinkOption(Shrink<A> sa)
        +
        Returns a shrink strategy for optional values. A 'no value' is already fully + shrunk, otherwise, the shrinking occurs on the value with the given shrink strategy.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the potential value.
        +
        Returns:
        +
        A shrink strategy for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEither

        +
        public static <A,B> Shrink<fj.data.Either<A,B>> shrinkEither(Shrink<A> sa,
+                                                             Shrink<B> sb)
        +
        Returns a shrink strategy for either values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for left values.
        +
        sb - The shrinking strategy for right values.
        +
        Returns:
        +
        A shrink strategy for either values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkList

        +
        public static <A> Shrink<fj.data.List<A>> shrinkList(Shrink<A> sa)
        +
        Returns a shrink strategy for lists. An empty list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the list.
        +
        Returns:
        +
        A shrink strategy for lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArray

        +
        public static <A> Shrink<fj.data.Array<A>> shrinkArray(Shrink<A> sa)
        +
        Returns a shrink strategy for arrays. An empty array is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array.
        +
        Returns:
        +
        A shrink strategy for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStream

        +
        public static <A> Shrink<fj.data.Stream<A>> shrinkStream(Shrink<A> sa)
        +
        Returns a shrink strategy for streams. An empty stream is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the stream.
        +
        Returns:
        +
        A shrink strategy for streams.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static Shrink<java.lang.Throwable> shrinkThrowable(Shrink<java.lang.String> ss)
        +
        A shrink strategy for throwables.
        +
        +
        Parameters:
        +
        ss - A shrink strategy for throwable messages.
        +
        Returns:
        +
        A shrink strategy for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayList

        +
        public static <A> Shrink<java.util.ArrayList<A>> shrinkArrayList(Shrink<A> sa)
        +
        Returns a shrink strategy for array lists. An empty array list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array list.
        +
        Returns:
        +
        A shrink strategy for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Shrink<java.util.EnumMap<K,V>> shrinkEnumMap(Shrink<K> sk,
+                                                                                           Shrink<V> sv)
        +
        A shrink strategy for enum maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumSet

        +
        public static <A extends java.lang.Enum<A>> Shrink<java.util.EnumSet<A>> shrinkEnumSet(Shrink<A> sa)
        +
        A shrink strategy for enum sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashMap

        +
        public static <K,V> Shrink<java.util.HashMap<K,V>> shrinkHashMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashSet

        +
        public static <A> Shrink<java.util.HashSet<A>> shrinkHashSet(Shrink<A> sa)
        +
        A shrink strategy for hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashtable

        +
        public static <K,V> Shrink<java.util.Hashtable<K,V>> shrinkHashtable(Shrink<K> sk,
+                                                                     Shrink<V> sv)
        +
        A shrink strategy for hash tables.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkIdentityHashMap

        +
        public static <K,V> Shrink<java.util.IdentityHashMap<K,V>> shrinkIdentityHashMap(Shrink<K> sk,
+                                                                                 Shrink<V> sv)
        +
        A shrink strategy for identity hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashMap

        +
        public static <K,V> Shrink<java.util.LinkedHashMap<K,V>> shrinkLinkedHashMap(Shrink<K> sk,
+                                                                             Shrink<V> sv)
        +
        A shrink strategy for linked hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashSet

        +
        public static <A> Shrink<java.util.LinkedHashSet<A>> shrinkLinkedHashSet(Shrink<A> sa)
        +
        A shrink strategy for linked hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedList

        +
        public static <A> Shrink<java.util.LinkedList<A>> shrinkLinkedList(Shrink<A> sa)
        +
        A shrink strategy for linked lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityQueue

        +
        public static <A> Shrink<java.util.PriorityQueue<A>> shrinkPriorityQueue(Shrink<A> sa)
        +
        A shrink strategy for priority queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStack

        +
        public static <A> Shrink<java.util.Stack<A>> shrinkStack(Shrink<A> sa)
        +
        A shrink strategy for stacks.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeMap

        +
        public static <K,V> Shrink<java.util.TreeMap<K,V>> shrinkTreeMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for tree maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeSet

        +
        public static <A> Shrink<java.util.TreeSet<A>> shrinkTreeSet(Shrink<A> sa)
        +
        A shrink strategy for tree sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkVector

        +
        public static <A> Shrink<java.util.Vector<A>> shrinkVector(Shrink<A> sa)
        +
        A shrink strategy for vectors.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkWeakHashMap

        +
        public static <K,V> Shrink<java.util.WeakHashMap<K,V>> shrinkWeakHashMap(Shrink<K> sk,
+                                                                         Shrink<V> sv)
        +
        A shrink strategy for weak hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.ArrayBlockingQueue<A>> shrinkArrayBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for array blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentHashMap

        +
        public static <K,V> Shrink<java.util.concurrent.ConcurrentHashMap<K,V>> shrinkConcurrentHashMap(Shrink<K> sk,
+                                                                                                Shrink<V> sv)
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentLinkedQueue

        +
        public static <A> Shrink<java.util.concurrent.ConcurrentLinkedQueue<A>> shrinkConcurrentLinkedQueue(Shrink<A> sa)
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArrayList

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArrayList<A>> shrinkCopyOnWriteArrayList(Shrink<A> sa)
        +
        A shrink strategy for copy on write array lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArraySet

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArraySet<A>> shrinkCopyOnWriteArraySet(Shrink<A> sa)
        +
        A shrink strategy for copy on write array sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Shrink<java.util.concurrent.DelayQueue<A>> shrinkDelayQueue(Shrink<A> sa)
        +
        A shrink strategy for delay queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.LinkedBlockingQueue<A>> shrinkLinkedBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for linked blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.PriorityBlockingQueue<A>> shrinkPriorityBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for priority blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkSynchronousQueue

        +
        public static <A> Shrink<java.util.concurrent.SynchronousQueue<A>> shrinkSynchronousQueue(Shrink<A> sa)
        +
        A shrink strategy for synchronous queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP1

        +
        public static <A> Shrink<fj.P1<A>> shrinkP1(Shrink<A> sa)
        +
        Returns a shrinking strategy for product-1 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP2

        +
        public static <A,B> Shrink<fj.P2<A,B>> shrinkP2(Shrink<A> sa,
+                                                Shrink<B> sb)
        +
        Returns a shrinking strategy for product-2 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP3

        +
        public static <A,B,C> Shrink<fj.P3<A,B,C>> shrinkP3(Shrink<A> sa,
+                                                    Shrink<B> sb,
+                                                    Shrink<C> sc)
        +
        Returns a shrinking strategy for product-3 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP4

        +
        public static <A,B,C,D> Shrink<fj.P4<A,B,C,D>> shrinkP4(Shrink<A> sa,
+                                                        Shrink<B> sb,
+                                                        Shrink<C> sc,
+                                                        Shrink<D> sd)
        +
        Returns a shrinking strategy for product-4 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP5

        +
        public static <A,B,C,D,E> Shrink<fj.P5<A,B,C,D,E>> shrinkP5(Shrink<A> sa,
+                                                            Shrink<B> sb,
+                                                            Shrink<C> sc,
+                                                            Shrink<D> sd,
+                                                            Shrink<E> se)
        +
        Returns a shrinking strategy for product-5 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP6

        +
        public static <A,B,C,D,E,F$> Shrink<fj.P6<A,B,C,D,E,F$>> shrinkP6(Shrink<A> sa,
+                                                                  Shrink<B> sb,
+                                                                  Shrink<C> sc,
+                                                                  Shrink<D> sd,
+                                                                  Shrink<E> se,
+                                                                  Shrink<F$> sf)
        +
        Returns a shrinking strategy for product-6 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP7

        +
        public static <A,B,C,D,E,F$,G> Shrink<fj.P7<A,B,C,D,E,F$,G>> shrinkP7(Shrink<A> sa,
+                                                                      Shrink<B> sb,
+                                                                      Shrink<C> sc,
+                                                                      Shrink<D> sd,
+                                                                      Shrink<E> se,
+                                                                      Shrink<F$> sf,
+                                                                      Shrink<G> sg)
        +
        Returns a shrinking strategy for product-7 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP8

        +
        public static <A,B,C,D,E,F$,G,H> Shrink<fj.P8<A,B,C,D,E,F$,G,H>> shrinkP8(Shrink<A> sa,
+                                                                          Shrink<B> sb,
+                                                                          Shrink<C> sc,
+                                                                          Shrink<D> sd,
+                                                                          Shrink<E> se,
+                                                                          Shrink<F$> sf,
+                                                                          Shrink<G> sg,
+                                                                          Shrink<H> sh)
        +
        Returns a shrinking strategy for product-8 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        sh - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Variant.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Variant.html new file mode 100644 index 0000000..b0220e3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/Variant.html @@ -0,0 +1,270 @@ + + + + + +Variant (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Variant

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Variant
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Variant
+extends java.lang.Object
    +
    A memoised generator variant. Stores generators that have already been computed for the given arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> fj.F<Gen<A>,Gen<A>>variant(long n) +
      A curried version of variant(long, Gen).
      +
      static <A> Gen<A>variant(long n, + Gen<A> g) +
      Produces a generator that is independent of the given generator using the given value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        variant

        +
        public static <A> Gen<A> variant(long n,
+                                 Gen<A> g)
        +
        Produces a generator that is independent of the given generator using the given value.
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A generator that is independent of the given generator using the given value.
        +
        +
        • +
      + + + +
        +
      • +

        variant

        +
        public static <A> fj.F<Gen<A>,Gen<A>> variant(long n)
        +
        A curried version of variant(long, Gen).
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        Returns:
        +
        A curried version of variant(long, Gen).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-frame.html new file mode 100644 index 0000000..52346e6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-frame.html @@ -0,0 +1,30 @@ + + + + + +fj.test (quickcheck 4.8.1 API) + + + + + +

fj.test

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-summary.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-summary.html new file mode 100644 index 0000000..fb745ad --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-summary.html @@ -0,0 +1,225 @@ + + + + + +fj.test (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test

+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Arbitrary +
    Common Gen helper functions.
    +
    Arg<T> +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    Bool +
    A boolean wrapper that works well with properties.
    +
    CheckResult +
    An enumeration of the possible results after checking a property.
    +
    Cogen<A> +
    Transforms a type and a generator to produce a new generator.
    +
    Gen<A> +
    A generator for values of the type of the given type parameter (A).
    +
    Property +
    Represents an algebraic property about a program that may be checked for its truth value.
    +
    Rand +
    A random number generator.
    +
    Result +
    The result of evaluating a property.
    +
    Shrink<A> +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
    +
    Variant +
    A memoised generator variant.
    +
    +
    • +
+ + + +

Package fj.test Description

+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation. Reductio + encourages users to express properties or theorems about their software, and + the testing and reporting of the status of those properties occurs by automating various aspects. + For example, if a property is found to be false (i.e. a test fails), then the counter-example may + be reduced while still falsifying the property so that the reported counter-example is the + simplest found (this is called Shrink). The expression of the property also + serves as very rigorous documentation for the code under test; far surpassing that provided by + traditional testing techniques. + + Many of the concepts of Reductio originated with a paper called QuickCheck: A Lightweight Tool + for Random Testing of Haskell Programs by Koen Claassen and John Hughes from Chalmers University + of Technology. Reductio also borrows ideas from ScalaCheck by Rickard Nilsson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-tree.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-tree.html new file mode 100644 index 0000000..c933541 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/package-tree.html @@ -0,0 +1,145 @@ + + + + + +fj.test Class Hierarchy (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Category.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Category.html new file mode 100644 index 0000000..2b87a8e --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Category.html @@ -0,0 +1,223 @@ + + + + + +Category (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Category

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Category
    +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      The categories of the property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        The categories of the property.
        +
        +
        Returns:
        +
        The categories of the property.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Check.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Check.html new file mode 100644 index 0000000..7ce4239 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Check.html @@ -0,0 +1,497 @@ + + + + + +Check (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Check

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Check
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Check
+extends java.lang.Object
    +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <U,T extends U>
      fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>>      		properties(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        properties

        +
        public static <U,T extends U> fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>> properties(java.lang.Class<T> c,
+                                                                                                                    java.lang.String... categories)
        +
        Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations. For example, properties or their + enclosing class that are annotated with NoCheck are not considered. The name of a + property is specified by the annotation or if this annotation is not present, the + name of the method or field that represents the property.
        +
        +
        Parameters:
        +
        c - The class to look for properties on.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        All properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/CheckParams.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/CheckParams.html new file mode 100644 index 0000000..95aa9f5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/CheckParams.html @@ -0,0 +1,309 @@ + + + + + +CheckParams (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type CheckParams

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={TYPE,FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface CheckParams
    +
    Specifies the check parameters on a Property property with typical defaults.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmaxDiscarded +
      The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e.
      +
      intmaxSize +
      The maximum size to use for checking.
      +
      intminSize +
      The minimum size to use for checking.
      +
      intminSuccessful +
      The minimum number of successful tests before a result is reached.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        minSuccessful

        +
        public abstract int minSuccessful
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        Returns:
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxDiscarded

        +
        public abstract int maxDiscarded
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        Returns:
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        +
        Default:
        +
        500
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        minSize

        +
        public abstract int minSize
        +
        The minimum size to use for checking.
        +
        +
        Returns:
        +
        The minimum size to use for checking.
        +
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxSize

        +
        public abstract int maxSize
        +
        The maximum size to use for checking.
        +
        +
        Returns:
        +
        The maximum size to use for checking.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Main.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Main.html new file mode 100644 index 0000000..1917670 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Main.html @@ -0,0 +1,245 @@ + + + + + +Main (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Main

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Main
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Main
+extends java.lang.Object
    +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories. The class name and categories are passed as command line arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String... args) +
      Check the given class and categories.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String... args)
        +
        Check the given class and categories. At least one command line argument (the class name) must be + passed or an error message results.
        +
        +
        Parameters:
        +
        args - The class name as the first argument, then zero or more categories.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Name.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Name.html new file mode 100644 index 0000000..df00d45 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/Name.html @@ -0,0 +1,221 @@ + + + + + +Name (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Name

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Name
    +
    The name of a property to be used in reporting.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      The name of a property to be used in reporting.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The name of a property to be used in reporting.
        +
        +
        Returns:
        +
        The name of a property to be used in reporting.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/NoCheck.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/NoCheck.html new file mode 100644 index 0000000..29f6987 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/NoCheck.html @@ -0,0 +1,166 @@ + + + + + +NoCheck (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type NoCheck

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface NoCheck
    +
    Denotes that a property should be excluded from any checking.
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-frame.html new file mode 100644 index 0000000..dc7327f --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-frame.html @@ -0,0 +1,28 @@ + + + + + +fj.test.reflect (quickcheck 4.8.1 API) + + + + + +

fj.test.reflect

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-summary.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-summary.html new file mode 100644 index 0000000..9a70fec --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-summary.html @@ -0,0 +1,227 @@ + + + + + +fj.test.reflect (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.reflect

+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Check +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    Main +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Annotation Types Summary 
    Annotation TypeDescription
    Category +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    CheckParams +
    Specifies the check parameters on a Property property with typical defaults.
    +
    Name +
    The name of a property to be used in reporting.
    +
    NoCheck +
    Denotes that a property should be excluded from any checking.
    +
    +
    • +
+ + + +

Package fj.test.reflect Description

+
A wrapper around the fj.test package that uses annotations for configuring properties to + check. The properties are found using reflection. All annotations + are optional and a property is eligible for checking by default. A property is any of the + following member descriptions, unless the member or enclosing class is annotated with + NoCheck. + +
    +
  • a static field of type Property.
    • +
  • a static zero argument method that returns Property.
    • +
  • a non-static field of type Property in a class with a zero-argument constructor.
    • +
  • a non-static no-argument method that returns Property in a class with a no-argument + constructor.
    • +
+ +

+ A property may be in zero or more categories by annotating the member or enclosing class with + Category. The property is in the set of categories that make up the + union of its member and enclosing class category annotation. +

+

+ When a property is checked, it uses default configuration values, which may be overridden by + annotating the member or the enclosing class with the CheckParams + annotation. The values used are first those specified on the member; or if the annotation does + not exist, then the enclosing class (default values otherwise). +

+

+ A property can have a name associated with it by annotating the member with the + Name annotation. The name is a String that is used + only for reporting in check results. If the Name annotation does not + appear on a property member, then the field or method name is used by default. +

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-tree.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-tree.html new file mode 100644 index 0000000..bfd3d1c --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/reflect/package-tree.html @@ -0,0 +1,143 @@ + + + + + +fj.test.reflect Class Hierarchy (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.reflect

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.test.reflect.Check
      • +
    • fj.test.reflect.Main
      • +
    +
    • +
+

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html new file mode 100644 index 0000000..a68a064 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html @@ -0,0 +1,329 @@ + + + + + +PropertyTestRunner (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test.runner
+

Class PropertyTestRunner

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.junit.runner.Runner
      • +
    • +
        +
      • fj.test.runner.PropertyTestRunner
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.junit.runner.Describable, org.junit.runner.manipulation.Filterable
    +
    +
    +
    +
    public class PropertyTestRunner
+extends org.junit.runner.Runner
+implements org.junit.runner.manipulation.Filterable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PropertyTestRunner(java.lang.Class<?> clas) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidfilter(org.junit.runner.manipulation.Filter filter) 
      org.junit.runner.DescriptiongetDescription() 
      voidrun(org.junit.runner.notification.RunNotifier notifier) 
      +
        +
      • + + +

        Methods inherited from class org.junit.runner.Runner

        +testCount
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PropertyTestRunner

        +
        public PropertyTestRunner(java.lang.Class<?> clas)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public final org.junit.runner.Description getDescription()
        +
        +
        Specified by:
        +
        getDescription in interface org.junit.runner.Describable
        +
        Specified by:
        +
        getDescription in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final void run(org.junit.runner.notification.RunNotifier notifier)
        +
        +
        Specified by:
        +
        run in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final void filter(org.junit.runner.manipulation.Filter filter)
+                  throws org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        Specified by:
        +
        filter in interface org.junit.runner.manipulation.Filterable
        +
        Throws:
        +
        org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-frame.html new file mode 100644 index 0000000..96845a0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.test.runner (quickcheck 4.8.1 API) + + + + + +

fj.test.runner

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-summary.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-summary.html new file mode 100644 index 0000000..88bf18d --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-summary.html @@ -0,0 +1,140 @@ + + + + + +fj.test.runner (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.runner

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-tree.html b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-tree.html new file mode 100644 index 0000000..7c00215 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/fj/test/runner/package-tree.html @@ -0,0 +1,139 @@ + + + + + +fj.test.runner Class Hierarchy (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.runner

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.junit.runner.Runner (implements org.junit.runner.Describable) +
        +
      • fj.test.runner.PropertyTestRunner (implements org.junit.runner.manipulation.Filterable)
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/help-doc.html b/javadoc/4.8.1/functionaljava-quickcheck/help-doc.html new file mode 100644 index 0000000..61cef6a --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/index-all.html b/javadoc/4.8.1/functionaljava-quickcheck/index-all.html new file mode 100644 index 0000000..bd52cc3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/index-all.html @@ -0,0 +1,2127 @@ + + + + + +Index (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
A B C D E F G I J L M N O P R S T U V W  + + +

A

+
+
addArg(Arg<?>) - Method in class fj.test.Result
+
+
Adds an argument to this result.
+
+
and(Property) - Method in class fj.test.Property
+
+
Performs a conjunction of this property with the given property.
+
+
apply(Gen<F<A, B>>) - Method in class fj.test.Gen
+
+
Function application within this generator to produce a new generator.
+
+
arbAlphaNumString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with alpha-numeric characters.
+
+
arbArray(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for arrays.
+
+
arbArrayBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array blocking queues.
+
+
arbArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array lists.
+
+
arbBigDecimal - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big decimals.
+
+
arbBigInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big integers.
+
+
arbBitSet - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for bit sets.
+
+
arbBoolean - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for boolean values.
+
+
arbByte - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values.
+
+
arbByteBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbByte + the remainder of the time (93%).
+
+
arbCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for calendars.
+
+
arbCharacter - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values.
+
+
arbCharacterBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbCharacter + the remainder of the time (96%).
+
+
arbConcurrentHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent hash maps.
+
+
arbConcurrentLinkedQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent linked queues.
+
+
arbCopyOnWriteArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array lists.
+
+
arbCopyOnWriteArraySet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array sets.
+
+
arbDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for dates.
+
+
arbDelayQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for delay queues.
+
+
arbDouble - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values.
+
+
arbDoubleBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from Arbitrary.arbDouble the remainder of the time (91%).
+
+
arbEither(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for the disjoint union.
+
+
arbEnumMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum maps.
+
+
arbEnumSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum sets.
+
+
arbEnumValue(Class<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for a Java enumeration.
+
+
arbF(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbF2(Cogen<A>, Cogen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF2Invariant(Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF3(Cogen<A>, Cogen<B>, Cogen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF3Invariant(Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF4Invariant(Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF5Invariant(Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF6Invariant(Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF7Invariant(Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>, Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbF8Invariant(Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbFInvariant(Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbFloat - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values.
+
+
arbFloatBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + Arbitrary.arbFloat the remainder of the time (91%).
+
+
arbGen(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for generators.
+
+
arbGregorianCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for gregorian calendars.
+
+
arbHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash maps.
+
+
arbHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbHashtable(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash tables.
+
+
arbIdentityHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for identity hash maps.
+
+
arbInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values.
+
+
arbIntegerBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbInteger the remainder of the time (93%).
+
+
Arbitrary - Class in fj.test
+
+
Common Gen helper functions.
+
+
Arbitrary() - Constructor for class fj.test.Arbitrary
+
 
+
arbJavaTreeMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for java.util tree maps.
+
+
arbLcgRng() - Static method in class fj.test.Arbitrary
+
+
An arbitrary for the LcgRng.
+
+
arbLinkedBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked blocking queues.
+
+
arbLinkedHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked hash maps.
+
+
arbLinkedHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbLinkedList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked lists.
+
+
arbList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for lists.
+
+
arbListBoolean() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of booleans.
+
+
arbListDouble() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of doubles.
+
+
arbListInteger() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of integers.
+
+
arbListString() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of strings.
+
+
arbLocale - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for locales.
+
+
arbLong - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values.
+
+
arbLongBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbLong + the remainder of the time (93%).
+
+
arbNatural - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for naturals.
+
+
arbNonEmptyList(Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbOption(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for optional values.
+
+
arbP1(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-1 values.
+
+
arbP2(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-2 values.
+
+
arbP3(Gen<A>, Gen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-3 values.
+
+
arbP4(Gen<A>, Gen<B>, Gen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-4 values.
+
+
arbP5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-5 values.
+
+
arbP6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-6 values.
+
+
arbP7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-7 values.
+
+
arbP8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-8 values.
+
+
arbPriorityBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbPriorityQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority queues.
+
+
arbProperties - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for properties.
+
+
arbReader(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
 
+
arbSeq(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for sequences.
+
+
arbSet(Ord<A>, Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbSet(Ord<A>, Gen<A>, int) - Static method in class fj.test.Arbitrary
+
 
+
arbShort - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values.
+
+
arbShortBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbShort + the remainder of the time (93%).
+
+
arbSQLDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL dates.
+
+
arbStack(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for stacks.
+
+
arbState(Gen<S>, Cogen<S>, Gen<A>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for state.
+
+
arbStream(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for streams.
+
+
arbString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values.
+
+
arbStringBuffer - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string buffer values.
+
+
arbStringBuilder - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string builder values.
+
+
arbSynchronousQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbThrowable - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for throwables.
+
+
arbThrowable(Gen<String>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for throwables.
+
+
arbTime - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL times.
+
+
arbTimestamp - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL time stamps.
+
+
arbTreeMap(Ord<K>, Gen<List<P2<K, V>>>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, Gen<Integer>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, int) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
+
+
arbTreeSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree sets.
+
+
arbUSASCIIString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with characters in the US-ASCII range.
+
+
arbValidation(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary Validation for the given arbitrary parameters.
+
+
arbVector(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for vectors.
+
+
arbWeakHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for weak hash maps.
+
+
Arg<T> - Class in fj.test
+
+
An argument used in a property that may have undergone shrinking following falsification.
+
+
arg(T, int) - Static method in class fj.test.Arg
+
+
Construct a property argument with the given value and number of shrinks.
+
+
args() - Method in class fj.test.CheckResult
+
+
Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
+
+
args() - Method in class fj.test.Result
+
+
Returns the potential arguments associated with this result.
+
+
argShow - Static variable in class fj.test.Arg
+
+
The rendering of an argument (uses Object.toString() for the argument value).
+
+
assertResult(Property) - Static method in class fj.data.test.PropertyAssert
+
 
+
+ + + +

B

+
+
bind(F<A, Gen<B>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator to produce a new generator.
+
+
bind(Gen<B>, F<A, F<B, C>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generator to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, F<A, F<B, F<C, D>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
Bool - Class in fj.test
+
+
A boolean wrapper that works well with properties.
+
+
bool(boolean) - Static method in class fj.test.Bool
+
+
Construct a Bool from the given value.
+
+
+ + + +

C

+
+
Category - Annotation Type in fj.test.reflect
+
+
Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
+
+
check(Rand, int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given arguments and produces a result.
+
+
check(int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator and the given + arguments to produce a result.
+
+
check(Rand) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
check(Rand, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
+
+
check(int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
+
+
check() - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
Check - Class in fj.test.reflect
+
+
Functions for checking properties in a class that are found reflectively and according to various + annotations.
+
+
check(List<Class<T>>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(List<Class<T>>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
check(Class<T>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
CheckParams - Annotation Type in fj.test.reflect
+
+
Specifies the check parameters on a Property property with typical defaults.
+
+
CheckResult - Class in fj.test
+
+
An enumeration of the possible results after checking a property.
+
+
choose(int, int) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, long) - Static method in class fj.test.Gen
+
 
+
choose(double, double) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(long, long) - Method in class fj.test.Rand
+
 
+
choose(long, double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
Cogen<A> - Class in fj.test
+
+
Transforms a type and a generator to produce a new generator.
+
+
Cogen() - Constructor for class fj.test.Cogen
+
 
+
cogen(A, Gen<B>) - Method in class fj.test.Cogen
+
+
Transforms the given value and generator to a new generator with a high probability of being + independent.
+
+
cogen(A) - Method in class fj.test.Cogen
+
+
A curried version of Cogen.cogen(Object, Gen).
+
+
cogenArray(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for arrays.
+
+
cogenArrayBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array blocking queues.
+
+
cogenArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array lists.
+
+
cogenBigDecimal - Static variable in class fj.test.Cogen
+
 
+
cogenBigInteger - Static variable in class fj.test.Cogen
+
 
+
cogenBitSet - Static variable in class fj.test.Cogen
+
+
A cogen for bit sets.
+
+
cogenBoolean - Static variable in class fj.test.Cogen
+
+
A cogen for booleans.
+
+
cogenByte - Static variable in class fj.test.Cogen
+
+
A cogen for bytes.
+
+
cogenCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for calendars.
+
+
cogenCharacter - Static variable in class fj.test.Cogen
+
+
A cogen for characters.
+
+
cogenConcurrentHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent hash maps.
+
+
cogenConcurrentLinkedQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent linked queues.
+
+
cogenCopyOnWriteArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array lists.
+
+
cogenCopyOnWriteArraySet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array sets.
+
+
cogenDate - Static variable in class fj.test.Cogen
+
+
A cogen for dates.
+
+
cogenDelayQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for delay queues.
+
+
cogenDouble - Static variable in class fj.test.Cogen
+
+
A cogen for doubles.
+
+
cogenEither(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for the disjoint union.
+
+
cogenEnumMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for enum maps.
+
+
cogenEnumSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for enum sets.
+
+
cogenF(Gen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for a function.
+
+
cogenF2(Gen<A>, Gen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-2.
+
+
cogenF3(Gen<A>, Gen<B>, Gen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-3.
+
+
cogenF4(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-4.
+
+
cogenF5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-5.
+
+
cogenF6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-6.
+
+
cogenF7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-7.
+
+
cogenF8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Cogen<I>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-8.
+
+
cogenFloat - Static variable in class fj.test.Cogen
+
+
A cogen for floats.
+
+
cogenGregorianCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for gregorian calendars.
+
+
cogenHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash maps.
+
+
cogenHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for hash sets.
+
+
cogenHashtable(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash tables.
+
+
cogenIdentityHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for identity hash maps.
+
+
cogenInteger - Static variable in class fj.test.Cogen
+
+
A cogen for integers.
+
+
cogenLcgRng() - Static method in class fj.test.Cogen
+
+
A cogen for the provided LcgRng
+
+
cogenLinkedBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked blocking queues.
+
+
cogenLinkedHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash maps.
+
+
cogenLinkedHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash sets.
+
+
cogenLinkedList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked lists.
+
+
cogenList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for lists.
+
+
cogenLong - Static variable in class fj.test.Cogen
+
+
A cogen for longs.
+
+
cogenOption(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for the optional value.
+
+
cogenP1(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for product-1 values.
+
+
cogenP2(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for product-2 values.
+
+
cogenP3(Cogen<A>, Cogen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for product-3 values.
+
+
cogenP4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for product-4 values.
+
+
cogenP5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for product-5 values.
+
+
cogenP6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for product-6 values.
+
+
cogenP7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for product-7 values.
+
+
cogenP8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for product-8 values.
+
+
cogenPriorityBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority blocking queues.
+
+
cogenPriorityQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority queues.
+
+
cogenProperties - Static variable in class fj.test.Cogen
+
+
A cogen for properties.
+
+
cogenShort - Static variable in class fj.test.Cogen
+
+
A cogen for shorts.
+
+
cogenSQLDate - Static variable in class fj.test.Cogen
+
 
+
cogenStack(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for stacks.
+
+
cogenState(Gen<S>, F2<S, A, Long>) - Static method in class fj.test.Cogen
+
+
A cogen for state.
+
+
cogenStream(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for streams.
+
+
cogenString - Static variable in class fj.test.Cogen
+
+
A cogen for strings.
+
+
cogenStringBuffer - Static variable in class fj.test.Cogen
+
+
A cogen for string buffers.
+
+
cogenStringBuilder - Static variable in class fj.test.Cogen
+
+
A cogen for string builders.
+
+
cogenSynchronousQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for synchronous queues.
+
+
cogenThrowable - Static variable in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenThrowable(Cogen<String>) - Static method in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenTime - Static variable in class fj.test.Cogen
+
 
+
cogenTimestamp - Static variable in class fj.test.Cogen
+
 
+
cogenTreeMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for tree maps.
+
+
cogenTreeSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for tree sets.
+
+
cogenVector(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for vectors.
+
+
cogenWeakHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for weak hash maps.
+
+
combinationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
compose(F<B, A>) - Method in class fj.test.Cogen
+
+
Composes the given function with this cogen to produce a new cogen.
+
+
contramap(F<B, A>) - Method in class fj.test.Cogen
+
+
Contra-maps this cogen using the given function.
+
+
+ + + +

D

+
+
discarded() - Method in class fj.test.CheckResult
+
+
Returns the number of discarded checks of the property in this result.
+
+
+ + + +

E

+
+
elements(A...) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given arguments.
+
+
elemFrequency(List<P2<Integer, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given frequency and value pairs.
+
+
empty() - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy that cannot be reduced further.
+
+
exception() - Method in class fj.test.CheckResult
+
+
Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
+
+
exception(F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
+
+
exception() - Method in class fj.test.Result
+
+
Returns the potential exception associated with this result.
+
+
exception(List<Arg<?>>, Throwable) - Static method in class fj.test.Result
+
+
Returns an exception result.
+
+
exhausted(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property been exhausted in checking.
+
+
+ + + +

F

+
+
fail() - Static method in class fj.test.Gen
+
+
Returns a generator that never returns a value.
+
+
failed() - Method in class fj.test.Result
+
+
Returns true if this result is falsified or an exception; otherwise, + false.
+
+
falsified(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been falsified.
+
+
falsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a falsified result.
+
+
filter(F<A, Boolean>) - Method in class fj.test.Gen
+
+
Returns a generator that produces values that meet the given predicate.
+
+
filter(Filter) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
fj.data.test - package fj.data.test
+
 
+
fj.test - package fj.test
+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+
fj.test.reflect - package fj.test.reflect
+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+
fj.test.runner - package fj.test.runner
+
 
+
forall(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
foreach(Integer, Rand, F<A, Unit>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
foreachDoEffect(Integer, Rand, Effect1<A>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
frequency(List<P2<Integer, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses values from the given frequency and generator pairs.
+
+
fromGen(Gen<Result>) - Static method in class fj.test.Property
+
+
Constructs a property from a generator of results.
+
+
+ + + +

G

+
+
Gen<A> - Class in fj.test
+
+
A generator for values of the type of the given type parameter (A).
+
+
gen(int, Rand) - Method in class fj.test.Gen
+
+
Applies the given size and random generator to produce a value.
+
+
gen(F<Integer, F<Rand, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses the given function.
+
+
gen() - Method in class fj.test.Property
+
+
Returns a generator of results from this property.
+
+
genException(Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that generating values to check the property threw an exception.
+
+
getDescription() - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

I

+
+
implies(F0<Property>) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Property) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Bool) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean, F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, boolean) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, F0<Boolean>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
is() - Method in class fj.test.Bool
+
+
Returns true if this value is true, false otherwise.
+
+
isException() - Method in class fj.test.Result
+
+
Returns true if this result is an exception; otherwise, false.
+
+
isExhausted() - Method in class fj.test.CheckResult
+
+
Returns true if this result is exhausted, false otherwise.
+
+
isFalsified() - Method in class fj.test.CheckResult
+
+
Returns true if this result is falsified, false otherwise.
+
+
isFalsified() - Method in class fj.test.Result
+
+
Returns true if this result is falsified; otherwise, false.
+
+
isGenException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during generating of values for + property checking, false otherwise.
+
+
isNoResult() - Method in class fj.test.Result
+
+
Returns true if this result is no result; otherwise, false.
+
+
isNot() - Method in class fj.test.Bool
+
+
Returns false if this value is true, true otherwise.
+
+
isPassed() - Method in class fj.test.CheckResult
+
+
Returns true if this result is passed, false otherwise.
+
+
isPropException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during property execution, + false otherwise.
+
+
isProven() - Method in class fj.test.CheckResult
+
+
Returns true if this result is proven, false otherwise.
+
+
isProven() - Method in class fj.test.Result
+
+
Returns true if this result is proven; otherwise, false.
+
+
isUnfalsified() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified; otherwise, false.
+
+
+ + + +

J

+
+
join(Gen<Gen<A>>) - Static method in class fj.test.Gen
+
+
Joins the generator of generators through a Gen.bind(F) operation.
+
+
+ + + +

L

+
+
listOf(Gen<A>, int) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf1(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of non empty lists whose values come from the given generator.
+
+
listOfSorted(Gen<A>, int, Ord<A>) - Static method in class fj.test.Gen
+
 
+
+ + + +

M

+
+
Main - Class in fj.test.reflect
+
+
Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
+
+
main(String...) - Static method in class fj.test.reflect.Main
+
+
Check the given class and categories.
+
+
map(F<A, B>) - Method in class fj.test.Gen
+
+
Maps the given function across this generator.
+
+
map(F<A, B>, F<B, A>) - Method in class fj.test.Shrink
+
+
Creates a shrink from this shrink and the given symmetric transformations.
+
+
maxDiscarded(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxDiscarded(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
maxSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
minSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSuccessful(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
minSuccessful(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
+ + + +

N

+
+
Name - Annotation Type in fj.test.reflect
+
+
The name of a property to be used in reporting.
+
+
NoCheck - Annotation Type in fj.test.reflect
+
+
Denotes that a property should be excluded from any checking.
+
+
noResult(Option<Result>) - Static method in class fj.test.Result
+
+
Returns a result from the given potential result.
+
+
noResult() - Static method in class fj.test.Result
+
+
Returns a result representing no result.
+
+
+ + + +

O

+
+
oneOf(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from one of the given generators on subsequent + requests.
+
+
or(Property) - Method in class fj.test.Property
+
+
Performs a disjunction of this property with the given property.
+
+
+ + + +

P

+
+
parameterised(F<Integer, F<Rand, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its construction arguments — size and random + generator.
+
+
passed(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has passed.
+
+
passed() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified or proven; otherwise, + false.
+
+
permutationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
pick(int, List<A>) - Static method in class fj.test.Gen
+
+
Deprecated. +
As of release 4.6, use Gen.combinationOf(int, fj.data.List<A>)
+
+
+
pickOne(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator that picks one element from the given list.
+
+
promote(F<A, Gen<B>>) - Static method in class fj.test.Gen
+
+
Promotes the given function to a generator for functions.
+
+
prop(int, Rand) - Method in class fj.test.Property
+
+
Returns the result of applying the given size and random generator.
+
+
prop(F<Integer, F<Rand, Result>>) - Static method in class fj.test.Property
+
+
Returns a property from the given function.
+
+
prop(Result) - Static method in class fj.test.Property
+
+
Returns a property that always has the given result.
+
+
prop(boolean) - Static method in class fj.test.Property
+
+
Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
+
+
properties(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
+
+
Property - Class in fj.test
+
+
Represents an algebraic property about a program that may be checked for its truth value.
+
+
property(Gen<A>, Shrink<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyAssert - Class in fj.data.test
+
+
Created by MarkPerry on 18/12/2014.
+
+
propertyP(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyTestRunner - Class in fj.test.runner
+
 
+
PropertyTestRunner(Class<?>) - Constructor for class fj.test.runner.PropertyTestRunner
+
 
+
propException(List<Arg<?>>, Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that checking the property threw an exception.
+
+
proven(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been proven.
+
+
proven(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a proven result.
+
+
provenAsUnfalsified() - Method in class fj.test.Result
+
+
If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
+
+
+ + + +

R

+
+
Rand - Class in fj.test
+
+
A random number generator.
+
+
rand(F<Option<Long>, F<Integer, F<Integer, Integer>>>, F<Option<Long>, F<Double, F<Double, Double>>>) - Static method in class fj.test.Rand
+
+
Deprecated. +
As of release 4.6, use Rand.rand(F, F, F).
+
+
+
rand(F<Option<Long>, F<Integer, F<Integer, Integer>>>, F<Option<Long>, F<Double, F<Double, Double>>>, F<Long, Rand>) - Static method in class fj.test.Rand
+
+
Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
+
+
reseed(long) - Method in class fj.test.Rand
+
+
Gives this random generator a new seed.
+
+
resize(int) - Method in class fj.test.Gen
+
+
Resizes this generator with the given size.
+
+
Result - Class in fj.test
+
+
The result of evaluating a property.
+
+
run(RunNotifier) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

S

+
+
selectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
sequence(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Sequence the given generators through a Gen.bind(F) operation.
+
+
sequence(Property) - Method in class fj.test.Property
+
+
Performs a sequence of this property with the given property.
+
+
sequenceN(int, Gen<A>) - Static method in class fj.test.Gen
+
+
Sequences the given generator the given number of times through a Gen.bind(F) operation.
+
+
Shrink<A> - Class in fj.test
+
+
Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
+
+
shrink(A) - Method in class fj.test.Shrink
+
+
Returns a shrink of the given argument.
+
+
shrink(F<A, Stream<A>>) - Static method in class fj.test.Shrink
+
+
Constructs a shrink strategy from the given function that produces a tree of values given a + value.
+
+
shrinkArray(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for arrays.
+
+
shrinkArrayBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for array blocking queues.
+
+
shrinkArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for array lists.
+
+
shrinkBigDecimal - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big decimals.
+
+
shrinkBigInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big integers.
+
+
shrinkBitSet - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bit sets.
+
+
shrinkBoolean - Static variable in class fj.test.Shrink
+
+
A shrink strategy for booleans using false as the bottom of the shrink.
+
+
shrinkByte - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bytes using 0 as the bottom of the shrink.
+
+
shrinkCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for calendars.
+
+
shrinkCharacter - Static variable in class fj.test.Shrink
+
+
A shrink strategy for characters using 0 as the bottom of the shrink.
+
+
shrinkConcurrentHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent hash maps.
+
+
shrinkConcurrentLinkedQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent linked queues.
+
+
shrinkCopyOnWriteArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array lists.
+
+
shrinkCopyOnWriteArraySet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array sets.
+
+
shrinkDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for dates.
+
+
shrinkDelayQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for delay queues.
+
+
shrinkDouble - Static variable in class fj.test.Shrink
+
+
A shrink strategy for doubles using 0 as the bottom of the shrink.
+
+
shrinkEither(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for either values.
+
+
shrinkEnumMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum maps.
+
+
shrinkEnumSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum sets.
+
+
shrinkFloat - Static variable in class fj.test.Shrink
+
+
A shrink strategy for floats using 0 as the bottom of the shrink.
+
+
shrinkGregorianCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for gregorian calendars.
+
+
shrinkHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash maps.
+
+
shrinkHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash sets.
+
+
shrinkHashtable(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash tables.
+
+
shrinkIdentityHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for identity hash maps.
+
+
shrinkInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for integers using 0 as the bottom of the shrink.
+
+
shrinkLinkedBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked blocking queues.
+
+
shrinkLinkedHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash maps.
+
+
shrinkLinkedHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash sets.
+
+
shrinkLinkedList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked lists.
+
+
shrinkList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for lists.
+
+
shrinkLong - Static variable in class fj.test.Shrink
+
+
A shrink strategy for longs using 0 as the bottom of the shrink.
+
+
shrinkNatural - Static variable in class fj.test.Shrink
+
+
A shrink strategy for naturals.
+
+
shrinkOption(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for optional values.
+
+
shrinkP1(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-1 values.
+
+
shrinkP2(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-2 values.
+
+
shrinkP3(Shrink<A>, Shrink<B>, Shrink<C>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-3 values.
+
+
shrinkP4(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-4 values.
+
+
shrinkP5(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-5 values.
+
+
shrinkP6(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-6 values.
+
+
shrinkP7(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-7 values.
+
+
shrinkP8(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-8 values.
+
+
shrinkPriorityBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority blocking queues.
+
+
shrinkPriorityQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority queues.
+
+
shrinkProperties - Static variable in class fj.test.Shrink
+
+
A shrink strategy for properties.
+
+
shrinks() - Method in class fj.test.Arg
+
+
Returns the argument's number of shrinks following falsification.
+
+
shrinkShort - Static variable in class fj.test.Shrink
+
+
A shrink strategy for shorts using 0 as the bottom of the shrink.
+
+
shrinkSQLDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL dates.
+
+
shrinkStack(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for stacks.
+
+
shrinkStream(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for streams.
+
+
shrinkString - Static variable in class fj.test.Shrink
+
+
A shrink strategy for strings using the empty string as the bottom of the shrink.
+
+
shrinkStringBuffer - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string buffers using the empty string as the bottom of the shrink.
+
+
shrinkStringBuilder - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string builders using the empty string as the bottom of the shrink.
+
+
shrinkSynchronousQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for synchronous queues.
+
+
shrinkThrowable - Static variable in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkThrowable(Shrink<String>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkTime - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL times.
+
+
shrinkTimestamp - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL timestamps.
+
+
shrinkTreeMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree maps.
+
+
shrinkTreeSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree sets.
+
+
shrinkVector(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for vectors.
+
+
shrinkWeakHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for weak hash maps.
+
+
sized(F<Integer, Gen<A>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its size construction arguments.
+
+
someCombinationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someOf(List<A>) - Static method in class fj.test.Gen
+
+
Deprecated. +
As of release 4.6, use Gen.someCombinationOf(fj.data.List<A>)
+
+
+
somePermutationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someSelectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someWordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
standard - Static variable in class fj.test.Rand
+
+
A standard random generator that uses Random.
+
+
succeeded() - Method in class fj.test.CheckResult
+
+
Returns the number of succeeded checks of the property in this result.
+
+
summary - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summary(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summaryEx - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
summaryEx(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
+ + + +

T

+
+
toOption() - Method in class fj.test.Result
+
+
Returns a potential result for this result.
+
+
+ + + +

U

+
+
unfalsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns an unfalsified result.
+
+
+ + + +

V

+
+
value() - Method in class fj.test.Arg
+
+
Returns the argument's value.
+
+
value(A) - Static method in class fj.test.Gen
+
+
Returns a generator that always produces the given value.
+
+
Variant - Class in fj.test
+
+
A memoised generator variant.
+
+
variant(long, Gen<A>) - Static method in class fj.test.Variant
+
+
Produces a generator that is independent of the given generator using the given value.
+
+
variant(long) - Static method in class fj.test.Variant
+
+
A curried version of Variant.variant(long, Gen).
+
+
+ + + +

W

+
+
wordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
+A B C D E F G I J L M N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/index.html b/javadoc/4.8.1/functionaljava-quickcheck/index.html new file mode 100644 index 0000000..e5b69ea --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/index.html @@ -0,0 +1,75 @@ + + + + + +quickcheck 4.8.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/overview-frame.html b/javadoc/4.8.1/functionaljava-quickcheck/overview-frame.html new file mode 100644 index 0000000..5f29763 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/overview-frame.html @@ -0,0 +1,24 @@ + + + + + +Overview List (quickcheck 4.8.1 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/overview-summary.html b/javadoc/4.8.1/functionaljava-quickcheck/overview-summary.html new file mode 100644 index 0000000..51f0193 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/overview-summary.html @@ -0,0 +1,154 @@ + + + + + +Overview (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

quickcheck 4.8.1 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj.data.test 
fj.test +
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
fj.test.reflect +
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
fj.test.runner 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/overview-tree.html b/javadoc/4.8.1/functionaljava-quickcheck/overview-tree.html new file mode 100644 index 0000000..311ad4a --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/overview-tree.html @@ -0,0 +1,163 @@ + + + + + +Class Hierarchy (quickcheck 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava-quickcheck/package-list b/javadoc/4.8.1/functionaljava-quickcheck/package-list new file mode 100644 index 0000000..34273ed --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/package-list @@ -0,0 +1,4 @@ +fj.data.test +fj.test +fj.test.reflect +fj.test.runner diff --git a/javadoc/4.8.1/functionaljava-quickcheck/script.js b/javadoc/4.8.1/functionaljava-quickcheck/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8.1/functionaljava-quickcheck/stylesheet.css b/javadoc/4.8.1/functionaljava-quickcheck/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava-quickcheck/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/4.8.1/functionaljava/allclasses-frame.html b/javadoc/4.8.1/functionaljava/allclasses-frame.html new file mode 100644 index 0000000..9960238 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/allclasses-frame.html @@ -0,0 +1,230 @@ + + + + + +All Classes (core 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/allclasses-noframe.html b/javadoc/4.8.1/functionaljava/allclasses-noframe.html new file mode 100644 index 0000000..240a9d1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/allclasses-noframe.html @@ -0,0 +1,230 @@ + + + + + +All Classes (core 4.8.1 API) + + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/constant-values.html b/javadoc/4.8.1/functionaljava/constant-values.html new file mode 100644 index 0000000..7601570 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/constant-values.html @@ -0,0 +1,205 @@ + + + + + +Constant Field Values (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

fj.data.*

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/deprecated-list.html b/javadoc/4.8.1/functionaljava/deprecated-list.html new file mode 100644 index 0000000..9ed20fa --- /dev/null +++ b/javadoc/4.8.1/functionaljava/deprecated-list.html @@ -0,0 +1,327 @@ + + + + + +Deprecated List (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Bottom.html b/javadoc/4.8.1/functionaljava/fj/Bottom.html new file mode 100644 index 0000000..df25cfc --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Bottom.html @@ -0,0 +1,401 @@ + + + + + +Bottom (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Bottom

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Bottom
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bottom
+extends java.lang.Object
    +
    Represents the bottom _|_ value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> java.lang.Errordecons(A a, + Show<A> sa) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <A> java.lang.Errordecons(java.lang.Class<A> c) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eMessage() +
      A function that returns the getMessage for a throwable.
      +
      static <A> P1<A>error_(java.lang.String s) +
      Provides a thunk that throws an error using the given message when evaluated.
      +
      static java.lang.Errorerror(java.lang.String s) +
      Returns an error to represent undefinedness in a computation with early failure using the given + message.
      +
      static <A,B> F<A,B>errorF(java.lang.String s) +
      Provides a function that throws an error using the given message, ignoring its argument.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eToString() +
      A function that returns the toString for a throwable.
      +
      static java.lang.Errorundefined() +
      Returns an error to represent undefinedness in a computation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        undefined

        +
        public static java.lang.Error undefined()
        +
        Returns an error to represent undefinedness in a computation.
        +
        +
        Returns:
        +
        An error to represent undefinedness in a computation.
        +
        +
        • +
      + + + +
        +
      • +

        error

        +
        public static java.lang.Error error(java.lang.String s)
        +
        Returns an error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        An error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        • +
      + + + +
        +
      • +

        error_

        +
        public static <A> P1<A> error_(java.lang.String s)
        +
        Provides a thunk that throws an error using the given message when evaluated.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A thunk that throws an error using the given message when evaluated.
        +
        +
        • +
      + + + +
        +
      • +

        errorF

        +
        public static <A,B> F<A,B> errorF(java.lang.String s)
        +
        Provides a function that throws an error using the given message, ignoring its argument.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A function that throws an error using the given message, ignoring its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(A a,
+                                         Show<A> sa)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        a - The value being deconstructed.
        +
        sa - The rendering for the value being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(java.lang.Class<A> c)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        c - The type being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        eToString

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eToString()
        +
        A function that returns the toString for a throwable.
        +
        +
        Returns:
        +
        A function that returns the toString for a throwable.
        +
        +
        • +
      + + + +
        +
      • +

        eMessage

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eMessage()
        +
        A function that returns the getMessage for a throwable.
        +
        +
        Returns:
        +
        A function that returns the getMessage for a throwable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Class.html b/javadoc/4.8.1/functionaljava/fj/Class.html new file mode 100644 index 0000000..6200e89 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Class.html @@ -0,0 +1,373 @@ + + + + + +Class (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Class<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Class<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Class<T>
+extends java.lang.Object
    +
    A wrapper for a Class that provides additional methods.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<T>clas() +
      Returns the underlying class.
      +
      static <T> Class<T>clas(java.lang.Class<T> c) +
      Constructs a class from the given argument.
      +
      Tree<java.lang.reflect.Type>classParameters() +
      Provides this class's type parameter information as a Tree of the type expression.
      +
      List<Class<? super T>>inheritance() +
      Returns the inheritance hierarchy of this class.
      +
      List<Tree<java.lang.reflect.Type>>interfaceParameters() +
      Provides this class's interface type parameter information as a list of trees.
      +
      Tree<java.lang.reflect.Type>superclassParameters() +
      Provides this class's superclass type parameter information as a Tree of the type expression.
      +
      static Tree<java.lang.reflect.Type>typeParameterTree(java.lang.reflect.Type t) +
      Provides type parameter information as a Tree of the type expression.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        inheritance

        +
        public List<Class<? super T>> inheritance()
        +
        Returns the inheritance hierarchy of this class.
        +
        +
        Returns:
        +
        The inheritance hierarchy of this class.
        +
        +
        • +
      + + + +
        +
      • +

        classParameters

        +
        public Tree<java.lang.reflect.Type> classParameters()
        +
        Provides this class's type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The rose tree representing the type expression for this class.
        +
        +
        • +
      + + + +
        +
      • +

        superclassParameters

        +
        public Tree<java.lang.reflect.Type> superclassParameters()
        +
        Provides this class's superclass type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The Tree representing the type expression for this class's superclass.
        +
        +
        • +
      + + + +
        +
      • +

        interfaceParameters

        +
        public List<Tree<java.lang.reflect.Type>> interfaceParameters()
        +
        Provides this class's interface type parameter information as a list of trees.
        +
        +
        Returns:
        +
        A list of trees representing the type expressions for this class's interfaces.
        +
        +
        • +
      + + + +
        +
      • +

        typeParameterTree

        +
        public static Tree<java.lang.reflect.Type> typeParameterTree(java.lang.reflect.Type t)
        +
        Provides type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Parameters:
        +
        t - The type (class) for which to get the generic type information.
        +
        Returns:
        +
        Type parameter information as a rose tree of the type expression.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public java.lang.Class<T> clas()
        +
        Returns the underlying class.
        +
        +
        Returns:
        +
        The underlying class.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public static <T> Class<T> clas(java.lang.Class<T> c)
        +
        Constructs a class from the given argument.
        +
        +
        Parameters:
        +
        c - The argument to construct this class with.
        +
        Returns:
        +
        A class from the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Digit.html b/javadoc/4.8.1/functionaljava/fj/Digit.html new file mode 100644 index 0000000..f517033 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Digit.html @@ -0,0 +1,637 @@ + + + + + +Digit (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Digit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Digit>
      • +
    • +
        +
      • fj.Digit
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Digit>
    +
    +
    +
    +
    public enum Digit
+extends java.lang.Enum<Digit>
    +
    The digits zero to nine.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      _0 +
      Zero.
      +
      _1 +
      One.
      +
      _2 +
      Two.
      +
      _3 +
      Three.
      +
      _4 +
      Four.
      +
      _5 +
      Five.
      +
      _6 +
      Six.
      +
      _7 +
      Seven.
      +
      _8 +
      Eight.
      +
      _9 +
      Nine.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,Option<Digit>>fromChar +
      First-class conversion from a character to a digit.
      +
      static F<java.lang.Long,Digit>fromLong +
      First-class conversion from a long to a digit.
      +
      static F<Digit,java.lang.Character>toChar +
      First-class conversion from a digit to a character.
      +
      static F<Digit,java.lang.Long>toLong +
      First-class conversion from digit to a long.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Option<Digit>fromChar(char c) +
      Converts the given character in the given long value to a digit.
      +
      static DigitfromLong(long i) +
      Converts the right-most digit in the given long value to a digit.
      +
      chartoChar() +
      Converts this digit to a character.
      +
      longtoLong() +
      Converts this digit to a long.
      +
      static DigitvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Digit[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        _0

        +
        public static final Digit _0
        +
        Zero.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static final Digit _1
        +
        One.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static final Digit _2
        +
        Two.
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public static final Digit _3
        +
        Three.
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public static final Digit _4
        +
        Four.
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public static final Digit _5
        +
        Five.
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public static final Digit _6
        +
        Six.
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public static final Digit _7
        +
        Seven.
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public static final Digit _8
        +
        Eight.
        +
        • +
      + + + +
        +
      • +

        _9

        +
        public static final Digit _9
        +
        Nine.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        toLong

        +
        public static final F<Digit,java.lang.Long> toLong
        +
        First-class conversion from digit to a long.
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static final F<java.lang.Long,Digit> fromLong
        +
        First-class conversion from a long to a digit.
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public static final F<Digit,java.lang.Character> toChar
        +
        First-class conversion from a digit to a character.
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static final F<java.lang.Character,Option<Digit>> fromChar
        +
        First-class conversion from a character to a digit.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Digit[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Digit c : Digit.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Digit valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toLong

        +
        public long toLong()
        +
        Converts this digit to a long.
        +
        +
        Returns:
        +
        A long for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public char toChar()
        +
        Converts this digit to a character.
        +
        +
        Returns:
        +
        A character for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static Digit fromLong(long i)
        +
        Converts the right-most digit in the given long value to a digit.
        +
        +
        Parameters:
        +
        i - The long to convert.
        +
        Returns:
        +
        The right-most digit in the given long value as a digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static Option<Digit> fromChar(char c)
        +
        Converts the given character in the given long value to a digit.
        +
        +
        Parameters:
        +
        c - The character to convert.
        +
        Returns:
        +
        The character in the given long value as a digit.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Effect.html b/javadoc/4.8.1/functionaljava/fj/Effect.html new file mode 100644 index 0000000..1fdb067 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Effect.html @@ -0,0 +1,384 @@ + + + + + +Effect (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Effect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Effect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Effect
+extends java.lang.Object
    +
    Represents a side-effect.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Effect1<B>contramap(Effect1<A> e1, + F<B,A> f) +
      A contra-variant functor on effect.
      +
      static P1<Unit>f(Effect0 e) 
      static <A> F<A,Unit>f(Effect1<A> e1) +
      Returns a function for the given effect.
      +
      static <A,B> F2<A,B,Unit>f(Effect2<A,B> e) 
      static <A,B,C> F3<A,B,C,Unit>f(Effect3<A,B,C> e) 
      static <A,B,C,D> F4<A,B,C,D,Unit>f(Effect4<A,B,C,D> e) 
      static <A,B,C,D,E>
      F5<A,B,C,D,E,Unit>      		f(Effect5<A,B,C,D,E> z) 
      static <A,B,C,D,E,$F>
      F6<A,B,C,D,E,$F,Unit>      		f(Effect6<A,B,C,D,E,$F> z) 
      static <A,B,C,D,E,$F,G>
      F7<A,B,C,D,E,$F,G,Unit>      		f(Effect7<A,B,C,D,E,$F,G> z) 
      static <A,B,C,D,E,$F,G,H>
      F8<A,B,C,D,E,$F,G,H,Unit>      		f(Effect8<A,B,C,D,E,$F,G,H> z) 
      static <A> Effect1<A>lazy(F<A,Unit> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        f

        +
        public static <A> F<A,Unit> f(Effect1<A> e1)
        +
        Returns a function for the given effect.
        +
        +
        Returns:
        +
        The function using the given effect.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B> F2<A,B,Unit> f(Effect2<A,B> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C> F3<A,B,C,Unit> f(Effect3<A,B,C> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D> F4<A,B,C,D,Unit> f(Effect4<A,B,C,D> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E> F5<A,B,C,D,E,Unit> f(Effect5<A,B,C,D,E> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F> F6<A,B,C,D,E,$F,Unit> f(Effect6<A,B,C,D,E,$F> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G> F7<A,B,C,D,E,$F,G,Unit> f(Effect7<A,B,C,D,E,$F,G> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G,H> F8<A,B,C,D,E,$F,G,H,Unit> f(Effect8<A,B,C,D,E,$F,G,H> z)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Effect1<B> contramap(Effect1<A> e1,
+                                         F<B,A> f)
        +
        A contra-variant functor on effect.
        +
        +
        Parameters:
        +
        f - The function to map over the effect.
        +
        Returns:
        +
        An effect after a contra-variant map.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> Effect1<A> lazy(F<A,Unit> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Equal.AltDefinition.html b/javadoc/4.8.1/functionaljava/fj/Equal.AltDefinition.html new file mode 100644 index 0000000..30fcb75 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Equal.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Equal.AltDefinition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Equal.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Equal<A>
    +
    +
    +
    +
    public static interface Equal.AltDefinition<A>
+extends Equal.Definition<A>
    +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Equal.Definition.html b/javadoc/4.8.1/functionaljava/fj/Equal.Definition.html new file mode 100644 index 0000000..a0a2d70 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Equal.Definition.html @@ -0,0 +1,291 @@ + + + + + +Equal.Definition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.Definition<A>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        equal

        +
        F<A,java.lang.Boolean> equal(A a)
        +
        • +
      + + + + + +
        +
      • +

        equal

        +
        default boolean equal(A a1,
+                      A a2)
        +
        • +
      + + + +
        +
      • +

        then

        +
        default <B> Equal.Definition<A> then(F<A,B> f,
+                                     Equal<B> eq)
        +
        Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
        +
        +
        Parameters:
        +
        f - The function to map the original object
        +
        eq - Equality for the mapped object
        +
        Returns:
        +
        A new equal definition
        +
        See Also:
        +
        equal()
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        default Equal<A> equal()
        +
        Build an equal instance from this definition. + to be called after some successive then(F, Equal) calls.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Equal.html b/javadoc/4.8.1/functionaljava/fj/Equal.html new file mode 100644 index 0000000..62118e4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Equal.html @@ -0,0 +1,1651 @@ + + + + + +Equal (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Equal<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Equal<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Equal<A>
+extends java.lang.Object
    +
    Tests for equality between two objects.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEqual

        +
        public static final Equal<java.lang.Boolean> booleanEqual
        +
        An equal instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteEqual

        +
        public static final Equal<java.lang.Byte> byteEqual
        +
        An equal instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charEqual

        +
        public static final Equal<java.lang.Character> charEqual
        +
        An equal instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleEqual

        +
        public static final Equal<java.lang.Double> doubleEqual
        +
        An equal instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatEqual

        +
        public static final Equal<java.lang.Float> floatEqual
        +
        An equal instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intEqual

        +
        public static final Equal<java.lang.Integer> intEqual
        +
        An equal instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintEqual

        +
        public static final Equal<java.math.BigInteger> bigintEqual
        +
        An equal instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEqual

        +
        public static final Equal<java.math.BigDecimal> bigdecimalEqual
        +
        An equal instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longEqual

        +
        public static final Equal<java.lang.Long> longEqual
        +
        An equal instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortEqual

        +
        public static final Equal<java.lang.Short> shortEqual
        +
        An equal instance for the short type.
        +
        • +
      + + + +
        +
      • +

        naturalEqual

        +
        public static final Equal<Natural> naturalEqual
        +
        An equal instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringEqual

        +
        public static final Equal<java.lang.String> stringEqual
        +
        An equal instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferEqual

        +
        public static final Equal<java.lang.StringBuffer> stringBufferEqual
        +
        An equal instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderEqual

        +
        public static final Equal<java.lang.StringBuilder> stringBuilderEqual
        +
        An equal instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        bitSetSequal

        +
        public static final Equal<BitSet> bitSetSequal
        +
        An equal instance for the BitSet type.
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static final Equal<LazyString> eq
        +
        An equal instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static final Equal<HList.HNil> hListEqual
        +
        An equal instance for the empty heterogeneous list.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the two given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for equality against another.
        +
        a2 - An object to test for equality against another.
        +
        Returns:
        +
        true if the two given arguments are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        notEq

        +
        public boolean notEq(A a1,
+                     A a2)
        +
        Returns true if the two given arguments are not equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for inequality against another.
        +
        a2 - An object to test for inequality against another.
        +
        Returns:
        +
        true if the two given arguments are not equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public F2<A,A,java.lang.Boolean> eq()
        +
        First-class equality check.
        +
        +
        Returns:
        +
        A function that returns true if the two given arguments are equal.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public F<A,java.lang.Boolean> eq(A a)
        +
        Partially applied equality check.
        +
        +
        Parameters:
        +
        a - An object to test for equality against another.
        +
        Returns:
        +
        A function that returns true if the given argument equals the argument to this method.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Equal<B> contramap(F<B,A> f)
        +
        Maps the given function across this equal as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new equal.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public final Equal<A> not()
        +
        An equal instance, which reverts equality for self
        +
        +
        Returns:
        +
        A new equal instance
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Equal<A> contramap(F<A,B> f,
+                                       Equal<B> eq)
        +
        Static version of contramap(F)
        +
        • +
      + + + + + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F<A,F<A,java.lang.Boolean>> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F2<A,A,java.lang.Boolean> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.Definition<A> definition)
        +
        Constructs an equal instance from the given definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.AltDefinition<A> definition)
        +
        Constructs an equal instance from the given (alternative) definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyEqual

        +
        public static <A> Equal<A> anyEqual()
        +
        Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        Returns:
        +
        An equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        • +
      + + + +
        +
      • +

        eitherEqual

        +
        public static <A,B> Equal<Either<A,B>> eitherEqual(Equal<A> ea,
+                                                   Equal<B> eb)
        +
        An equal instance for the Either type.
        +
        +
        Parameters:
        +
        ea - Equality across the left side of Either.
        +
        eb - Equality across the right side of Either.
        +
        Returns:
        +
        An equal instance for the Either type.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        validationEqual

        +
        public static <A,B> Equal<Validation<A,B>> validationEqual(Equal<A> ea,
+                                                           Equal<B> eb)
        +
        An equal instance for the Validation type.
        +
        +
        Parameters:
        +
        ea - Equality across the failing side of Validation.
        +
        eb - Equality across the succeeding side of Validation.
        +
        Returns:
        +
        An equal instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listEqual

        +
        public static <A> Equal<List<A>> listEqual(Equal<A> ea)
        +
        An equal instance for the List type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the list.
        +
        Returns:
        +
        An equal instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListEqual

        +
        public static <A> Equal<NonEmptyList<A>> nonEmptyListEqual(Equal<A> ea)
        +
        An equal instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the non-empty list.
        +
        Returns:
        +
        An equal instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionEqual

        +
        public static <A> Equal<Option<A>> optionEqual(Equal<A> ea)
        +
        An equal instance for the Option type.
        +
        +
        Parameters:
        +
        ea - Equality across the element of the option.
        +
        Returns:
        +
        An equal instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqEqual

        +
        public static <A> Equal<Seq<A>> seqEqual(Equal<A> e)
        +
        • +
      + + + +
        +
      • +

        streamEqual

        +
        public static <A> Equal<Stream<A>> streamEqual(Equal<A> ea)
        +
        An equal instance for the Stream type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the stream.
        +
        Returns:
        +
        An equal instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperEqual

        +
        public static <A> Equal<Zipper<A>> zipperEqual(Equal<A> ea)
        +
        An equal instance for the Zipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the zipper.
        +
        Returns:
        +
        An equal instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperEqual

        +
        public static <A> Equal<TreeZipper<A>> treeZipperEqual(Equal<A> ea)
        +
        An equal instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree zipper.
        +
        Returns:
        +
        An equal instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayEqual

        +
        public static <A> Equal<Array<A>> arrayEqual(Equal<A> ea)
        +
        An equal instance for the Array type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the array.
        +
        Returns:
        +
        An equal instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        treeEqual

        +
        public static <A> Equal<Tree<A>> treeEqual(Equal<A> ea)
        +
        An equal instance for the Tree type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree.
        +
        Returns:
        +
        An equal instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Equal

        +
        public static <A> Equal<P1<A>> p1Equal(Equal<A> ea)
        +
        An equal instance for a product-1.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        Returns:
        +
        An equal instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Equal

        +
        public static <A,B> Equal<P2<A,B>> p2Equal(Equal<A> ea,
+                                           Equal<B> eb)
        +
        An equal instance for a product-2.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        Returns:
        +
        An equal instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Equal

        +
        public static <A,B,C> Equal<P3<A,B,C>> p3Equal(Equal<A> ea,
+                                               Equal<B> eb,
+                                               Equal<C> ec)
        +
        An equal instance for a product-3.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        Returns:
        +
        An equal instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Equal

        +
        public static <A,B,C,D> Equal<P4<A,B,C,D>> p4Equal(Equal<A> ea,
+                                                   Equal<B> eb,
+                                                   Equal<C> ec,
+                                                   Equal<D> ed)
        +
        An equal instance for a product-4.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        Returns:
        +
        An equal instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Equal

        +
        public static <A,B,C,D,E> Equal<P5<A,B,C,D,E>> p5Equal(Equal<A> ea,
+                                                       Equal<B> eb,
+                                                       Equal<C> ec,
+                                                       Equal<D> ed,
+                                                       Equal<E> ee)
        +
        An equal instance for a product-5.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        Returns:
        +
        An equal instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Equal

        +
        public static <A,B,C,D,E,F$> Equal<P6<A,B,C,D,E,F$>> p6Equal(Equal<A> ea,
+                                                             Equal<B> eb,
+                                                             Equal<C> ec,
+                                                             Equal<D> ed,
+                                                             Equal<E> ee,
+                                                             Equal<F$> ef)
        +
        An equal instance for a product-6.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        Returns:
        +
        An equal instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Equal

        +
        public static <A,B,C,D,E,F$,G> Equal<P7<A,B,C,D,E,F$,G>> p7Equal(Equal<A> ea,
+                                                                 Equal<B> eb,
+                                                                 Equal<C> ec,
+                                                                 Equal<D> ed,
+                                                                 Equal<E> ee,
+                                                                 Equal<F$> ef,
+                                                                 Equal<G> eg)
        +
        An equal instance for a product-7.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        Returns:
        +
        An equal instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Equal

        +
        public static <A,B,C,D,E,F$,G,H> Equal<P8<A,B,C,D,E,F$,G,H>> p8Equal(Equal<A> ea,
+                                                                     Equal<B> eb,
+                                                                     Equal<C> ec,
+                                                                     Equal<D> ed,
+                                                                     Equal<E> ee,
+                                                                     Equal<F$> ef,
+                                                                     Equal<G> eg,
+                                                                     Equal<H> eh)
        +
        An equal instance for a product-8.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        eh - Equality across the eighth element of the product.
        +
        Returns:
        +
        An equal instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Equal

        +
        public static <A> Equal<V2<A>> v2Equal(Equal<A> ea)
        +
        An equal instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Equal

        +
        public static <A> Equal<V3<A>> v3Equal(Equal<A> ea)
        +
        An equal instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Equal

        +
        public static <A> Equal<V4<A>> v4Equal(Equal<A> ea)
        +
        An equal instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Equal

        +
        public static <A> Equal<V5<A>> v5Equal(Equal<A> ea)
        +
        An equal instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Equal

        +
        public static <A> Equal<V6<A>> v6Equal(Equal<A> ea)
        +
        An equal instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Equal

        +
        public static <A> Equal<V7<A>> v7Equal(Equal<A> ea)
        +
        An equal instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Equal

        +
        public static <A> Equal<V8<A>> v8Equal(Equal<A> ea)
        +
        An equal instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static <E,L extends HList<L>> Equal<HList.HCons<E,L>> hListEqual(Equal<E> e,
+                                                                        Equal<L> l)
        +
        An equal instance for heterogeneous lists.
        +
        +
        Parameters:
        +
        e - Equality for the first element of the list.
        +
        l - Equality for the rest of the list.
        +
        Returns:
        +
        an equal instance for a heterogeneous list.
        +
        +
        • +
      + + + +
        +
      • +

        setEqual

        +
        public static <A> Equal<Set<A>> setEqual(Equal<A> e)
        +
        Equal instance for sets.
        +
        +
        Parameters:
        +
        e - Equality for the set elements.
        +
        Returns:
        +
        An equal instance for sets.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writerEqual

        +
        public static <A,B> Equal<Writer<A,B>> writerEqual(Equal<A> eq1,
+                                                   Equal<B> eq2)
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  Equal<A> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - an equal instance for the type of self (that use anyEqual() if generic type).
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  F0<Equal<A>> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - a lazy equal instance for the type (that use anyEqual() if generic type)..
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F.html b/javadoc/4.8.1/functionaljava/fj/F.html new file mode 100644 index 0000000..dca7d31 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F.html @@ -0,0 +1,236 @@ + + + + + +F (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F<A,B>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F1W, F1W.F1WFunc
    +
    +
    +
    +
    public interface F<A,B>
    +
    A transformation or function from A to B. This type can be represented + using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
        +
        Transform A to B.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F0.html b/javadoc/4.8.1/functionaljava/fj/F0.html new file mode 100644 index 0000000..e5a8cb5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F0.html @@ -0,0 +1,224 @@ + + + + + +F0 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F0<A>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    $, P1
    +
    +
    +
    +
    public interface F0<A>
    +
    Created by MarkPerry on 21/01/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F1Functions.html b/javadoc/4.8.1/functionaljava/fj/F1Functions.html new file mode 100644 index 0000000..cbf57d5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F1Functions.html @@ -0,0 +1,1691 @@ + + + + + +F1Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F1Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F1Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<F<B,C>,F<A,C>>andThen(F<A,B> f) +
      First-class composition flipped.
      +
      static <A,B,C> F<A,C>andThen(F<A,B> f, + F<B,C> g) +
      Function composition flipped.
      +
      static <A,B,C> F<F<A,F<B,C>>,F<A,C>>apply(F<A,B> f) +
      First-class function application in an environment.
      +
      static <A,B,C> F<A,C>apply(F<A,B> f, + F<A,F<B,C>> g) +
      Function application in an environment (Applicative Functor).
      +
      static <A,B> F<A,Array<B>>arrayK(F<A,B> f) +
      Promotes this function so that it returns its result in a Array.
      +
      static <A,B,C> F<F<B,F<A,C>>,F<A,C>>bind(F<A,B> f) +
      First-class function binding.
      +
      static <A,B,C> F<A,C>bind(F<A,B> f, + F<B,F<A,C>> g) +
      Binds a given function across this function (Reader Monad).
      +
      static <A,B,C> F<C,B>contramap(F<A,B> target, + F<C,A> f) 
      static <A,B> F<Actor<B>,Actor<A>>contramapActor(F<A,B> f) +
      Returns a function that contramaps over a given actor.
      +
      static <A,B> F<Equal<B>,Equal<A>>contramapEqual(F<A,B> f) +
      Promotes this function to map over an Equal as a contravariant functor.
      +
      static <A,B> F<Hash<B>,Hash<A>>contramapHash(F<A,B> f) +
      Promotes this function to map over a Hash as a contravariant functor.
      +
      static <A,B> F<Show<B>,Show<A>>contramapShow(F<A,B> f) +
      Promotes this function to map over a Show as a contravariant functor.
      +
      static <A,B,C,D> F<C,D>dimap(F<A,B> target, + F<C,A> f, + F<B,D> g) +
      Both map (with g) and contramap (with f) the target function.
      +
      static <A,B,C> F<A,Either<B,C>>eitherLeftK(F<A,B> f) +
      Promotes this function so that it returns its result on the left side of an Either.
      +
      static <A,B,C> F<A,Either<C,B>>eitherRightK(F<A,B> f) +
      Promotes this function so that it returns its result on the right side of an Either.
      +
      static <A,B> P1<B>f(F<A,B> f, + A a) +
      Partial application.
      +
      static <A,B,C> F<A,Validation<B,C>>failK(F<A,B> f) +
      Promotes this function so that it returns its result on the failure side of a Validation.
      +
      static <A,B> F<Tree<A>,B>foldMapTree(F<A,B> f, + Monoid<B> m) +
      Returns a function that maps this function over a tree and folds it with the given monoid.
      +
      static <A,B> F<A,IterableW<B>>iterableK(F<A,B> f) +
      Promotes this function to return its value in an Iterable.
      +
      static <A,B> F<A,P1<B>>lazy(F<A,B> f) +
      Promotes this function so that it returns its result in a product-1.
      +
      static <A,B> F<A,List<B>>listK(F<A,B> f) +
      Promotes this function so that it returns its result in a List.
      +
      static <A,B,C> F<A,C>map(F<A,B> target, + F<B,C> f) 
      static <A,B> F<Array<A>,Array<B>>mapArray(F<A,B> f) +
      Promotes this function to map over a Array.
      +
      static <A,B> F<P2<A,A>,P2<B,B>>mapBoth(F<A,B> f) +
      Promotes this function to map over both elements of a pair.
      +
      static <A,B,X> F<Validation<A,X>,Validation<B,X>>mapFail(F<A,B> f) +
      Promotes this function to map over the failure side of a Validation.
      +
      static <A,B,C> F<P2<A,C>,P2<B,C>>mapFst(F<A,B> f) +
      Promotes this function to map over the first element of a pair.
      +
      static <A,B> F<java.lang.Iterable<A>,IterableW<B>>mapIterable(F<A,B> f) +
      Promotes this function to map over Iterables.
      +
      static <A,B> java.util.concurrent.ArrayBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.ArrayBlockingQueue<A> as) +
      Maps this function over an ArrayBlockingQueue.
      +
      static <A,B> java.util.ArrayList<B>mapJ(F<A,B> f, + java.util.ArrayList<A> as) +
      Maps this function over an ArrayList.
      +
      static <A,B> java.util.concurrent.ConcurrentLinkedQueue<B>mapJ(F<A,B> f, + java.util.concurrent.ConcurrentLinkedQueue<A> as) +
      Maps this function over a ConcurrentLinkedQueue.
      +
      static <A,B> java.util.concurrent.CopyOnWriteArrayList<B>mapJ(F<A,B> f, + java.util.concurrent.CopyOnWriteArrayList<A> as) +
      Maps this function over a CopyOnWriteArrayList.
      +
      static <A,B> java.util.concurrent.CopyOnWriteArraySet<B>mapJ(F<A,B> f, + java.util.concurrent.CopyOnWriteArraySet<A> as) +
      Maps this function over a CopyOnWriteArraySet.
      +
      static <A,B> java.util.concurrent.LinkedBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.LinkedBlockingQueue<A> as) +
      Maps this function over a LinkedBlockingQueue.
      +
      static <A,B> java.util.LinkedList<B>mapJ(F<A,B> f, + java.util.LinkedList<A> as) +
      Maps this function over a LinkedList.
      +
      static <A,B> java.util.concurrent.PriorityBlockingQueue<B>mapJ(F<A,B> f, + java.util.concurrent.PriorityBlockingQueue<A> as) +
      Maps this function over a PriorityBlockingQueue.
      +
      static <A,B> java.util.PriorityQueue<B>mapJ(F<A,B> f, + java.util.PriorityQueue<A> as) +
      Maps this function over a PriorityQueue.
      +
      static <A,B> java.util.concurrent.SynchronousQueue<B>mapJ(F<A,B> f, + java.util.concurrent.SynchronousQueue<A> as) +
      Maps this function over a SynchronousQueue.
      +
      static <A,B> java.util.TreeSet<B>mapJ(F<A,B> f, + java.util.TreeSet<A> as) +
      Maps this function over a TreeSet.
      +
      static <A,B,X> F<Either<A,X>,Either<B,X>>mapLeft(F<A,B> f) +
      Promotes this function to map over the left side of an Either.
      +
      static <A,B> F<List<A>,List<B>>mapList(F<A,B> f) +
      Promotes this function to map over a List.
      +
      static <A,B> F<NonEmptyList<A>,NonEmptyList<B>>mapNel(F<A,B> f) +
      Promotes this function to map over a NonEmptyList.
      +
      static <A,B> F<Option<A>,Option<B>>mapOption(F<A,B> f) +
      Promotes this function to map over an optional value.
      +
      static <A,B> F<P1<A>,P1<B>>mapP1(F<A,B> f) +
      Promotes this function to map over a product-1.
      +
      static <A,B> F<Promise<A>,Promise<B>>mapPromise(F<A,B> f) +
      Promotes this function to map over a Promise.
      +
      static <A,B,X> F<Either<X,A>,Either<X,B>>mapRight(F<A,B> f) +
      Promotes this function to map over the right side of an Either.
      +
      static <A,B> F<Set<A>,Set<B>>mapSet(F<A,B> f, + Ord<B> o) +
      Promotes this function to map over a Set.
      +
      static <A,B,C> F<P2<C,A>,P2<C,B>>mapSnd(F<A,B> f) +
      Promotes this function to map over the second element of a pair.
      +
      static <A,B> F<Stream<A>,Stream<B>>mapStream(F<A,B> f) +
      Promotes this function to map over a Stream.
      +
      static <A,B,X> F<Validation<X,A>,Validation<X,B>>mapSuccess(F<A,B> f) +
      Promotes this function to map over the success side of a Validation.
      +
      static <A,B> F<Tree<A>,Tree<B>>mapTree(F<A,B> f) +
      Promotes this function to map over a Tree.
      +
      static <A,B> F<TreeZipper<A>,TreeZipper<B>>mapTreeZipper(F<A,B> f) +
      Promotes this function to map over a TreeZipper.
      +
      static <A,B> F<Zipper<A>,Zipper<B>>mapZipper(F<A,B> f) +
      Promotes this function to map over a Zipper.
      +
      static <A,B> F<A,NonEmptyList<B>>nelK(F<A,B> f) +
      Promotes this function to return its value in a NonEmptyList.
      +
      static <A,B,C> F<F<C,A>,F<C,B>>o(F<A,B> f) +
      First-class function composition
      +
      static <A,B,C> F<C,B>o(F<A,B> f, + F<C,A> g) +
      Function composition
      +
      static <A,B,C> F<F<B,F<B,C>>,F<A,F<A,C>>>on(F<A,B> f) +
      Applies this function over the arguments of another function.
      +
      static <A,B,C> F<A,F<A,C>>on(F<A,B> f, + F<B,F<B,C>> g) +
      Applies this function over the arguments of another function.
      +
      static <A,B> F<Validation<B,A>,B>onFail(F<A,B> f) +
      Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
      +
      static <A,B> F<Either<B,A>,B>onLeft(F<A,B> f) +
      Returns a function that returns the left side of a given Either, or this function applied to the right side.
      +
      static <A,B> F<Either<A,B>,B>onRight(F<A,B> f) +
      Returns a function that returns the right side of a given Either, or this function applied to the left side.
      +
      static <A,B> F<Validation<A,B>,B>onSuccess(F<A,B> f) +
      Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
      +
      static <A,B> F<A,Option<B>>optionK(F<A,B> f) +
      Promotes this function so that it returns its result in an Option.
      +
      static <A,B> F<A,Promise<B>>promiseK(F<A,B> f, + Strategy<Unit> s) +
      Promotes this function to a concurrent function that returns a Promise of a value.
      +
      static <A,B> F<A,Set<B>>setK(F<A,B> f, + Ord<B> o) +
      Promotes this function to return its value in a Set.
      +
      static <A,B> F<A,Stream<B>>streamK(F<A,B> f) +
      Promotes this function so that it returns its result in a Stream.
      +
      static <A,B,C> F<A,Validation<C,B>>successK(F<A,B> f) +
      Promotes this function so that it returns its result on the success side of an Validation.
      +
      static <A,B> F<A,Tree<B>>treeK(F<A,B> f) +
      Promotes this function to return its value in a Tree.
      +
      static <A,B> F<A,TreeZipper<B>>treeZipperK(F<A,B> f) +
      Promotes this function to return its value in a TreeZipper.
      +
      static <A,B> F<A,Zipper<B>>zipperK(F<A,B> f) +
      Promotes this function to return its value in a Zipper.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        o

        +
        public static <A,B,C> F<C,B> o(F<A,B> f,
+                               F<C,A> g)
        +
        Function composition
        +
        +
        Parameters:
        +
        g - A function to compose with this one.
        +
        Returns:
        +
        The composed function such that this function is applied last.
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        public static <A,B,C> F<F<C,A>,F<C,B>> o(F<A,B> f)
        +
        First-class function composition
        +
        +
        Returns:
        +
        A function that composes this function with another.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<A,C> andThen(F<A,B> f,
+                                     F<B,C> g)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function with which to compose this one.
        +
        Returns:
        +
        The composed function such that this function is applied first.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<F<B,C>,F<A,C>> andThen(F<A,B> f)
        +
        First-class composition flipped.
        +
        +
        Returns:
        +
        A function that invokes this function and then a given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<A,C> bind(F<A,B> f,
+                                  F<B,F<A,C>> g)
        +
        Binds a given function across this function (Reader Monad).
        +
        +
        Parameters:
        +
        g - A function that takes the return value of this function as an argument, yielding a new function.
        +
        Returns:
        +
        A function that invokes this function on its argument and then the given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<F<B,F<A,C>>,F<A,C>> bind(F<A,B> f)
        +
        First-class function binding.
        +
        +
        Returns:
        +
        A function that binds another function across this function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<A,C> apply(F<A,B> f,
+                                   F<A,F<B,C>> g)
        +
        Function application in an environment (Applicative Functor).
        +
        +
        Parameters:
        +
        g - A function with the same argument type as this function, yielding a function that takes the return + value of this function.
        +
        Returns:
        +
        A new function that invokes the given function on its argument, yielding a new function that is then + applied to the result of applying this function to the argument.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<F<A,F<B,C>>,F<A,C>> apply(F<A,B> f)
        +
        First-class function application in an environment.
        +
        +
        Returns:
        +
        A function that applies a given function within the environment of this function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<A,F<A,C>> on(F<A,B> f,
+                                     F<B,F<B,C>> g)
        +
        Applies this function over the arguments of another function.
        +
        +
        Parameters:
        +
        g - The function over whose arguments to apply this function.
        +
        Returns:
        +
        A new function that invokes this function on its arguments before invoking the given function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<F<B,F<B,C>>,F<A,F<A,C>>> on(F<A,B> f)
        +
        Applies this function over the arguments of another function.
        +
        +
        Returns:
        +
        A function that applies this function over the arguments of another function.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> F<A,P1<B>> lazy(F<A,B> f)
        +
        Promotes this function so that it returns its result in a product-1. Kleisli arrow for P1.
        +
        +
        Returns:
        +
        This function promoted to return its result in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        public static <A,B> P1<B> f(F<A,B> f,
+                            A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument to return a lazy value.
        +
        +
        • +
      + + + +
        +
      • +

        mapP1

        +
        public static <A,B> F<P1<A>,P1<B>> mapP1(F<A,B> f)
        +
        Promotes this function to map over a product-1.
        +
        +
        Returns:
        +
        This function promoted to map over a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        optionK

        +
        public static <A,B> F<A,Option<B>> optionK(F<A,B> f)
        +
        Promotes this function so that it returns its result in an Option. Kleisli arrow for Option.
        +
        +
        Returns:
        +
        This function promoted to return its result in an Option.
        +
        +
        • +
      + + + +
        +
      • +

        mapOption

        +
        public static <A,B> F<Option<A>,Option<B>> mapOption(F<A,B> f)
        +
        Promotes this function to map over an optional value.
        +
        +
        Returns:
        +
        This function promoted to map over an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        listK

        +
        public static <A,B> F<A,List<B>> listK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a List. Kleisli arrow for List.
        +
        +
        Returns:
        +
        This function promoted to return its result in a List.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public static <A,B> F<List<A>,List<B>> mapList(F<A,B> f)
        +
        Promotes this function to map over a List.
        +
        +
        Returns:
        +
        This function promoted to map over a List.
        +
        +
        • +
      + + + +
        +
      • +

        streamK

        +
        public static <A,B> F<A,Stream<B>> streamK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a Stream. Kleisli arrow for Stream.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public static <A,B> F<Stream<A>,Stream<B>> mapStream(F<A,B> f)
        +
        Promotes this function to map over a Stream.
        +
        +
        Returns:
        +
        This function promoted to map over a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        arrayK

        +
        public static <A,B> F<A,Array<B>> arrayK(F<A,B> f)
        +
        Promotes this function so that it returns its result in a Array. Kleisli arrow for Array.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Array.
        +
        +
        • +
      + + + +
        +
      • +

        mapArray

        +
        public static <A,B> F<Array<A>,Array<B>> mapArray(F<A,B> f)
        +
        Promotes this function to map over a Array.
        +
        +
        Returns:
        +
        This function promoted to map over a Array.
        +
        +
        • +
      + + + +
        +
      • +

        contramapActor

        +
        public static <A,B> F<Actor<B>,Actor<A>> contramapActor(F<A,B> f)
        +
        Returns a function that contramaps over a given actor.
        +
        +
        Returns:
        +
        A function that contramaps over a given actor.
        +
        +
        • +
      + + + +
        +
      • +

        promiseK

        +
        public static <A,B> F<A,Promise<B>> promiseK(F<A,B> f,
+                                             Strategy<Unit> s)
        +
        Promotes this function to a concurrent function that returns a Promise of a value.
        +
        +
        Parameters:
        +
        s - A parallel strategy for concurrent execution.
        +
        Returns:
        +
        A concurrent function that returns a Promise of a value.
        +
        +
        • +
      + + + +
        +
      • +

        mapPromise

        +
        public static <A,B> F<Promise<A>,Promise<B>> mapPromise(F<A,B> f)
        +
        Promotes this function to map over a Promise.
        +
        +
        Returns:
        +
        This function promoted to map over Promises.
        +
        +
        • +
      + + + +
        +
      • +

        eitherLeftK

        +
        public static <A,B,C> F<A,Either<B,C>> eitherLeftK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the left side of an Either. + Kleisli arrow for the Either left projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        eitherRightK

        +
        public static <A,B,C> F<A,Either<C,B>> eitherRightK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the right side of an Either. + Kleisli arrow for the Either right projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapLeft

        +
        public static <A,B,X> F<Either<A,X>,Either<B,X>> mapLeft(F<A,B> f)
        +
        Promotes this function to map over the left side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapRight

        +
        public static <A,B,X> F<Either<X,A>,Either<X,B>> mapRight(F<A,B> f)
        +
        Promotes this function to map over the right side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        onLeft

        +
        public static <A,B> F<Either<B,A>,B> onLeft(F<A,B> f)
        +
        Returns a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        Returns:
        +
        a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        • +
      + + + +
        +
      • +

        onRight

        +
        public static <A,B> F<Either<A,B>,B> onRight(F<A,B> f)
        +
        Returns a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        Returns:
        +
        a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        • +
      + + + +
        +
      • +

        iterableK

        +
        public static <A,B> F<A,IterableW<B>> iterableK(F<A,B> f)
        +
        Promotes this function to return its value in an Iterable.
        +
        +
        Returns:
        +
        This function promoted to return its value in an Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        mapIterable

        +
        public static <A,B> F<java.lang.Iterable<A>,IterableW<B>> mapIterable(F<A,B> f)
        +
        Promotes this function to map over Iterables.
        +
        +
        Returns:
        +
        This function promoted to map over Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        nelK

        +
        public static <A,B> F<A,NonEmptyList<B>> nelK(F<A,B> f)
        +
        Promotes this function to return its value in a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to return its value in a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        mapNel

        +
        public static <A,B> F<NonEmptyList<A>,NonEmptyList<B>> mapNel(F<A,B> f)
        +
        Promotes this function to map over a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to map over a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        setK

        +
        public static <A,B> F<A,Set<B>> setK(F<A,B> f,
+                                     Ord<B> o)
        +
        Promotes this function to return its value in a Set.
        +
        +
        Parameters:
        +
        o - An order for the set.
        +
        Returns:
        +
        This function promoted to return its value in a Set.
        +
        +
        • +
      + + + +
        +
      • +

        mapSet

        +
        public static <A,B> F<Set<A>,Set<B>> mapSet(F<A,B> f,
+                                            Ord<B> o)
        +
        Promotes this function to map over a Set.
        +
        +
        Parameters:
        +
        o - An order for the resulting set.
        +
        Returns:
        +
        This function promoted to map over a Set.
        +
        +
        • +
      + + + +
        +
      • +

        treeK

        +
        public static <A,B> F<A,Tree<B>> treeK(F<A,B> f)
        +
        Promotes this function to return its value in a Tree.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        mapTree

        +
        public static <A,B> F<Tree<A>,Tree<B>> mapTree(F<A,B> f)
        +
        Promotes this function to map over a Tree.
        +
        +
        Returns:
        +
        This function promoted to map over a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapTree

        +
        public static <A,B> F<Tree<A>,B> foldMapTree(F<A,B> f,
+                                             Monoid<B> m)
        +
        Returns a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        Parameters:
        +
        m - The monoid with which to fold the mapped tree.
        +
        Returns:
        +
        a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperK

        +
        public static <A,B> F<A,TreeZipper<B>> treeZipperK(F<A,B> f)
        +
        Promotes this function to return its value in a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapTreeZipper

        +
        public static <A,B> F<TreeZipper<A>,TreeZipper<B>> mapTreeZipper(F<A,B> f)
        +
        Promotes this function to map over a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to map over a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        failK

        +
        public static <A,B,C> F<A,Validation<B,C>> failK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the failure side of a Validation. + Kleisli arrow for the Validation failure projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        successK

        +
        public static <A,B,C> F<A,Validation<C,B>> successK(F<A,B> f)
        +
        Promotes this function so that it returns its result on the success side of an Validation. + Kleisli arrow for the Validation success projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the success side of an Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapFail

        +
        public static <A,B,X> F<Validation<A,X>,Validation<B,X>> mapFail(F<A,B> f)
        +
        Promotes this function to map over the failure side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapSuccess

        +
        public static <A,B,X> F<Validation<X,A>,Validation<X,B>> mapSuccess(F<A,B> f)
        +
        Promotes this function to map over the success side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the success side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        onFail

        +
        public static <A,B> F<Validation<B,A>,B> onFail(F<A,B> f)
        +
        Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        Returns:
        +
        a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        public static <A,B> F<Validation<A,B>,B> onSuccess(F<A,B> f)
        +
        Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        Returns:
        +
        a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        • +
      + + + +
        +
      • +

        zipperK

        +
        public static <A,B> F<A,Zipper<B>> zipperK(F<A,B> f)
        +
        Promotes this function to return its value in a Zipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapZipper

        +
        public static <A,B> F<Zipper<A>,Zipper<B>> mapZipper(F<A,B> f)
        +
        Promotes this function to map over a Zipper.
        +
        +
        Returns:
        +
        This function promoted to map over a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        contramapEqual

        +
        public static <A,B> F<Equal<B>,Equal<A>> contramapEqual(F<A,B> f)
        +
        Promotes this function to map over an Equal as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over an Equal as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapHash

        +
        public static <A,B> F<Hash<B>,Hash<A>> contramapHash(F<A,B> f)
        +
        Promotes this function to map over a Hash as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Hash as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapShow

        +
        public static <A,B> F<Show<B>,Show<A>> contramapShow(F<A,B> f)
        +
        Promotes this function to map over a Show as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Show as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        mapFst

        +
        public static <A,B,C> F<P2<A,C>,P2<B,C>> mapFst(F<A,B> f)
        +
        Promotes this function to map over the first element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the first element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapSnd

        +
        public static <A,B,C> F<P2<C,A>,P2<C,B>> mapSnd(F<A,B> f)
        +
        Promotes this function to map over the second element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the second element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapBoth

        +
        public static <A,B> F<P2<A,A>,P2<B,B>> mapBoth(F<A,B> f)
        +
        Promotes this function to map over both elements of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over both elements of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.SynchronousQueue<B> mapJ(F<A,B> f,
+                                                                  java.util.concurrent.SynchronousQueue<A> as)
        +
        Maps this function over a SynchronousQueue.
        +
        +
        Parameters:
        +
        as - A SynchronousQueue to map this function over.
        +
        Returns:
        +
        A new SynchronousQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.PriorityBlockingQueue<B> mapJ(F<A,B> f,
+                                                                       java.util.concurrent.PriorityBlockingQueue<A> as)
        +
        Maps this function over a PriorityBlockingQueue.
        +
        +
        Parameters:
        +
        as - A PriorityBlockingQueue to map this function over.
        +
        Returns:
        +
        A new PriorityBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.LinkedBlockingQueue<B> mapJ(F<A,B> f,
+                                                                     java.util.concurrent.LinkedBlockingQueue<A> as)
        +
        Maps this function over a LinkedBlockingQueue.
        +
        +
        Parameters:
        +
        as - A LinkedBlockingQueue to map this function over.
        +
        Returns:
        +
        A new LinkedBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.CopyOnWriteArraySet<B> mapJ(F<A,B> f,
+                                                                     java.util.concurrent.CopyOnWriteArraySet<A> as)
        +
        Maps this function over a CopyOnWriteArraySet.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArraySet to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArraySet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.CopyOnWriteArrayList<B> mapJ(F<A,B> f,
+                                                                      java.util.concurrent.CopyOnWriteArrayList<A> as)
        +
        Maps this function over a CopyOnWriteArrayList.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArrayList to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.ConcurrentLinkedQueue<B> mapJ(F<A,B> f,
+                                                                       java.util.concurrent.ConcurrentLinkedQueue<A> as)
        +
        Maps this function over a ConcurrentLinkedQueue.
        +
        +
        Parameters:
        +
        as - A ConcurrentLinkedQueue to map this function over.
        +
        Returns:
        +
        A new ConcurrentLinkedQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.concurrent.ArrayBlockingQueue<B> mapJ(F<A,B> f,
+                                                                    java.util.concurrent.ArrayBlockingQueue<A> as)
        +
        Maps this function over an ArrayBlockingQueue.
        +
        +
        Parameters:
        +
        as - An ArrayBlockingQueue to map this function over.
        +
        Returns:
        +
        A new ArrayBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.TreeSet<B> mapJ(F<A,B> f,
+                                              java.util.TreeSet<A> as)
        +
        Maps this function over a TreeSet.
        +
        +
        Parameters:
        +
        as - A TreeSet to map this function over.
        +
        Returns:
        +
        A new TreeSet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.PriorityQueue<B> mapJ(F<A,B> f,
+                                                    java.util.PriorityQueue<A> as)
        +
        Maps this function over a PriorityQueue.
        +
        +
        Parameters:
        +
        as - A PriorityQueue to map this function over.
        +
        Returns:
        +
        A new PriorityQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.LinkedList<B> mapJ(F<A,B> f,
+                                                 java.util.LinkedList<A> as)
        +
        Maps this function over a LinkedList.
        +
        +
        Parameters:
        +
        as - A LinkedList to map this function over.
        +
        Returns:
        +
        A new LinkedList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public static <A,B> java.util.ArrayList<B> mapJ(F<A,B> f,
+                                                java.util.ArrayList<A> as)
        +
        Maps this function over an ArrayList.
        +
        +
        Parameters:
        +
        as - An ArrayList to map this function over.
        +
        Returns:
        +
        A new ArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B,C> F<A,C> map(F<A,B> target,
+                                 F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B,C> F<C,B> contramap(F<A,B> target,
+                                       F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        dimap

        +
        public static <A,B,C,D> F<C,D> dimap(F<A,B> target,
+                                     F<C,A> f,
+                                     F<B,D> g)
        +
        Both map (with g) and contramap (with f) the target function. (Profunctor pattern)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F1W.F1WFunc.html b/javadoc/4.8.1/functionaljava/fj/F1W.F1WFunc.html new file mode 100644 index 0000000..c06fd98 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F1W.F1WFunc.html @@ -0,0 +1,316 @@ + + + + + +F1W.F1WFunc (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F1W.F1WFunc<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1W<A,B>
      • +
    • +
        +
      • fj.F1W.F1WFunc<A,B>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F<A,B>
    +
    +
    +
    Enclosing class:
    +
    F1W<A,B>
    +
    +
    +
    +
    public static class F1W.F1WFunc<A,B>
+extends F1W<A,B>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F1WFunc

        +
        public F1WFunc(F<A,B> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final B f(A a)
        +
        Description copied from interface: F
        +
        Transform A to B.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F1W.html b/javadoc/4.8.1/functionaljava/fj/F1W.html new file mode 100644 index 0000000..4207433 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F1W.html @@ -0,0 +1,1710 @@ + + + + + +F1W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F1W<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F1W<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F<A,B>
    +
    +
    +
    Direct Known Subclasses:
    +
    F1W.F1WFunc
    +
    +
    +
    +
    public abstract class F1W<A,B>
+extends java.lang.Object
+implements F<A,B>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class F1W.F1WFunc<A,B> 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F1W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <C> F1W<F<B,C>,F<A,C>>andThen() +
      First-class composition flipped.
      +
      <C> F1W<A,C>andThen(F<B,C> g) +
      Function composition flipped.
      +
      <C> F1W<F<A,F<B,C>>,F<A,C>>apply() +
      First-class function application in an environment.
      +
      <C> F1W<A,C>apply(F<A,F<B,C>> g) +
      Function application in an environment (Applicative Functor).
      +
      F1W<A,Array<B>>arrayK() +
      Promotes this function so that it returns its result in a Array.
      +
      <C> F1W<F<B,F<A,C>>,F<A,C>>bind() +
      First-class function binding.
      +
      <C> F1W<A,C>bind(F<B,F<A,C>> g) +
      Binds a given function across this function (Reader Monad).
      +
      <C> F1W<C,B>contramap(F<C,A> f) 
      F1W<Actor<B>,Actor<A>>contramapActor() +
      Returns a function that contramaps over a given actor.
      +
      F1W<Equal<B>,Equal<A>>contramapEqual() +
      Promotes this function to map over an Equal as a contravariant functor.
      +
      F1W<Hash<B>,Hash<A>>contramapHash() +
      Promotes this function to map over a Hash as a contravariant functor.
      +
      F1W<Show<B>,Show<A>>contramapShow() +
      Promotes this function to map over a Show as a contravariant functor.
      +
      <C> F1W<A,Either<B,C>>eitherLeftK() +
      Promotes this function so that it returns its result on the left side of an Either.
      +
      <C> F1W<A,Either<C,B>>eitherRightK() +
      Promotes this function so that it returns its result on the right side of an Either.
      +
      <C> F1W<A,Validation<B,C>>failK() +
      Promotes this function so that it returns its result on the failure side of a Validation.
      +
      F1W<Tree<A>,B>foldMapTree(Monoid<B> m) +
      Returns a function that maps this function over a tree and folds it with the given monoid.
      +
      F1W<A,IterableW<B>>iterableK() +
      Promotes this function to return its value in an Iterable.
      +
      F1W<A,P1<B>>lazy() +
      Promotes this function so that it returns its result in a product-1.
      +
      P1<B>lazy(A a) +
      Partial application.
      +
      static <A,B> F1W<A,B>lift(F<A,B> f) +
      Lifts the function into the fully featured function wrapper
      +
      F1W<A,List<B>>listK() +
      Promotes this function so that it returns its result in a List.
      +
      <C> F1W<A,C>map(F<B,C> f) 
      F1W<Array<A>,Array<B>>mapArray() +
      Promotes this function to map over a Array.
      +
      F1W<P2<A,A>,P2<B,B>>mapBoth() +
      Promotes this function to map over both elements of a pair.
      +
      <X> F1W<Validation<A,X>,Validation<B,X>>mapFail() +
      Promotes this function to map over the failure side of a Validation.
      +
      <C> F1W<P2<A,C>,P2<B,C>>mapFst() +
      Promotes this function to map over the first element of a pair.
      +
      F1W<java.lang.Iterable<A>,IterableW<B>>mapIterable() +
      Promotes this function to map over Iterables.
      +
      java.util.concurrent.ArrayBlockingQueue<B>mapJ(java.util.concurrent.ArrayBlockingQueue<A> as) +
      Maps this function over an ArrayBlockingQueue.
      +
      java.util.ArrayList<B>mapJ(java.util.ArrayList<A> as) +
      Maps this function over an ArrayList.
      +
      java.util.concurrent.ConcurrentLinkedQueue<B>mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as) +
      Maps this function over a ConcurrentLinkedQueue.
      +
      java.util.concurrent.CopyOnWriteArrayList<B>mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as) +
      Maps this function over a CopyOnWriteArrayList.
      +
      java.util.concurrent.CopyOnWriteArraySet<B>mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as) +
      Maps this function over a CopyOnWriteArraySet.
      +
      java.util.concurrent.LinkedBlockingQueue<B>mapJ(java.util.concurrent.LinkedBlockingQueue<A> as) +
      Maps this function over a LinkedBlockingQueue.
      +
      java.util.LinkedList<B>mapJ(java.util.LinkedList<A> as) +
      Maps this function over a LinkedList.
      +
      java.util.concurrent.PriorityBlockingQueue<B>mapJ(java.util.concurrent.PriorityBlockingQueue<A> as) +
      Maps this function over a PriorityBlockingQueue.
      +
      java.util.PriorityQueue<B>mapJ(java.util.PriorityQueue<A> as) +
      Maps this function over a PriorityQueue.
      +
      java.util.concurrent.SynchronousQueue<B>mapJ(java.util.concurrent.SynchronousQueue<A> as) +
      Maps this function over a SynchronousQueue.
      +
      java.util.TreeSet<B>mapJ(java.util.TreeSet<A> as) +
      Maps this function over a TreeSet.
      +
      <X> F1W<Either<A,X>,Either<B,X>>mapLeft() +
      Promotes this function to map over the left side of an Either.
      +
      F1W<List<A>,List<B>>mapList() +
      Promotes this function to map over a List.
      +
      F1W<NonEmptyList<A>,NonEmptyList<B>>mapNel() +
      Promotes this function to map over a NonEmptyList.
      +
      F1W<Option<A>,Option<B>>mapOption() +
      Promotes this function to map over an optional value.
      +
      F1W<P1<A>,P1<B>>mapP1() +
      Promotes this function to map over a product-1.
      +
      F1W<Promise<A>,Promise<B>>mapPromise() +
      Promotes this function to map over a Promise.
      +
      <X> F1W<Either<X,A>,Either<X,B>>mapRight() +
      Promotes this function to map over the right side of an Either.
      +
      F1W<Set<A>,Set<B>>mapSet(Ord<B> o) +
      Promotes this function to map over a Set.
      +
      <C> F1W<P2<C,A>,P2<C,B>>mapSnd() +
      Promotes this function to map over the second element of a pair.
      +
      F1W<Stream<A>,Stream<B>>mapStream() +
      Promotes this function to map over a Stream.
      +
      <X> F1W<Validation<X,A>,Validation<X,B>>mapSuccess() +
      Promotes this function to map over the success side of a Validation.
      +
      F1W<Tree<A>,Tree<B>>mapTree() +
      Promotes this function to map over a Tree.
      +
      F1W<TreeZipper<A>,TreeZipper<B>>mapTreeZipper() +
      Promotes this function to map over a TreeZipper.
      +
      F1W<Zipper<A>,Zipper<B>>mapZipper() +
      Promotes this function to map over a Zipper.
      +
      F1W<A,NonEmptyList<B>>nelK() +
      Promotes this function to return its value in a NonEmptyList.
      +
      <C> F1W<F<C,A>,F<C,B>>o() +
      First-class function composition
      +
      <C> F1W<C,B>o(F<C,A> g) +
      Function composition
      +
      <C> F1W<F<B,F<B,C>>,F<A,F<A,C>>>on() +
      Applies this function over the arguments of another function.
      +
      <C> F1W<A,F<A,C>>on(F<B,F<B,C>> g) +
      Applies this function over the arguments of another function.
      +
      F1W<Validation<B,A>,B>onFail() +
      Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
      +
      F1W<Either<B,A>,B>onLeft() +
      Returns a function that returns the left side of a given Either, or this function applied to the right side.
      +
      F1W<Either<A,B>,B>onRight() +
      Returns a function that returns the right side of a given Either, or this function applied to the left side.
      +
      F1W<Validation<A,B>,B>onSuccess() +
      Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
      +
      F1W<A,Option<B>>optionK() +
      Promotes this function so that it returns its result in an Option.
      +
      F1W<A,Promise<B>>promiseK(Strategy<Unit> s) +
      Promotes this function to a concurrent function that returns a Promise of a value.
      +
      F1W<A,Set<B>>setK(Ord<B> o) +
      Promotes this function to return its value in a Set.
      +
      F1W<A,Stream<B>>streamK() +
      Promotes this function so that it returns its result in a Stream.
      +
      <C> F1W<A,Validation<C,B>>successK() +
      Promotes this function so that it returns its result on the success side of an Validation.
      +
      F1W<A,Tree<B>>treeK() +
      Promotes this function to return its value in a Tree.
      +
      F1W<A,TreeZipper<B>>treeZipperK() +
      Promotes this function to return its value in a TreeZipper.
      +
      F1W<A,Zipper<B>>zipperK() +
      Promotes this function to return its value in a Zipper.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F1W

        +
        public F1W()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        o

        +
        public final <C> F1W<C,B> o(F<C,A> g)
        +
        Function composition
        +
        +
        Parameters:
        +
        g - A function to compose with this one.
        +
        Returns:
        +
        The composed function such that this function is applied last.
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        public final <C> F1W<F<C,A>,F<C,B>> o()
        +
        First-class function composition
        +
        +
        Returns:
        +
        A function that composes this function with another.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> F1W<A,C> andThen(F<B,C> g)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function with which to compose this one.
        +
        Returns:
        +
        The composed function such that this function is applied first.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> F1W<F<B,C>,F<A,C>> andThen()
        +
        First-class composition flipped.
        +
        +
        Returns:
        +
        A function that invokes this function and then a given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <C> F1W<A,C> bind(F<B,F<A,C>> g)
        +
        Binds a given function across this function (Reader Monad).
        +
        +
        Parameters:
        +
        g - A function that takes the return value of this function as an argument, yielding a new function.
        +
        Returns:
        +
        A function that invokes this function on its argument and then the given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <C> F1W<F<B,F<A,C>>,F<A,C>> bind()
        +
        First-class function binding.
        +
        +
        Returns:
        +
        A function that binds another function across this function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <C> F1W<A,C> apply(F<A,F<B,C>> g)
        +
        Function application in an environment (Applicative Functor).
        +
        +
        Parameters:
        +
        g - A function with the same argument type as this function, yielding a function that takes the return + value of this function.
        +
        Returns:
        +
        A new function that invokes the given function on its argument, yielding a new function that is then + applied to the result of applying this function to the argument.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <C> F1W<F<A,F<B,C>>,F<A,C>> apply()
        +
        First-class function application in an environment.
        +
        +
        Returns:
        +
        A function that applies a given function within the environment of this function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final <C> F1W<A,F<A,C>> on(F<B,F<B,C>> g)
        +
        Applies this function over the arguments of another function.
        +
        +
        Parameters:
        +
        g - The function over whose arguments to apply this function.
        +
        Returns:
        +
        A new function that invokes this function on its arguments before invoking the given function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final <C> F1W<F<B,F<B,C>>,F<A,F<A,C>>> on()
        +
        Applies this function over the arguments of another function.
        +
        +
        Returns:
        +
        A function that applies this function over the arguments of another function.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public final F1W<A,P1<B>> lazy()
        +
        Promotes this function so that it returns its result in a product-1. Kleisli arrow for P1.
        +
        +
        Returns:
        +
        This function promoted to return its result in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        lazy

        +
        public final P1<B> lazy(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument to return a lazy value.
        +
        +
        • +
      + + + +
        +
      • +

        mapP1

        +
        public final F1W<P1<A>,P1<B>> mapP1()
        +
        Promotes this function to map over a product-1.
        +
        +
        Returns:
        +
        This function promoted to map over a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        optionK

        +
        public final F1W<A,Option<B>> optionK()
        +
        Promotes this function so that it returns its result in an Option. Kleisli arrow for Option.
        +
        +
        Returns:
        +
        This function promoted to return its result in an Option.
        +
        +
        • +
      + + + +
        +
      • +

        mapOption

        +
        public final F1W<Option<A>,Option<B>> mapOption()
        +
        Promotes this function to map over an optional value.
        +
        +
        Returns:
        +
        This function promoted to map over an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        listK

        +
        public final F1W<A,List<B>> listK()
        +
        Promotes this function so that it returns its result in a List. Kleisli arrow for List.
        +
        +
        Returns:
        +
        This function promoted to return its result in a List.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public final F1W<List<A>,List<B>> mapList()
        +
        Promotes this function to map over a List.
        +
        +
        Returns:
        +
        This function promoted to map over a List.
        +
        +
        • +
      + + + +
        +
      • +

        streamK

        +
        public final F1W<A,Stream<B>> streamK()
        +
        Promotes this function so that it returns its result in a Stream. Kleisli arrow for Stream.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public final F1W<Stream<A>,Stream<B>> mapStream()
        +
        Promotes this function to map over a Stream.
        +
        +
        Returns:
        +
        This function promoted to map over a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        arrayK

        +
        public final F1W<A,Array<B>> arrayK()
        +
        Promotes this function so that it returns its result in a Array. Kleisli arrow for Array.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Array.
        +
        +
        • +
      + + + +
        +
      • +

        mapArray

        +
        public final F1W<Array<A>,Array<B>> mapArray()
        +
        Promotes this function to map over a Array.
        +
        +
        Returns:
        +
        This function promoted to map over a Array.
        +
        +
        • +
      + + + +
        +
      • +

        contramapActor

        +
        public final F1W<Actor<B>,Actor<A>> contramapActor()
        +
        Returns a function that contramaps over a given actor.
        +
        +
        Returns:
        +
        A function that contramaps over a given actor.
        +
        +
        • +
      + + + +
        +
      • +

        promiseK

        +
        public final F1W<A,Promise<B>> promiseK(Strategy<Unit> s)
        +
        Promotes this function to a concurrent function that returns a Promise of a value.
        +
        +
        Parameters:
        +
        s - A parallel strategy for concurrent execution.
        +
        Returns:
        +
        A concurrent function that returns a Promise of a value.
        +
        +
        • +
      + + + +
        +
      • +

        mapPromise

        +
        public final F1W<Promise<A>,Promise<B>> mapPromise()
        +
        Promotes this function to map over a Promise.
        +
        +
        Returns:
        +
        This function promoted to map over Promises.
        +
        +
        • +
      + + + +
        +
      • +

        eitherLeftK

        +
        public final <C> F1W<A,Either<B,C>> eitherLeftK()
        +
        Promotes this function so that it returns its result on the left side of an Either. + Kleisli arrow for the Either left projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        eitherRightK

        +
        public final <C> F1W<A,Either<C,B>> eitherRightK()
        +
        Promotes this function so that it returns its result on the right side of an Either. + Kleisli arrow for the Either right projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapLeft

        +
        public final <X> F1W<Either<A,X>,Either<B,X>> mapLeft()
        +
        Promotes this function to map over the left side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapRight

        +
        public final <X> F1W<Either<X,A>,Either<X,B>> mapRight()
        +
        Promotes this function to map over the right side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        onLeft

        +
        public final F1W<Either<B,A>,B> onLeft()
        +
        Returns a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        Returns:
        +
        a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        • +
      + + + +
        +
      • +

        onRight

        +
        public final F1W<Either<A,B>,B> onRight()
        +
        Returns a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        Returns:
        +
        a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        • +
      + + + +
        +
      • +

        iterableK

        +
        public final F1W<A,IterableW<B>> iterableK()
        +
        Promotes this function to return its value in an Iterable.
        +
        +
        Returns:
        +
        This function promoted to return its value in an Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        mapIterable

        +
        public final F1W<java.lang.Iterable<A>,IterableW<B>> mapIterable()
        +
        Promotes this function to map over Iterables.
        +
        +
        Returns:
        +
        This function promoted to map over Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        nelK

        +
        public final F1W<A,NonEmptyList<B>> nelK()
        +
        Promotes this function to return its value in a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to return its value in a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        mapNel

        +
        public final F1W<NonEmptyList<A>,NonEmptyList<B>> mapNel()
        +
        Promotes this function to map over a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to map over a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        setK

        +
        public final F1W<A,Set<B>> setK(Ord<B> o)
        +
        Promotes this function to return its value in a Set.
        +
        +
        Parameters:
        +
        o - An order for the set.
        +
        Returns:
        +
        This function promoted to return its value in a Set.
        +
        +
        • +
      + + + +
        +
      • +

        mapSet

        +
        public final F1W<Set<A>,Set<B>> mapSet(Ord<B> o)
        +
        Promotes this function to map over a Set.
        +
        +
        Parameters:
        +
        o - An order for the resulting set.
        +
        Returns:
        +
        This function promoted to map over a Set.
        +
        +
        • +
      + + + +
        +
      • +

        treeK

        +
        public final F1W<A,Tree<B>> treeK()
        +
        Promotes this function to return its value in a Tree.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        mapTree

        +
        public final F1W<Tree<A>,Tree<B>> mapTree()
        +
        Promotes this function to map over a Tree.
        +
        +
        Returns:
        +
        This function promoted to map over a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapTree

        +
        public final F1W<Tree<A>,B> foldMapTree(Monoid<B> m)
        +
        Returns a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        Parameters:
        +
        m - The monoid with which to fold the mapped tree.
        +
        Returns:
        +
        a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperK

        +
        public final F1W<A,TreeZipper<B>> treeZipperK()
        +
        Promotes this function to return its value in a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapTreeZipper

        +
        public final F1W<TreeZipper<A>,TreeZipper<B>> mapTreeZipper()
        +
        Promotes this function to map over a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to map over a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        failK

        +
        public final <C> F1W<A,Validation<B,C>> failK()
        +
        Promotes this function so that it returns its result on the failure side of a Validation. + Kleisli arrow for the Validation failure projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        successK

        +
        public final <C> F1W<A,Validation<C,B>> successK()
        +
        Promotes this function so that it returns its result on the success side of an Validation. + Kleisli arrow for the Validation success projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the success side of an Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapFail

        +
        public final <X> F1W<Validation<A,X>,Validation<B,X>> mapFail()
        +
        Promotes this function to map over the failure side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapSuccess

        +
        public final <X> F1W<Validation<X,A>,Validation<X,B>> mapSuccess()
        +
        Promotes this function to map over the success side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the success side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        onFail

        +
        public final F1W<Validation<B,A>,B> onFail()
        +
        Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        Returns:
        +
        a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        public final F1W<Validation<A,B>,B> onSuccess()
        +
        Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        Returns:
        +
        a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        • +
      + + + +
        +
      • +

        zipperK

        +
        public final F1W<A,Zipper<B>> zipperK()
        +
        Promotes this function to return its value in a Zipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapZipper

        +
        public final F1W<Zipper<A>,Zipper<B>> mapZipper()
        +
        Promotes this function to map over a Zipper.
        +
        +
        Returns:
        +
        This function promoted to map over a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        contramapEqual

        +
        public final F1W<Equal<B>,Equal<A>> contramapEqual()
        +
        Promotes this function to map over an Equal as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over an Equal as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapHash

        +
        public final F1W<Hash<B>,Hash<A>> contramapHash()
        +
        Promotes this function to map over a Hash as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Hash as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapShow

        +
        public final F1W<Show<B>,Show<A>> contramapShow()
        +
        Promotes this function to map over a Show as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Show as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        mapFst

        +
        public final <C> F1W<P2<A,C>,P2<B,C>> mapFst()
        +
        Promotes this function to map over the first element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the first element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapSnd

        +
        public final <C> F1W<P2<C,A>,P2<C,B>> mapSnd()
        +
        Promotes this function to map over the second element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the second element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapBoth

        +
        public final F1W<P2<A,A>,P2<B,B>> mapBoth()
        +
        Promotes this function to map over both elements of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over both elements of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.SynchronousQueue<B> mapJ(java.util.concurrent.SynchronousQueue<A> as)
        +
        Maps this function over a SynchronousQueue.
        +
        +
        Parameters:
        +
        as - A SynchronousQueue to map this function over.
        +
        Returns:
        +
        A new SynchronousQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.PriorityBlockingQueue<B> mapJ(java.util.concurrent.PriorityBlockingQueue<A> as)
        +
        Maps this function over a PriorityBlockingQueue.
        +
        +
        Parameters:
        +
        as - A PriorityBlockingQueue to map this function over.
        +
        Returns:
        +
        A new PriorityBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.LinkedBlockingQueue<B> mapJ(java.util.concurrent.LinkedBlockingQueue<A> as)
        +
        Maps this function over a LinkedBlockingQueue.
        +
        +
        Parameters:
        +
        as - A LinkedBlockingQueue to map this function over.
        +
        Returns:
        +
        A new LinkedBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.CopyOnWriteArraySet<B> mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as)
        +
        Maps this function over a CopyOnWriteArraySet.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArraySet to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArraySet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.CopyOnWriteArrayList<B> mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as)
        +
        Maps this function over a CopyOnWriteArrayList.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArrayList to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.ConcurrentLinkedQueue<B> mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as)
        +
        Maps this function over a ConcurrentLinkedQueue.
        +
        +
        Parameters:
        +
        as - A ConcurrentLinkedQueue to map this function over.
        +
        Returns:
        +
        A new ConcurrentLinkedQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.concurrent.ArrayBlockingQueue<B> mapJ(java.util.concurrent.ArrayBlockingQueue<A> as)
        +
        Maps this function over an ArrayBlockingQueue.
        +
        +
        Parameters:
        +
        as - An ArrayBlockingQueue to map this function over.
        +
        Returns:
        +
        A new ArrayBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.TreeSet<B> mapJ(java.util.TreeSet<A> as)
        +
        Maps this function over a TreeSet.
        +
        +
        Parameters:
        +
        as - A TreeSet to map this function over.
        +
        Returns:
        +
        A new TreeSet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.PriorityQueue<B> mapJ(java.util.PriorityQueue<A> as)
        +
        Maps this function over a PriorityQueue.
        +
        +
        Parameters:
        +
        as - A PriorityQueue to map this function over.
        +
        Returns:
        +
        A new PriorityQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.LinkedList<B> mapJ(java.util.LinkedList<A> as)
        +
        Maps this function over a LinkedList.
        +
        +
        Parameters:
        +
        as - A LinkedList to map this function over.
        +
        Returns:
        +
        A new LinkedList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        public final java.util.ArrayList<B> mapJ(java.util.ArrayList<A> as)
        +
        Maps this function over an ArrayList.
        +
        +
        Parameters:
        +
        as - An ArrayList to map this function over.
        +
        Returns:
        +
        A new ArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <C> F1W<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <C> F1W<C,B> contramap(F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B> F1W<A,B> lift(F<A,B> f)
        +
        Lifts the function into the fully featured function wrapper
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F2.html b/javadoc/4.8.1/functionaljava/fj/F2.html new file mode 100644 index 0000000..fd9a7a5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F2.html @@ -0,0 +1,239 @@ + + + + + +F2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F2<A,B,C>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F2W, F2W.F2WFunc
    +
    +
    +
    +
    public interface F2<A,B,C>
    +
    A transformation function of arity-2 from A and B to C. + This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
        +
        Transform A and B to C.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F2Functions.html b/javadoc/4.8.1/functionaljava/fj/F2Functions.html new file mode 100644 index 0000000..cd9ad95 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F2Functions.html @@ -0,0 +1,742 @@ + + + + + +F2Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F2Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F2Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F2<Array<A>,Array<B>,Array<C>>arrayM(F2<A,B,C> f) +
      Promotes this function to a function on Arrays.
      +
      static <A,B,C,X,Y>
      F2<X,Y,C>      		contramap(F2<A,B,C> target, + F<X,A> f, + F<Y,B> g) 
      static <A,B,C,Z> F2<Z,B,C>contramapFirst(F2<A,B,C> target, + F<Z,A> f) 
      static <A,B,C,Z> F2<A,Z,C>contramapSecond(F2<A,B,C> target, + F<Z,B> f) 
      static <A,B,C> F<A,F<B,C>>curry(F2<A,B,C> f) +
      Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
      +
      static <A,B,C> F<B,C>f(F2<A,B,C> f, + A a) +
      Partial application.
      +
      static <A,B,C> F2<B,A,C>flip(F2<A,B,C> f) +
      Flips the arguments of this function.
      +
      static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>>iterableM(F2<A,B,C> f) +
      Promotes this function to a function on Iterables.
      +
      static <A,B,C> F2<List<A>,List<B>,List<C>>listM(F2<A,B,C> f) +
      Promotes this function to a function on Lists.
      +
      static <A,B,C,Z> F2<A,B,Z>map(F2<A,B,C> target, + F<C,Z> f) 
      static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>nelM(F2<A,B,C> f) +
      Promotes this function to a function on non-empty lists.
      +
      static <A,B,C> F2<Option<A>,Option<B>,Option<C>>optionM(F2<A,B,C> f) +
      Promotes this function to a function on Options.
      +
      static <A,B,C> F2<Promise<A>,Promise<B>,Promise<C>>promiseM(F2<A,B,C> f) +
      Promotes this function to a function on Promises.
      +
      static <A,B,C> F2<Set<A>,Set<B>,Set<C>>setM(F2<A,B,C> f, + Ord<C> o) +
      Promotes this function to a function on Sets.
      +
      static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>>streamM(F2<A,B,C> f) +
      Promotes this function to a function on Streams.
      +
      static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>>treeM(F2<A,B,C> f) +
      Promotes this function to a function on Trees.
      +
      static <A,B,C> F<P2<A,B>,C>tuple(F2<A,B,C> f) +
      Uncurries this function to a function on tuples.
      +
      static <A,B,C> F2<Array<A>,Array<B>,Array<C>>zipArrayM(F2<A,B,C> f) +
      Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
      +
      static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>>zipIterableM(F2<A,B,C> f) +
      Promotes this function to zip two iterables, applying the function lock-step over both iterables.
      +
      static <A,B,C> F2<List<A>,List<B>,List<C>>zipListM(F2<A,B,C> f) +
      Promotes this function to zip two lists, applying the function lock-step over both lists.
      +
      static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>>zipNelM(F2<A,B,C> f) +
      Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
      +
      static <A,B,C> F2<Set<A>,Set<B>,Set<C>>zipSetM(F2<A,B,C> f, + Ord<C> o) +
      Promotes this function to zip two sets, applying the function lock-step over both sets.
      +
      static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>>zipStreamM(F2<A,B,C> f) +
      Promotes this function to zip two streams, applying the function lock-step over both streams.
      +
      static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>>zipTreeM(F2<A,B,C> f) +
      Promotes this function to zip two trees, applying the function lock-step over both trees.
      +
      static <A,B,C> F2<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>>zipTreeZipperM(F2<A,B,C> f) +
      Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
      +
      static <A,B,C> F2<Zipper<A>,Zipper<B>,Zipper<C>>zipZipperM(F2<A,B,C> f) +
      Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C> F<B,C> f(F2<A,B,C> f,
+                               A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
        +
        Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        Returns:
        +
        a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
        +
        Flips the arguments of this function.
        +
        +
        Returns:
        +
        A new function with the arguments of this function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
        +
        Uncurries this function to a function on tuples.
        +
        +
        Returns:
        +
        A new function that calls this function with the elements of a given tuple.
        +
        +
        • +
      + + + +
        +
      • +

        arrayM

        +
        public static <A,B,C> F2<Array<A>,Array<B>,Array<C>> arrayM(F2<A,B,C> f)
        +
        Promotes this function to a function on Arrays.
        +
        +
        Returns:
        +
        This function promoted to transform Arrays.
        +
        +
        • +
      + + + +
        +
      • +

        promiseM

        +
        public static <A,B,C> F2<Promise<A>,Promise<B>,Promise<C>> promiseM(F2<A,B,C> f)
        +
        Promotes this function to a function on Promises.
        +
        +
        Returns:
        +
        This function promoted to transform Promises.
        +
        +
        • +
      + + + +
        +
      • +

        iterableM

        +
        public static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>> iterableM(F2<A,B,C> f)
        +
        Promotes this function to a function on Iterables.
        +
        +
        Returns:
        +
        This function promoted to transform Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        listM

        +
        public static <A,B,C> F2<List<A>,List<B>,List<C>> listM(F2<A,B,C> f)
        +
        Promotes this function to a function on Lists.
        +
        +
        Returns:
        +
        This function promoted to transform Lists.
        +
        +
        • +
      + + + +
        +
      • +

        nelM

        +
        public static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> nelM(F2<A,B,C> f)
        +
        Promotes this function to a function on non-empty lists.
        +
        +
        Returns:
        +
        This function promoted to transform non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionM

        +
        public static <A,B,C> F2<Option<A>,Option<B>,Option<C>> optionM(F2<A,B,C> f)
        +
        Promotes this function to a function on Options.
        +
        +
        Returns:
        +
        This function promoted to transform Options.
        +
        +
        • +
      + + + +
        +
      • +

        setM

        +
        public static <A,B,C> F2<Set<A>,Set<B>,Set<C>> setM(F2<A,B,C> f,
+                                                    Ord<C> o)
        +
        Promotes this function to a function on Sets.
        +
        +
        Parameters:
        +
        o - An ordering for the result of the promoted function.
        +
        Returns:
        +
        This function promoted to transform Sets.
        +
        +
        • +
      + + + +
        +
      • +

        streamM

        +
        public static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>> streamM(F2<A,B,C> f)
        +
        Promotes this function to a function on Streams.
        +
        +
        Returns:
        +
        This function promoted to transform Streams.
        +
        +
        • +
      + + + +
        +
      • +

        treeM

        +
        public static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>> treeM(F2<A,B,C> f)
        +
        Promotes this function to a function on Trees.
        +
        +
        Returns:
        +
        This function promoted to transform Trees.
        +
        +
        • +
      + + + +
        +
      • +

        zipArrayM

        +
        public static <A,B,C> F2<Array<A>,Array<B>,Array<C>> zipArrayM(F2<A,B,C> f)
        +
        Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
        +
        +
        Returns:
        +
        A function that zips two arrays with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipIterableM

        +
        public static <A,B,C> F2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>> zipIterableM(F2<A,B,C> f)
        +
        Promotes this function to zip two iterables, applying the function lock-step over both iterables.
        +
        +
        Returns:
        +
        A function that zips two iterables with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipListM

        +
        public static <A,B,C> F2<List<A>,List<B>,List<C>> zipListM(F2<A,B,C> f)
        +
        Promotes this function to zip two lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipStreamM

        +
        public static <A,B,C> F2<Stream<A>,Stream<B>,Stream<C>> zipStreamM(F2<A,B,C> f)
        +
        Promotes this function to zip two streams, applying the function lock-step over both streams.
        +
        +
        Returns:
        +
        A function that zips two streams with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipNelM

        +
        public static <A,B,C> F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> zipNelM(F2<A,B,C> f)
        +
        Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two non-empty lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipSetM

        +
        public static <A,B,C> F2<Set<A>,Set<B>,Set<C>> zipSetM(F2<A,B,C> f,
+                                                       Ord<C> o)
        +
        Promotes this function to zip two sets, applying the function lock-step over both sets.
        +
        +
        Parameters:
        +
        o - An ordering for the resulting set.
        +
        Returns:
        +
        A function that zips two sets with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeM

        +
        public static <A,B,C> F2<Tree<A>,Tree<B>,Tree<C>> zipTreeM(F2<A,B,C> f)
        +
        Promotes this function to zip two trees, applying the function lock-step over both trees. + The structure of the resulting tree is the structural intersection of the two trees.
        +
        +
        Returns:
        +
        A function that zips two trees with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipZipperM

        +
        public static <A,B,C> F2<Zipper<A>,Zipper<B>,Zipper<C>> zipZipperM(F2<A,B,C> f)
        +
        Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. + The structure of the resulting zipper is the structural intersection of the two zippers.
        +
        +
        Returns:
        +
        A function that zips two zippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeZipperM

        +
        public static <A,B,C> F2<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>> zipTreeZipperM(F2<A,B,C> f)
        +
        Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Returns:
        +
        A function that zips two TreeZippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        contramapFirst

        +
        public static <A,B,C,Z> F2<Z,B,C> contramapFirst(F2<A,B,C> target,
+                                                 F<Z,A> f)
        +
        • +
      + + + +
        +
      • +

        contramapSecond

        +
        public static <A,B,C,Z> F2<A,Z,C> contramapSecond(F2<A,B,C> target,
+                                                  F<Z,B> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B,C,X,Y> F2<X,Y,C> contramap(F2<A,B,C> target,
+                                              F<X,A> f,
+                                              F<Y,B> g)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B,C,Z> F2<A,B,Z> map(F2<A,B,C> target,
+                                      F<C,Z> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F2W.F2WFunc.html b/javadoc/4.8.1/functionaljava/fj/F2W.F2WFunc.html new file mode 100644 index 0000000..a43ea39 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F2W.F2WFunc.html @@ -0,0 +1,319 @@ + + + + + +F2W.F2WFunc (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F2W.F2WFunc<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2W<A,B,C>
      • +
    • +
        +
      • fj.F2W.F2WFunc<A,B,C>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F2<A,B,C>
    +
    +
    +
    Enclosing class:
    +
    F2W<A,B,C>
    +
    +
    +
    +
    public static class F2W.F2WFunc<A,B,C>
+extends F2W<A,B,C>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F2WFunc

        +
        public F2WFunc(F2<A,B,C> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final C f(A a,
+                 B b)
        +
        Description copied from interface: F2
        +
        Transform A and B to C.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F2W.html b/javadoc/4.8.1/functionaljava/fj/F2W.html new file mode 100644 index 0000000..193826d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F2W.html @@ -0,0 +1,813 @@ + + + + + +F2W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class F2W<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F2W<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F2<A,B,C>
    +
    +
    +
    Direct Known Subclasses:
    +
    F2W.F2WFunc
    +
    +
    +
    +
    public abstract class F2W<A,B,C>
+extends java.lang.Object
+implements F2<A,B,C>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F2W

        +
        public F2W()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public final F1W<B,C> f(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public final F1W<A,F<B,C>> curry()
        +
        Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        Returns:
        +
        a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public final F2W<B,A,C> flip()
        +
        Flips the arguments of this function.
        +
        +
        Returns:
        +
        A new function with the arguments of this function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public final F1W<P2<A,B>,C> tuple()
        +
        Uncurries this function to a function on tuples.
        +
        +
        Returns:
        +
        A new function that calls this function with the elements of a given tuple.
        +
        +
        • +
      + + + +
        +
      • +

        arrayM

        +
        public final F2W<Array<A>,Array<B>,Array<C>> arrayM()
        +
        Promotes this function to a function on Arrays.
        +
        +
        Returns:
        +
        This function promoted to transform Arrays.
        +
        +
        • +
      + + + +
        +
      • +

        promiseM

        +
        public final F2W<Promise<A>,Promise<B>,Promise<C>> promiseM()
        +
        Promotes this function to a function on Promises.
        +
        +
        Returns:
        +
        This function promoted to transform Promises.
        +
        +
        • +
      + + + +
        +
      • +

        iterableM

        +
        public final F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>> iterableM()
        +
        Promotes this function to a function on Iterables.
        +
        +
        Returns:
        +
        This function promoted to transform Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        listM

        +
        public final F2W<List<A>,List<B>,List<C>> listM()
        +
        Promotes this function to a function on Lists.
        +
        +
        Returns:
        +
        This function promoted to transform Lists.
        +
        +
        • +
      + + + +
        +
      • +

        nelM

        +
        public final F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> nelM()
        +
        Promotes this function to a function on non-empty lists.
        +
        +
        Returns:
        +
        This function promoted to transform non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionM

        +
        public final F2W<Option<A>,Option<B>,Option<C>> optionM()
        +
        Promotes this function to a function on Options.
        +
        +
        Returns:
        +
        This function promoted to transform Options.
        +
        +
        • +
      + + + +
        +
      • +

        setM

        +
        public final F2W<Set<A>,Set<B>,Set<C>> setM(Ord<C> o)
        +
        Promotes this function to a function on Sets.
        +
        +
        Parameters:
        +
        o - An ordering for the result of the promoted function.
        +
        Returns:
        +
        This function promoted to transform Sets.
        +
        +
        • +
      + + + +
        +
      • +

        streamM

        +
        public final F2W<Stream<A>,Stream<B>,Stream<C>> streamM()
        +
        Promotes this function to a function on Streams.
        +
        +
        Returns:
        +
        This function promoted to transform Streams.
        +
        +
        • +
      + + + +
        +
      • +

        treeM

        +
        public final F2W<Tree<A>,Tree<B>,Tree<C>> treeM()
        +
        Promotes this function to a function on Trees.
        +
        +
        Returns:
        +
        This function promoted to transform Trees.
        +
        +
        • +
      + + + +
        +
      • +

        zipArrayM

        +
        public final F2W<Array<A>,Array<B>,Array<C>> zipArrayM()
        +
        Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
        +
        +
        Returns:
        +
        A function that zips two arrays with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipIterableM

        +
        public final F2W<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>> zipIterableM()
        +
        Promotes this function to zip two iterables, applying the function lock-step over both iterables.
        +
        +
        Returns:
        +
        A function that zips two iterables with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipListM

        +
        public final F2W<List<A>,List<B>,List<C>> zipListM()
        +
        Promotes this function to zip two lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipStreamM

        +
        public final F2W<Stream<A>,Stream<B>,Stream<C>> zipStreamM()
        +
        Promotes this function to zip two streams, applying the function lock-step over both streams.
        +
        +
        Returns:
        +
        A function that zips two streams with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipNelM

        +
        public final F2W<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> zipNelM()
        +
        Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two non-empty lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipSetM

        +
        public final F2W<Set<A>,Set<B>,Set<C>> zipSetM(Ord<C> o)
        +
        Promotes this function to zip two sets, applying the function lock-step over both sets.
        +
        +
        Parameters:
        +
        o - An ordering for the resulting set.
        +
        Returns:
        +
        A function that zips two sets with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeM

        +
        public final F2W<Tree<A>,Tree<B>,Tree<C>> zipTreeM()
        +
        Promotes this function to zip two trees, applying the function lock-step over both trees. + The structure of the resulting tree is the structural intersection of the two trees.
        +
        +
        Returns:
        +
        A function that zips two trees with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipZipperM

        +
        public final F2W<Zipper<A>,Zipper<B>,Zipper<C>> zipZipperM()
        +
        Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. + The structure of the resulting zipper is the structural intersection of the two zippers.
        +
        +
        Returns:
        +
        A function that zips two zippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeZipperM

        +
        public final F2W<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>> zipTreeZipperM()
        +
        Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Returns:
        +
        A function that zips two TreeZippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        contramapFirst

        +
        public final <Z> F2W<Z,B,C> contramapFirst(F<Z,A> f)
        +
        • +
      + + + +
        +
      • +

        contramapSecond

        +
        public final <Z> F2W<A,Z,C> contramapSecond(F<Z,B> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <X,Y> F2W<X,Y,C> contramap(F<X,A> f,
+                                        F<Y,B> g)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <Z> F2W<A,B,Z> map(F<C,Z> f)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C> F2W<A,B,C> lift(F2<A,B,C> f)
        +
        Lifts the function into the fully featured function wrapper
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F3.html b/javadoc/4.8.1/functionaljava/fj/F3.html new file mode 100644 index 0000000..3423e59 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F3.html @@ -0,0 +1,242 @@ + + + + + +F3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F3<A,B,C,D>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F3W
    +
    +
    +
    +
    public interface F3<A,B,C,D>
    +
    A transformation function of arity-3 from A, B and C to + D. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
        +
        Transform A, B and C to D.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F3Functions.html b/javadoc/4.8.1/functionaljava/fj/F3Functions.html new file mode 100644 index 0000000..27cae5a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F3Functions.html @@ -0,0 +1,249 @@ + + + + + +F3Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F3Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F3Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F3Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D> F2<B,C,D>f(F3<A,B,C,D> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D> F2<B,C,D> f(F3<A,B,C,D> f,
+                                    A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F3W.html b/javadoc/4.8.1/functionaljava/fj/F3W.html new file mode 100644 index 0000000..a9af2e7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F3W.html @@ -0,0 +1,248 @@ + + + + + +F3W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F3W<A,B,C,D>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F3W<A,B,C,D>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F3<A,B,C,D>
    +
    +
    +
    +
    public abstract class F3W<A,B,C,D>
+extends java.lang.Object
+implements F3<A,B,C,D>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F3W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F3

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F3W

        +
        public F3W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F4.html b/javadoc/4.8.1/functionaljava/fj/F4.html new file mode 100644 index 0000000..ac6e032 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F4.html @@ -0,0 +1,245 @@ + + + + + +F4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F4<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F4W
    +
    +
    +
    +
    public interface F4<A,B,C,D,E>
    +
    A transformation function of arity-4 from A, B, C and + D to E. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
        +
        Transform A, B, C and D to E.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F4Functions.html b/javadoc/4.8.1/functionaljava/fj/F4Functions.html new file mode 100644 index 0000000..2d5670a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F4Functions.html @@ -0,0 +1,249 @@ + + + + + +F4Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F4Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F4Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F4Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E>
      F3<B,C,D,E>      		f(F4<A,B,C,D,E> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E> F3<B,C,D,E> f(F4<A,B,C,D,E> f,
+                                        A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F4W.html b/javadoc/4.8.1/functionaljava/fj/F4W.html new file mode 100644 index 0000000..966b0e5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F4W.html @@ -0,0 +1,248 @@ + + + + + +F4W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F4W<A,B,C,D,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F4W<A,B,C,D,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F4<A,B,C,D,E>
    +
    +
    +
    +
    public abstract class F4W<A,B,C,D,E>
+extends java.lang.Object
+implements F4<A,B,C,D,E>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F4W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F4

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F4W

        +
        public F4W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F5.html b/javadoc/4.8.1/functionaljava/fj/F5.html new file mode 100644 index 0000000..888ab33 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F5.html @@ -0,0 +1,251 @@ + + + + + +F5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F5<A,B,C,D,E,F$>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F5W
    +
    +
    +
    +
    public interface F5<A,B,C,D,E,F$>
    +
    A transformation function of arity-5 from A, B, C, + D and E to F$. This type can be represented using the Java + 7 closure syntax.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F$ f(A a,
+     B b,
+     C c,
+     D d,
+     E e)
        +
        Transform A, B, C, D and E to + F$.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F5Functions.html b/javadoc/4.8.1/functionaljava/fj/F5Functions.html new file mode 100644 index 0000000..154a40a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F5Functions.html @@ -0,0 +1,249 @@ + + + + + +F5Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F5Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F5Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F5Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$>
      F4<B,C,D,E,F$>      		f(F5<A,B,C,D,E,F$> f, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$> F4<B,C,D,E,F$> f(F5<A,B,C,D,E,F$> f,
+                                              A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F5W.html b/javadoc/4.8.1/functionaljava/fj/F5W.html new file mode 100644 index 0000000..c9fca9e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F5W.html @@ -0,0 +1,248 @@ + + + + + +F5W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F5W<A,B,C,D,E,$F>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F5W<A,B,C,D,E,$F>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F5<A,B,C,D,E,$F>
    +
    +
    +
    +
    public abstract class F5W<A,B,C,D,E,$F>
+extends java.lang.Object
+implements F5<A,B,C,D,E,$F>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F5W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F5

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F5W

        +
        public F5W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F6.html b/javadoc/4.8.1/functionaljava/fj/F6.html new file mode 100644 index 0000000..e5d9303 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F6.html @@ -0,0 +1,254 @@ + + + + + +F6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F6<A,B,C,D,E,F$,G>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F6W
    +
    +
    +
    +
    public interface F6<A,B,C,D,E,F$,G>
    +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G. This type can be + represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Gf(A a, + B b, + C c, + D d, + E e, + F$ f) +
      Transform A, B, C, D, E and + F$ to G.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f)
        +
        Transform A, B, C, D, E and + F$ to G.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F6Functions.html b/javadoc/4.8.1/functionaljava/fj/F6Functions.html new file mode 100644 index 0000000..94b80ce --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F6Functions.html @@ -0,0 +1,249 @@ + + + + + +F6Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F6Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F6Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F6Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G>
      F5<B,C,D,E,F$,G>      		f(F6<A,B,C,D,E,F$,G> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G> F5<B,C,D,E,F$,G> f(F6<A,B,C,D,E,F$,G> func,
+                                                  A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F6W.html b/javadoc/4.8.1/functionaljava/fj/F6W.html new file mode 100644 index 0000000..189ff4f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F6W.html @@ -0,0 +1,248 @@ + + + + + +F6W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F6W<A,B,C,D,E,$F,G>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F6W<A,B,C,D,E,$F,G>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F6<A,B,C,D,E,$F,G>
    +
    +
    +
    +
    public abstract class F6W<A,B,C,D,E,$F,G>
+extends java.lang.Object
+implements F6<A,B,C,D,E,$F,G>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F6W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F6

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F6W

        +
        public F6W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F7.html b/javadoc/4.8.1/functionaljava/fj/F7.html new file mode 100644 index 0000000..2c4dc08 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F7.html @@ -0,0 +1,257 @@ + + + + + +F7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F7<A,B,C,D,E,F$,G,H>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F7W
    +
    +
    +
    +
    public interface F7<A,B,C,D,E,F$,G,H>
    +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H. This type + can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Hf(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      Transform A, B, C, D, E, + F$ and G to H.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g)
        +
        Transform A, B, C, D, E, + F$ and G to H.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F7Functions.html b/javadoc/4.8.1/functionaljava/fj/F7Functions.html new file mode 100644 index 0000000..e3700d0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F7Functions.html @@ -0,0 +1,249 @@ + + + + + +F7Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F7Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F7Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F7Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H>
      F6<B,C,D,E,F$,G,H>      		f(F7<A,B,C,D,E,F$,G,H> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G,H> F6<B,C,D,E,F$,G,H> f(F7<A,B,C,D,E,F$,G,H> func,
+                                                      A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F7W.html b/javadoc/4.8.1/functionaljava/fj/F7W.html new file mode 100644 index 0000000..d6d491f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F7W.html @@ -0,0 +1,248 @@ + + + + + +F7W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F7W<A,B,C,D,E,$F,G,H>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F7W<A,B,C,D,E,$F,G,H>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F7<A,B,C,D,E,$F,G,H>
    +
    +
    +
    +
    public abstract class F7W<A,B,C,D,E,$F,G,H>
+extends java.lang.Object
+implements F7<A,B,C,D,E,$F,G,H>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F7W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F7

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F7W

        +
        public F7W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F8.html b/javadoc/4.8.1/functionaljava/fj/F8.html new file mode 100644 index 0000000..ef0649b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F8.html @@ -0,0 +1,260 @@ + + + + + +F8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F8<A,B,C,D,E,F$,G,H,I>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    F8W
    +
    +
    +
    +
    public interface F8<A,B,C,D,E,F$,G,H,I>
    +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I. This type can be represented using the Java 7 closure syntax.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      If(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      Transform A, B, C, D, E, + F$, G and H to I.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g,
+    H h)
        +
        Transform A, B, C, D, E, + F$, G and H to I.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        h - The H to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F8Functions.html b/javadoc/4.8.1/functionaljava/fj/F8Functions.html new file mode 100644 index 0000000..c222a1d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F8Functions.html @@ -0,0 +1,247 @@ + + + + + +F8Functions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F8Functions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F8Functions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class F8Functions
+extends java.lang.Object
    +
    Created by MarkPerry on 6/04/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H,I>
      F7<B,C,D,E,F$,G,H,I>      		f(F8<A,B,C,D,E,F$,G,H,I> func, + A a) +
      Partial application.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F$,G,H,I> F7<B,C,D,E,F$,G,H,I> f(F8<A,B,C,D,E,F$,G,H,I> func,
+                                                          A a)
        +
        Partial application.
        +
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/F8W.html b/javadoc/4.8.1/functionaljava/fj/F8W.html new file mode 100644 index 0000000..58e5b4e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/F8W.html @@ -0,0 +1,248 @@ + + + + + +F8W (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class F8W<A,B,C,D,E,$F,G,H,I>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.F8W<A,B,C,D,E,$F,G,H,I>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F8<A,B,C,D,E,$F,G,H,I>
    +
    +
    +
    +
    public abstract class F8W<A,B,C,D,E,$F,G,H,I>
+extends java.lang.Object
+implements F8<A,B,C,D,E,$F,G,H,I>
    +
    Created by MarkPerry on 22/01/2015.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      F8W() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface fj.F8

        +f
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        F8W

        +
        public F8W()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Function.html b/javadoc/4.8.1/functionaljava/fj/Function.html new file mode 100644 index 0000000..4449211 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Function.html @@ -0,0 +1,2162 @@ + + + + + +Function (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Function

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Function
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Function
+extends java.lang.Object
    +
    Transformations on functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>>andThen() +
      Function composition flipped.
      +
      static <A,B,C> F<A,C>andThen(F<A,B> g, + F<B,C> f) +
      Function composition flipped.
      +
      static <A,B> F<F<A,B>,B>apply(A a) +
      Function application with the arguments flipped.
      +
      static <A,B,C> F<C,B>apply(F<C,F<A,B>> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>apply(F2<C,A,B> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>bind(F<C,A> ma, + F<A,F<C,B>> f) +
      Binds the function in the second argument to the function in the first argument.
      +
      static <A,B,C,D> F<D,C>bind(F<D,A> ca, + F<D,B> cb, + F<A,F<B,C>> f) +
      Binds the given function f to the values of the given functions, with a final join.
      +
      static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>>compose() +
      Function composition.
      +
      static <A,B,C> F<A,C>compose(F<B,C> f, + F<A,B> g) +
      Function composition.
      +
      static <A,B,C,D> F<A,F<B,D>>compose2(F<C,D> f, + F<A,F<B,C>> g) +
      Function composition.
      +
      static <A,B> F<B,F<A,B>>constant() +
      Returns a function that given an argument, returns a function that ignores its argument.
      +
      static <A,B> F<A,B>constant(B b) +
      Returns a function that ignores its argument to constantly produce the given value.
      +
      static <A,B,C> F<A,F<B,C>>curry(F2<A,B,C> f) +
      Curry a function of arity-2.
      +
      static <A,B,C> F<B,C>curry(F2<A,B,C> f, + A a) +
      Curry a function of arity-2.
      +
      static <A,B,C,D> F<A,F<B,F<C,D>>>curry(F3<A,B,C,D> f) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<B,F<C,D>>curry(F3<A,B,C,D> f, + A a) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<C,D>curry(F3<A,B,C,D> f, + A a, + B b) +
      Curry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,E>>>>      		curry(F4<A,B,C,D,E> f) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<B,F<C,F<D,E>>>      		curry(F4<A,B,C,D,E> f, + A a) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<C,F<D,E>>      		curry(F4<A,B,C,D,E> f, + A a, + B b) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<D,E>      		curry(F4<A,B,C,D,E> f, + A a, + B b, + C c) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F$>>>>>      		curry(F5<A,B,C,D,E,F$> f) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<B,F<C,F<D,F<E,F$>>>>      		curry(F5<A,B,C,D,E,F$> f, + A a) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<C,F<D,F<E,F$>>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<D,F<E,F$>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<E,F$>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>      		curry(F6<A,B,C,D,E,F$,G> f) +
      Curry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<C,F<D,F<E,F<F$,F<G,H>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<D,F<E,F<F$,F<G,H>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<E,F<F$,F<G,H>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F$,F<G,H>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<G,H>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<D,F<E,F<F$,F<G,F<H,I>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<E,F<F$,F<G,F<H,I>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F$,F<G,F<H,I>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<G,F<H,I>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<H,I>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$, + G g) +
      Curry a function of arity-7.
      +
      static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>>flip() +
      Function argument flipping.
      +
      static <A,B,C> F<B,F<A,C>>flip(F<A,F<B,C>> f) +
      Function argument flipping.
      +
      static <A,B,C> F2<B,A,C>flip(F2<A,B,C> f) +
      Function argument flipping.
      +
      static <A,B,C> F<F2<A,B,C>,F2<B,A,C>>flip2() +
      Function argument flipping.
      +
      static <A> F<A,A>identity() +
      The identity transformation.
      +
      static <A,B> F<B,A>join(F<B,F<B,A>> f) +
      Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
      +
      static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>>lift(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a higher-order function.
      +
      static <A,B> F<A,Option<B>>nullable(F<A,B> f) +
      Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
      +
      static <A,B,C> F<B,F<B,C>>on(F<A,F<A,C>> a, + F<B,A> f) +
      Applies a given function over the arguments of another function of arity-2.
      +
      static <A,B,C> F<A,C>partialApply2(F<A,F<B,C>> f, + B b) +
      Partial application of the second argument to the supplied function to get a function of type + A -> C.
      +
      static <A,B,C,D> F<A,F<B,D>>partialApply3(F<A,F<B,F<C,D>>> f, + C c) +
      Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,E>>>      		partialApply4(F<A,F<B,F<C,F<D,E>>>> f, + D d) +
      Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F$>>>>      		partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f, + E e) +
      Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,G>>>>>      		partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f, + F$ f$) +
      Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>>      		partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f, + G g) +
      Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>>      		partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f, + H h) +
      Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
      +
      static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>>uncurryF2() +
      Uncurry a function of arity-2.
      +
      static <A,B,C> F2<A,B,C>uncurryF2(F<A,F<B,C>> f) +
      Uncurry a function of arity-2.
      +
      static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>>uncurryF3() +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D> F3<A,B,C,D>uncurryF3(F<A,F<B,F<C,D>>> f) +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>>      		uncurryF4() +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E>
      F4<A,B,C,D,E>      		uncurryF4(F<A,F<B,F<C,F<D,E>>>> f) +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>>      		uncurryF5() +
      Uncurry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F5<A,B,C,D,E,F$>      		uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>>      		uncurryF6() +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F6<A,B,C,D,E,F$,G>      		uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>>      		uncurryF7() +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F7<A,B,C,D,E,F$,G,H>      		uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>>      		uncurryF8() +
      Uncurry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F8<A,B,C,D,E,F$,G,H,I>      		uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Uncurry a function of arity-8.
      +
      static <C,A extends C,B,D extends B>
      F<F<C,D>,F<A,B>>      		vary() +
      Simultaneously covaries and contravaries a function.
      +
      static <A,B> F<A,B>vary(F<? super A,? extends B> f) +
      Simultaneously covaries and contravaries a function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public static <A,B> F<F<A,B>,B> apply(A a)
        +
        Function application with the arguments flipped.
        +
        +
        Parameters:
        +
        a - The value to apply the function to.
        +
        Returns:
        +
        A function that is partially-applied to the given value.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>> compose()
        +
        Function composition.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<A,C> compose(F<B,C> f,
+                                     F<A,B> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        compose2

        +
        public static <A,B,C,D> F<A,F<B,D>> compose2(F<C,D> f,
+                                             F<A,F<B,C>> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>> andThen()
        +
        Function composition flipped.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<A,C> andThen(F<A,B> g,
+                                     F<B,C> f)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function to compose with another.
        +
        f - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        identity

        +
        public static <A> F<A,A> identity()
        +
        The identity transformation.
        +
        +
        Returns:
        +
        The identity transformation.
        +
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public static <A,B> F<B,F<A,B>> constant()
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> F<A,B> constant(B b)
        +
        Returns a function that ignores its argument to constantly produce the given value.
        +
        +
        Parameters:
        +
        b - The value to return when the returned function is applied.
        +
        Returns:
        +
        A function that ignores its argument to constantly produce the given value.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <A,B> F<A,B> vary(F<? super A,? extends B> f)
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Parameters:
        +
        f - The function to vary.
        +
        Returns:
        +
        A co- and contravariant function that invokes f on its argument.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <C,A extends C,B,D extends B> F<F<C,D>,F<A,B>> vary()
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Returns:
        +
        A function that varies and covaries a function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>> flip()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that takes a function and flips its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<B,F<A,C>> flip(F<A,F<B,C>> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip2

        +
        public static <A,B,C> F<F2<A,B,C>,F2<B,A,C>> flip2()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that flips the arguments of a given function.
        +
        +
        • +
      + + + +
        +
      • +

        nullable

        +
        public static <A,B> F<A,Option<B>> nullable(F<A,B> f)
        +
        Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        Parameters:
        +
        f - The function to check for a null argument.
        +
        Returns:
        +
        A function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<B,C> curry(F2<A,B,C> f,
+                                   A a)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>> uncurryF2()
        +
        Uncurry a function of arity-2.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F2<A,B,C> uncurryF2(F<A,F<B,C>> f)
        +
        Uncurry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<A,F<B,F<C,D>>> curry(F3<A,B,C,D> f)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<B,F<C,D>> curry(F3<A,B,C,D> f,
+                                          A a)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<C,D> curry(F3<A,B,C,D> f,
+                                     A a,
+                                     B b)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>> uncurryF3()
        +
        Uncurry a function of arity-3.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F3<A,B,C,D> uncurryF3(F<A,F<B,F<C,D>>> f)
        +
        Uncurry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,E>>>> curry(F4<A,B,C,D,E> f)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<B,F<C,F<D,E>>> curry(F4<A,B,C,D,E> f,
+                                                 A a)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<C,F<D,E>> curry(F4<A,B,C,D,E> f,
+                                            A a,
+                                            B b)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<D,E> curry(F4<A,B,C,D,E> f,
+                                       A a,
+                                       B b,
+                                       C c)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>> uncurryF4()
        +
        Uncurry a function of arity-4.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F4<A,B,C,D,E> uncurryF4(F<A,F<B,F<C,F<D,E>>>> f)
        +
        Uncurry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F$>>>>> curry(F5<A,B,C,D,E,F$> f)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<B,F<C,F<D,F<E,F$>>>> curry(F5<A,B,C,D,E,F$> f,
+                                                          A a)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<C,F<D,F<E,F$>>> curry(F5<A,B,C,D,E,F$> f,
+                                                     A a,
+                                                     B b)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<D,F<E,F$>> curry(F5<A,B,C,D,E,F$> f,
+                                                A a,
+                                                B b,
+                                                C c)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<E,F$> curry(F5<A,B,C,D,E,F$> f,
+                                           A a,
+                                           B b,
+                                           C c,
+                                           D d)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>> uncurryF5()
        +
        Uncurry a function of arity-5.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F5<A,B,C,D,E,F$> uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> curry(F6<A,B,C,D,E,F$,G> f)
        +
        Curry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>> uncurryF6()
        +
        Uncurry a function of arity-6.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F6<A,B,C,D,E,F$,G> uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                        A a)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<C,F<D,F<E,F<F$,F<G,H>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                   A a,
+                                                                   B b)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<D,F<E,F<F$,F<G,H>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                              A a,
+                                                              B b,
+                                                              C c)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<E,F<F$,F<G,H>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                         A a,
+                                                         B b,
+                                                         C c,
+                                                         D d)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<F$,F<G,H>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                    A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<G,H> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                              A a,
+                                              B b,
+                                              C c,
+                                              D d,
+                                              E e,
+                                              F$ f$)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>> uncurryF7()
        +
        Uncurry a function of arity-7.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F7<A,B,C,D,E,F$,G,H> uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Uncurry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                               A a)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                          A a,
+                                                                          B b)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<D,F<E,F<F$,F<G,F<H,I>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                     A a,
+                                                                     B b,
+                                                                     C c)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<E,F<F$,F<G,F<H,I>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                A a,
+                                                                B b,
+                                                                C c,
+                                                                D d)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F$,F<G,F<H,I>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                           A a,
+                                                           B b,
+                                                           C c,
+                                                           D d,
+                                                           E e)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<G,F<H,I>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                     A a,
+                                                     B b,
+                                                     C c,
+                                                     D d,
+                                                     E e,
+                                                     F$ f$)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<H,I> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f$,
+                                                G g)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        g - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>> uncurryF8()
        +
        Uncurry a function of arity-8.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F8<A,B,C,D,E,F$,G,H,I> uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Uncurry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<C,B> bind(F<C,A> ma,
+                                  F<A,F<C,B>> f)
        +
        Binds the function in the second argument to the function in the first argument.
        +
        +
        Parameters:
        +
        ma - A function whose argument type is the same as the argument type of the return value.
        +
        f - A function whose argument type is the same as the return type of ma, + and yields the return value.
        +
        Returns:
        +
        A function that chains the given functions together such that the result of applying + ma to the argument is given to f, yielding a function + that is applied to the argument again.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F<C,F<A,B>> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F2<C,A,B> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C,D> F<D,C> bind(F<D,A> ca,
+                                    F<D,B> cb,
+                                    F<A,F<B,C>> f)
        +
        Binds the given function f to the values of the given functions, with a final join.
        +
        +
        Parameters:
        +
        ca - A function to bind f function to.
        +
        cb - A function to bind f function to.
        +
        f - The bound function to be composed with ca and then applied with cb
        +
        Returns:
        +
        A new function after performing the composition, then application.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<B,F<B,C>> on(F<A,F<A,C>> a,
+                                     F<B,A> f)
        +
        Applies a given function over the arguments of another function of arity-2.
        +
        +
        Parameters:
        +
        a - The function whose arguments to apply another function over.
        +
        f - The function to apply over the arguments of another function.
        +
        Returns:
        +
        A function whose arguments are fed through function f, before being passed to function a.
        +
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>> lift(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a higher-order function.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to compose with two functions.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,B> F<B,A> join(F<B,F<B,A>> f)
        +
        Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
        +
        +
        Parameters:
        +
        f - A function whose arguments to join.
        +
        Returns:
        +
        A function of arity-1 whose argument is substituted for both parameters of f.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply2

        +
        public static <A,B,C> F<A,C> partialApply2(F<A,F<B,C>> f,
+                                           B b)
        +
        Partial application of the second argument to the supplied function to get a function of type + A -> C. Same as flip(f).f(b).
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        b - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its second argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply3

        +
        public static <A,B,C,D> F<A,F<B,D>> partialApply3(F<A,F<B,F<C,D>>> f,
+                                                  C c)
        +
        Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        c - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its third argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply4

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,E>>> partialApply4(F<A,F<B,F<C,F<D,E>>>> f,
+                                                         D d)
        +
        Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        d - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fourth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply5

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F$>>>> partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f,
+                                                                  E e)
        +
        Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        e - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fifth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply6

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,G>>>>> partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f,
+                                                                        F$ f$)
        +
        Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        f$ - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its sixth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply7

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>> partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f,
+                                                                                G g)
        +
        Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        g - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its seventh argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>> partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f,
+                                                                                       H h)
        +
        Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        h - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its eigth argument applied.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Hash.html b/javadoc/4.8.1/functionaljava/fj/Hash.html new file mode 100644 index 0000000..52e15e4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Hash.html @@ -0,0 +1,1264 @@ + + + + + +Hash (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Hash<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Hash<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Hash<A>
+extends java.lang.Object
    +
    Produces a hash code for an object which should attempt uniqueness.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanHash

        +
        public static final Hash<java.lang.Boolean> booleanHash
        +
        A hash instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteHash

        +
        public static final Hash<java.lang.Byte> byteHash
        +
        A hash instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charHash

        +
        public static final Hash<java.lang.Character> charHash
        +
        A hash instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleHash

        +
        public static final Hash<java.lang.Double> doubleHash
        +
        A hash instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatHash

        +
        public static final Hash<java.lang.Float> floatHash
        +
        A hash instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intHash

        +
        public static final Hash<java.lang.Integer> intHash
        +
        A hash instance for the int type.
        +
        • +
      + + + +
        +
      • +

        longHash

        +
        public static final Hash<java.lang.Long> longHash
        +
        A hash instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortHash

        +
        public static final Hash<java.lang.Short> shortHash
        +
        A hash instance for the short type.
        +
        • +
      + + + +
        +
      • +

        bigintHash

        +
        public static final Hash<java.math.BigInteger> bigintHash
        +
        A hash instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalHash

        +
        public static final Hash<java.math.BigDecimal> bigdecimalHash
        +
        A hash instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        naturalHash

        +
        public static final Hash<Natural> naturalHash
        +
        A hash instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringHash

        +
        public static final Hash<java.lang.String> stringHash
        +
        A hash instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferHash

        +
        public static final Hash<java.lang.StringBuffer> stringBufferHash
        +
        A hash instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderHash

        +
        public static final Hash<java.lang.StringBuilder> stringBuilderHash
        +
        A hash instance for the StringBuilder type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value.
        +
        +
        Parameters:
        +
        a - The value to compute the hash value for.
        +
        Returns:
        +
        The hash value.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Hash<B> contramap(F<B,A> g)
        +
        Maps the given function across this hash as a contra-variant functor.
        +
        +
        Parameters:
        +
        g - The function to map.
        +
        Returns:
        +
        A new hash.
        +
        +
        • +
      + + + +
        +
      • +

        hash

        +
        public static <A> Hash<A> hash(F<A,java.lang.Integer> f)
        +
        Construct a hash with the given hash function.
        +
        +
        Parameters:
        +
        f - The function to construct the hash with.
        +
        Returns:
        +
        A hash that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyHash

        +
        public static <A> Hash<A> anyHash()
        +
        A hash that uses Object.hashCode().
        +
        +
        Returns:
        +
        A hash that uses Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        eitherHash

        +
        public static <A,B> Hash<Either<A,B>> eitherHash(Hash<A> ha,
+                                                 Hash<B> hb)
        +
        A hash instance for the Either type.
        +
        +
        Parameters:
        +
        ha - Hash the left side of Either.
        +
        hb - Hash the right side of Either.
        +
        Returns:
        +
        A hash instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        resultHash

        +
        public static <I,A> Hash<Result<I,A>> resultHash(Hash<A> ha,
+                                                 Hash<I> hi)
        +
        A hash instance for the Result type.
        +
        +
        Parameters:
        +
        ha - Hash the Result value.
        +
        hi - Hash the Result remainder.
        +
        Returns:
        +
        A hash instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationHash

        +
        public static <A,B> Hash<Validation<A,B>> validationHash(Hash<A> ha,
+                                                         Hash<B> hb)
        +
        A hash instance for the Validation type.
        +
        +
        Parameters:
        +
        ha - Hash the failing side of Validation.
        +
        hb - Hash the succeeding side of Validation.
        +
        Returns:
        +
        A hash instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listHash

        +
        public static <A> Hash<List<A>> listHash(Hash<A> ha)
        +
        A hash instance for the List type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the list.
        +
        Returns:
        +
        A hash instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListHash

        +
        public static <A> Hash<NonEmptyList<A>> nonEmptyListHash(Hash<A> ha)
        +
        A hash instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the non-empty list.
        +
        Returns:
        +
        A hash instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionHash

        +
        public static <A> Hash<Option<A>> optionHash(Hash<A> ha)
        +
        A hash instance for the Option type.
        +
        +
        Parameters:
        +
        ha - A hash for the element of the optional value.
        +
        Returns:
        +
        A hash instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqHash

        +
        public static <A> Hash<Seq<A>> seqHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        setHash

        +
        public static <A> Hash<Set<A>> setHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        streamHash

        +
        public static <A> Hash<Stream<A>> streamHash(Hash<A> ha)
        +
        A hash instance for the Stream type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the stream.
        +
        Returns:
        +
        A hash instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayHash

        +
        public static <A> Hash<Array<A>> arrayHash(Hash<A> ha)
        +
        A hash instance for the Array type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the array.
        +
        Returns:
        +
        A hash instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperHash

        +
        public static <A> Hash<Zipper<A>> zipperHash(Hash<A> ha)
        +
        A hash instance for the Zipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the zipper.
        +
        Returns:
        +
        A hash instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperHash

        +
        public static <A> Hash<TreeZipper<A>> treeZipperHash(Hash<A> ha)
        +
        A hash instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree zipper.
        +
        Returns:
        +
        A hash instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeHash

        +
        public static <A> Hash<Tree<A>> treeHash(Hash<A> ha)
        +
        A hash instance for the Tree type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree.
        +
        Returns:
        +
        A hash instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapHash

        +
        public static <K,V> Hash<TreeMap<K,V>> treeMapHash(Hash<K> h,
+                                                   Hash<V> v)
        +
        • +
      + + + +
        +
      • +

        p1Hash

        +
        public static <A> Hash<P1<A>> p1Hash(Hash<A> ha)
        +
        A hash instance for a product-1.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        Returns:
        +
        A hash instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Hash

        +
        public static <A,B> Hash<P2<A,B>> p2Hash(Hash<A> ha,
+                                         Hash<B> hb)
        +
        A hash instance for a product-2.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        Returns:
        +
        A hash instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Hash

        +
        public static <A,B,C> Hash<P3<A,B,C>> p3Hash(Hash<A> ha,
+                                             Hash<B> hb,
+                                             Hash<C> hc)
        +
        A hash instance for a product-3.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        Returns:
        +
        A hash instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Hash

        +
        public static <A,B,C,D> Hash<P4<A,B,C,D>> p4Hash(Hash<A> ha,
+                                                 Hash<B> hb,
+                                                 Hash<C> hc,
+                                                 Hash<D> hd)
        +
        A hash instance for a product-4.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        Returns:
        +
        A hash instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Hash

        +
        public static <A,B,C,D,E> Hash<P5<A,B,C,D,E>> p5Hash(Hash<A> ha,
+                                                     Hash<B> hb,
+                                                     Hash<C> hc,
+                                                     Hash<D> hd,
+                                                     Hash<E> he)
        +
        A hash instance for a product-5.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        Returns:
        +
        A hash instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Hash

        +
        public static <A,B,C,D,E,F$> Hash<P6<A,B,C,D,E,F$>> p6Hash(Hash<A> ha,
+                                                           Hash<B> hb,
+                                                           Hash<C> hc,
+                                                           Hash<D> hd,
+                                                           Hash<E> he,
+                                                           Hash<F$> hf)
        +
        A hash instance for a product-6.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        Returns:
        +
        A hash instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Hash

        +
        public static <A,B,C,D,E,F$,G> Hash<P7<A,B,C,D,E,F$,G>> p7Hash(Hash<A> ha,
+                                                               Hash<B> hb,
+                                                               Hash<C> hc,
+                                                               Hash<D> hd,
+                                                               Hash<E> he,
+                                                               Hash<F$> hf,
+                                                               Hash<G> hg)
        +
        A hash instance for a product-7.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        Returns:
        +
        A hash instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Hash

        +
        public static <A,B,C,D,E,F$,G,H> Hash<P8<A,B,C,D,E,F$,G,H>> p8Hash(Hash<A> ha,
+                                                                   Hash<B> hb,
+                                                                   Hash<C> hc,
+                                                                   Hash<D> hd,
+                                                                   Hash<E> he,
+                                                                   Hash<F$> hf,
+                                                                   Hash<G> hg,
+                                                                   Hash<H> hh)
        +
        A hash instance for a product-8.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        hh - A hash for the eighth element of the product.
        +
        Returns:
        +
        A hash instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Hash

        +
        public static <A> Hash<V2<A>> v2Hash(Hash<A> ea)
        +
        A hash instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Hash

        +
        public static <A> Hash<V3<A>> v3Hash(Hash<A> ea)
        +
        A hash instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Hash

        +
        public static <A> Hash<V4<A>> v4Hash(Hash<A> ea)
        +
        A hash instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Hash

        +
        public static <A> Hash<V5<A>> v5Hash(Hash<A> ea)
        +
        A hash instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Hash

        +
        public static <A> Hash<V6<A>> v6Hash(Hash<A> ea)
        +
        A hash instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Hash

        +
        public static <A> Hash<V7<A>> v7Hash(Hash<A> ea)
        +
        A hash instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Hash

        +
        public static <A> Hash<V8<A>> v8Hash(Hash<A> ea)
        +
        A hash instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-8.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/LcgRng.html b/javadoc/4.8.1/functionaljava/fj/LcgRng.html new file mode 100644 index 0000000..a4c8347 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/LcgRng.html @@ -0,0 +1,330 @@ + + + + + +LcgRng (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class LcgRng

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    +
    public class LcgRng
+extends Rng
    +
    Created by MarkPerry on 7/07/2014. + + https://en.wikipedia.org/wiki/Linear_congruential_generator
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      LcgRng() 
      LcgRng(long s) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng()
        +
        • +
      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng(long s)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSeed

        +
        public final long getSeed()
        +
        • +
      + + + +
        +
      • +

        nextInt

        +
        public final P2<Rng,java.lang.Integer> nextInt()
        +
        +
        Specified by:
        +
        nextInt in class Rng
        +
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public final P2<Rng,java.lang.Long> nextLong()
        +
        +
        Specified by:
        +
        nextLong in class Rng
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Monoid.AltDefinition.html b/javadoc/4.8.1/functionaljava/fj/Monoid.AltDefinition.html new file mode 100644 index 0000000..662e220 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Monoid.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Monoid.AltDefinition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Monoid.Definition.html b/javadoc/4.8.1/functionaljava/fj/Monoid.Definition.html new file mode 100644 index 0000000..03fd9a8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Monoid.Definition.html @@ -0,0 +1,329 @@ + + + + + +Monoid.Definition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Monoid.html b/javadoc/4.8.1/functionaljava/fj/Monoid.html new file mode 100644 index 0000000..5a86f72 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Monoid.html @@ -0,0 +1,1441 @@ + + + + + +Monoid (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Monoid<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Monoid<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Monoid<A>
+extends java.lang.Object
    +
    A monoid abstraction to be defined across types of the given type argument. Implementations must + follow the monoidal laws: +
      +
    • Left Identity; forall x. sum(zero(), x) == x
      • +
    • Right Identity; forall x. sum(x, zero()) == x
      • +
    • Associativity; forall x y z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionMonoid

        +
        public static final Monoid<java.lang.Integer> intAdditionMonoid
        +
        A monoid that adds integers.
        +
        • +
      + + + +
        +
      • +

        intMultiplicationMonoid

        +
        public static final Monoid<java.lang.Integer> intMultiplicationMonoid
        +
        A monoid that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        doubleAdditionMonoid

        +
        @Deprecated
+public static final Monoid<java.lang.Double> doubleAdditionMonoid
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        doubleMultiplicationMonoid

        +
        @Deprecated
+public static final Monoid<java.lang.Double> doubleMultiplicationMonoid
        +
        Deprecated. Since 4.7. Due to rounding errors, multiplication of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        bigintAdditionMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintAdditionMonoid
        +
        A monoid that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintMultiplicationMonoid
        +
        A monoid that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalAdditionMonoid
        +
        A monoid that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalMultiplicationMonoid
        +
        A monoid that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionMonoid

        +
        public static final Monoid<Natural> naturalAdditionMonoid
        +
        A monoid that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationMonoid

        +
        public static final Monoid<Natural> naturalMultiplicationMonoid
        +
        A monoid that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionMonoid

        +
        public static final Monoid<java.lang.Long> longAdditionMonoid
        +
        A monoid that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationMonoid

        +
        public static final Monoid<java.lang.Long> longMultiplicationMonoid
        +
        A monoid that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> disjunctionMonoid
        +
        A monoid that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> exclusiveDisjunctionMonoid
        +
        A monoid that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> conjunctionMonoid
        +
        A monoid that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringMonoid

        +
        public static final Monoid<java.lang.String> stringMonoid
        +
        A monoid that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferMonoid

        +
        public static final Monoid<java.lang.StringBuffer> stringBufferMonoid
        +
        A monoid that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderMonoid

        +
        public static final Monoid<java.lang.StringBuilder> stringBuilderMonoid
        +
        A monoid that appends string builders.
        +
        • +
      + + + +
        +
      • +

        intMaxMonoid

        +
        public static final Monoid<java.lang.Integer> intMaxMonoid
        +
        A monoid for the maximum of two integers.
        +
        • +
      + + + +
        +
      • +

        intMinMonoid

        +
        public static final Monoid<java.lang.Integer> intMinMonoid
        +
        A monoid for the minimum of two integers.
        +
        • +
      + + + +
        +
      • +

        unitMonoid

        +
        public static final Monoid<Unit> unitMonoid
        +
        A monoid for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compose

        +
        public <B> Monoid<P2<A,B>> compose(Monoid<B> m)
        +
        Composes this monoid with another.
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public Semigroup<A> semigroup()
        +
        Returns a semigroup projection of this monoid.
        +
        +
        Returns:
        +
        A semigroup projection of this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Monoid<B> xmap(F<A,B> f,
+                          F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public <B,C> Monoid<C> compose(Monoid<B> mb,
+                               F<C,A> a,
+                               F<C,B> b,
+                               F2<A,B,C> c)
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this monoid.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this monoid.
        +
        +
        Returns:
        +
        A function that sums according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public A zero()
        +
        The zero value for this monoid.
        +
        +
        Returns:
        +
        The zero value for this monoid.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply

        +
        public A multiply(int n,
+                  A a)
        +
        Returns a value summed n times (a + a + ... + a). + The default definition uses peasant multiplication, exploiting + associativity to only require O(log n) uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(List<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(Stream<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(List<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(Stream<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public F<List<A>,A> sumLeft()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public F<List<A>,A> sumRight()
        +
        Returns a function that sums the given values with right-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with right-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeftS

        +
        public F<Stream<A>,A> sumLeftS()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + + + +
        +
      • +

        join

        +
        public A join(java.lang.Iterable<A> as,
+              A a)
        +
        Intersperses the given value between each two elements of the iterable, and sums the result.
        +
        +
        Parameters:
        +
        as - An iterable of values to sum.
        +
        a - The value to intersperse between values of the given iterable.
        +
        Returns:
        +
        The sum of the given values and the interspersed value.
        +
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Monoid<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.Definition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.AltDefinition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.Definition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.AltDefinition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F<A,F<A,A>> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F2<A,A,A> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        @Deprecated
+public static <A> Monoid<A> monoid(Semigroup<A> s,
+                                               A zero)
        +
        Deprecated. since 4.7. Use monoidDef(Semigroup.Definition, Object) or Semigroup.monoid(Object) instead.
        +
        Constructs a monoid from the given semigroup and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        functionMonoid

        +
        public static <A,B> Monoid<F<A,B>> functionMonoid(Monoid<B> mb)
        +
        A monoid for functions.
        +
        +
        Parameters:
        +
        mb - The monoid for the function codomain.
        +
        Returns:
        +
        A monoid for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listMonoid

        +
        public static <A> Monoid<List<A>> listMonoid()
        +
        A monoid for lists.
        +
        +
        Returns:
        +
        A monoid for lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionMonoid

        +
        public static <A> Monoid<Option<A>> optionMonoid(Semigroup<A> aSemigroup)
        +
        Lift a Semigroup<A> for A to a Monoid<Option<A>>, using Option.none() as zero.
        +
        +
        Returns:
        +
        A monoid for option.
        +
        +
        • +
      + + + +
        +
      • +

        optionMonoid

        +
        @Deprecated
+public static <A> Monoid<Option<A>> optionMonoid()
        +
        Deprecated. since 4.7. Use firstOptionMonoid().
        +
        A monoid for options.
        +
        +
        Returns:
        +
        A monoid for options.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionMonoid

        +
        public static <A> Monoid<Option<A>> firstOptionMonoid()
        +
        A monoid for options that take the first available value.
        +
        +
        Returns:
        +
        A monoid for options that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionMonoid

        +
        public static <A> Monoid<Option<A>> lastOptionMonoid()
        +
        A monoid for options that take the last available value.
        +
        +
        Returns:
        +
        A monoid for options that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamMonoid

        +
        public static <A> Monoid<Stream<A>> streamMonoid()
        +
        A monoid for streams.
        +
        +
        Returns:
        +
        A monoid for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arrayMonoid

        +
        public static <A> Monoid<Array<A>> arrayMonoid()
        +
        A monoid for arrays.
        +
        +
        Returns:
        +
        A monoid for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        ioMonoid

        +
        public static <A> Monoid<IO<A>> ioMonoid(Monoid<A> ma)
        +
        A monoid for IO values.
        +
        • +
      + + + +
        +
      • +

        setMonoid

        +
        public static <A> Monoid<Set<A>> setMonoid(Ord<A> o)
        +
        A monoid for sets.
        +
        +
        Parameters:
        +
        o - An order for set elements.
        +
        Returns:
        +
        A monoid for sets whose elements have the given order.
        +
        +
        • +
      + + + + + +
        +
      • +

        ordMaxMonoid

        +
        @Deprecated
+public static <A> Monoid<A> ordMaxMonoid(Ord<A> o,
+                                                     A zero)
        +
        Deprecated. since 4.7. Use Ord.maxMonoid(Object)
        +
        A monoid for the maximum of elements with ordering o.
        +
        +
        Parameters:
        +
        o - An ordering of elements.
        +
        zero - The minimum element.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Ord.AltDefinition.html b/javadoc/4.8.1/functionaljava/fj/Ord.AltDefinition.html new file mode 100644 index 0000000..4e25f55 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Ord.AltDefinition.html @@ -0,0 +1,298 @@ + + + + + +Ord.AltDefinition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Ord.Definition.html b/javadoc/4.8.1/functionaljava/fj/Ord.Definition.html new file mode 100644 index 0000000..21dceaa --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Ord.Definition.html @@ -0,0 +1,427 @@ + + + + + +Ord.Definition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Ord.html b/javadoc/4.8.1/functionaljava/fj/Ord.html new file mode 100644 index 0000000..b1ded68 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Ord.html @@ -0,0 +1,1439 @@ + + + + + +Ord (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Ord<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Ord<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Ord<A>
+extends java.lang.Object
    +
    Tests for ordering between two objects.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface Ord.AltDefinition<A> +
      Primitives functions of Ord: alternative minimal definition and overridable methods.
      +
      static interface Ord.Definition<A> +
      Primitives functions of Ord: minimal definition and overridable methods.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Ord<java.math.BigDecimal>bigdecimalOrd +
      An order instance for the BigDecimal type.
      +
      static Ord<java.math.BigInteger>bigintOrd +
      An order instance for the BigInteger type.
      +
      static Ord<java.lang.Boolean>booleanOrd +
      An order instance for the boolean type.
      +
      static Ord<java.lang.Byte>byteOrd +
      An order instance for the byte type.
      +
      static Ord<java.lang.Character>charOrd +
      An order instance for the char type.
      +
      static Ord<java.lang.Double>doubleOrd +
      An order instance for the double type.
      +
      static Ord<java.lang.Float>floatOrd +
      An order instance for the float type.
      +
      static Ord<java.lang.Integer>intOrd +
      An order instance for the int type.
      +
      static Ord<java.lang.Long>longOrd +
      An order instance for the long type.
      +
      F<A,F<A,A>>max +
      A function that returns the greater of its two arguments.
      +
      F<A,F<A,A>>min +
      A function that returns the lesser of its two arguments.
      +
      static Ord<Natural>naturalOrd +
      An order instance for the Natural type.
      +
      static Ord<Ordering>orderingOrd +
      An order instance for the Ordering type.
      +
      static Ord<java.lang.Short>shortOrd +
      An order instance for the short type.
      +
      static Ord<java.lang.StringBuffer>stringBufferOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.StringBuilder>stringBuilderOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.String>stringOrd +
      An order instance for the String type.
      +
      static Ord<Unit>unitOrd +
      An order instance for the Unit type.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> Ord<Array<A>>arrayOrd(Ord<A> oa) +
      An order instance for the Array type.
      +
      static <A extends java.lang.Comparable<A>>
      Ord<A>      		comparableOrd() +
      An order instance for the Comparable interface.
      +
      F<A,F<A,Ordering>>compare() +
      First-class ordering.
      +
      Orderingcompare(A a1, + A a2) +
      Returns an ordering for the given arguments.
      +
      static <A,B> Ord<A>contramap(F<A,B> f, + Ord<B> ord) +
      Static version of contramap(F)
      +
      <B> Ord<B>contramap(F<B,A> f) +
      Maps the given function across this ord as a contra-variant functor.
      +
      static <A,B> Ord<Either<A,B>>eitherOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Either type.
      +
      booleaneq(A a1, + A a2) +
      Returns true if the given arguments are equal, false otherwise.
      +
      Equal<A>equal() +
      Returns an Equal for this order.
      +
      static <A> Ord<A>hashEqualsOrd() +
      Deprecated.  +
      As of release 4.7.
      +
      +
      static <A> Ord<A>hashOrd() +
      Deprecated.  +
      As of release 4.7.
      +
      +
      F<A,java.lang.Boolean>isGreaterThan(A a) +
      Returns a function that returns true if its argument is greater than than the argument to this method.
      +
      booleanisGreaterThan(A a1, + A a2) +
      Returns true if the first given argument is greater than the second given + argument, false otherwise.
      +
      F<A,java.lang.Boolean>isLessThan(A a) +
      Returns a function that returns true if its argument is less than the argument to this method.
      +
      booleanisLessThan(A a1, + A a2) +
      Returns true if the first given argument is less than the second given argument, + false otherwise.
      +
      booleanisLessThanOrEqualTo(A a1, + A a2) +
      Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
      +
      static <A> Ord<List<A>>listOrd(Ord<A> oa) +
      An order instance for the List type.
      +
      Amax(A a1, + A a2) +
      Returns the greater of its two arguments.
      +
      Monoid<A>maxMonoid(A zero) 
      Semigroup<A>maxSemigroup() 
      Amin(A a1, + A a2) +
      Returns the lesser of its two arguments.
      +
      Monoid<A>minMonoid(A zero) 
      Semigroup<A>minSemigroup() 
      static <A> Ord<NonEmptyList<A>>nonEmptyListOrd(Ord<A> oa) +
      An order instance for the NonEmptyList type.
      +
      static <A,B> Ord.Definition<A>on(F<A,B> f, + Ord<B> ord) +
      Begin definition of an ord instance.
      +
      static <A> Ord<Option<A>>optionOrd(Ord<A> oa) +
      An order instance for the Option type.
      +
      static <A> Ord<A>ord(F<A,F<A,Ordering>> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ord(F2<A,A,Ordering> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ordDef(Ord.AltDefinition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<A>ordDef(Ord.Definition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<P1<A>>p1Ord(Ord<A> oa) +
      An order instance for a product-1.
      +
      static <A,B> Ord<P2<A,B>>p2Ord(Ord<A> oa, + Ord<B> ob) +
      An order instance for a product-2, with the first factor considered most significant.
      +
      static <A,B> Ord<P2<A,B>>p2Ord1(Ord<A> oa) 
      static <A,B> Ord<P2<A,B>>p2Ord2(Ord<B> ob) 
      static <A,B,C> Ord<P3<A,B,C>>p3Ord(Ord<A> oa, + Ord<B> ob, + Ord<C> oc) +
      An order instance for a product-3, with the first factor considered most significant.
      +
      Ord<A>reverse() 
      static <A> Ord<Set<A>>setOrd(Ord<A> oa) +
      An order instance for the Set type.
      +
      static <A> Ord<Stream<A>>streamOrd(Ord<A> oa) +
      An order instance for the Stream type.
      +
      java.util.Comparator<A>toComparator() 
      static <A,B> Ord<Validation<A,B>>validationOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Validation type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        max

        +
        public final F<A,F<A,A>> max
        +
        A function that returns the greater of its two arguments.
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final F<A,F<A,A>> min
        +
        A function that returns the lesser of its two arguments.
        +
        • +
      + + + +
        +
      • +

        booleanOrd

        +
        public static final Ord<java.lang.Boolean> booleanOrd
        +
        An order instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteOrd

        +
        public static final Ord<java.lang.Byte> byteOrd
        +
        An order instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charOrd

        +
        public static final Ord<java.lang.Character> charOrd
        +
        An order instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleOrd

        +
        public static final Ord<java.lang.Double> doubleOrd
        +
        An order instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatOrd

        +
        public static final Ord<java.lang.Float> floatOrd
        +
        An order instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intOrd

        +
        public static final Ord<java.lang.Integer> intOrd
        +
        An order instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintOrd

        +
        public static final Ord<java.math.BigInteger> bigintOrd
        +
        An order instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalOrd

        +
        public static final Ord<java.math.BigDecimal> bigdecimalOrd
        +
        An order instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longOrd

        +
        public static final Ord<java.lang.Long> longOrd
        +
        An order instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortOrd

        +
        public static final Ord<java.lang.Short> shortOrd
        +
        An order instance for the short type.
        +
        • +
      + + + +
        +
      • +

        orderingOrd

        +
        public static final Ord<Ordering> orderingOrd
        +
        An order instance for the Ordering type.
        +
        • +
      + + + +
        +
      • +

        stringOrd

        +
        public static final Ord<java.lang.String> stringOrd
        +
        An order instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferOrd

        +
        public static final Ord<java.lang.StringBuffer> stringBufferOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderOrd

        +
        public static final Ord<java.lang.StringBuilder> stringBuilderOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        unitOrd

        +
        public static final Ord<Unit> unitOrd
        +
        An order instance for the Unit type.
        +
        • +
      + + + +
        +
      • +

        naturalOrd

        +
        public static final Ord<Natural> naturalOrd
        +
        An order instance for the Natural type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public F<A,F<A,Ordering>> compare()
        +
        First-class ordering.
        +
        +
        Returns:
        +
        A function that returns an ordering for its arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        compare

        +
        public Ordering compare(A a1,
+                        A a2)
        +
        Returns an ordering for the given arguments.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        An ordering for the given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for equality to another.
        +
        a2 - An instance to compare for equality to another.
        +
        Returns:
        +
        true if the given arguments are equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public Equal<A> equal()
        +
        Returns an Equal for this order.
        +
        +
        Returns:
        +
        An Equal for this order.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Ord<B> contramap(F<B,A> f)
        +
        Maps the given function across this ord as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new ord.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(A a1,
+                          A a2)
        +
        Returns true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThanOrEqualTo

        +
        public boolean isLessThanOrEqualTo(A a1,
+                                   A a2)
        +
        Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(A a1,
+                             A a2)
        +
        Returns true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public F<A,java.lang.Boolean> isLessThan(A a)
        +
        Returns a function that returns true if its argument is less than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is less than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public F<A,java.lang.Boolean> isGreaterThan(A a)
        +
        Returns a function that returns true if its argument is greater than than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is greater than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        max

        +
        public A max(A a1,
+             A a2)
        +
        Returns the greater of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The greater of the two values.
        +
        +
        • +
      + + + + + +
        +
      • +

        min

        +
        public A min(A a1,
+             A a2)
        +
        Returns the lesser of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The lesser of the two values.
        +
        +
        • +
      + + + +
        +
      • +

        minSemigroup

        +
        public final Semigroup<A> minSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        minMonoid

        +
        public final Monoid<A> minMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        maxSemigroup

        +
        public final Semigroup<A> maxSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        maxMonoid

        +
        public final Monoid<A> maxMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Ord<A> reverse()
        +
        • +
      + + + + + + + +
        +
      • +

        contramap

        +
        public static <A,B> Ord<A> contramap(F<A,B> f,
+                                     Ord<B> ord)
        +
        Static version of contramap(F)
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F<A,F<A,Ordering>> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F2<A,A,Ordering> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.Definition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.AltDefinition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        optionOrd

        +
        public static <A> Ord<Option<A>> optionOrd(Ord<A> oa)
        +
        An order instance for the Option type.
        +
        +
        Parameters:
        +
        oa - Order across the element of the option.
        +
        Returns:
        +
        An order instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherOrd

        +
        public static <A,B> Ord<Either<A,B>> eitherOrd(Ord<A> oa,
+                                               Ord<B> ob)
        +
        An order instance for the Either type.
        +
        +
        Parameters:
        +
        oa - Order across the left side of Either.
        +
        ob - Order across the right side of Either.
        +
        Returns:
        +
        An order instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        validationOrd

        +
        public static <A,B> Ord<Validation<A,B>> validationOrd(Ord<A> oa,
+                                                       Ord<B> ob)
        +
        An order instance for the Validation type.
        +
        +
        Parameters:
        +
        oa - Order across the failing side of Validation.
        +
        ob - Order across the succeeding side of Validation.
        +
        Returns:
        +
        An order instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listOrd

        +
        public static <A> Ord<List<A>> listOrd(Ord<A> oa)
        +
        An order instance for the List type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the list.
        +
        Returns:
        +
        An order instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListOrd

        +
        public static <A> Ord<NonEmptyList<A>> nonEmptyListOrd(Ord<A> oa)
        +
        An order instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the non-empty list.
        +
        Returns:
        +
        An order instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        streamOrd

        +
        public static <A> Ord<Stream<A>> streamOrd(Ord<A> oa)
        +
        An order instance for the Stream type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the stream.
        +
        Returns:
        +
        An order instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayOrd

        +
        public static <A> Ord<Array<A>> arrayOrd(Ord<A> oa)
        +
        An order instance for the Array type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the array.
        +
        Returns:
        +
        An order instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        setOrd

        +
        public static <A> Ord<Set<A>> setOrd(Ord<A> oa)
        +
        An order instance for the Set type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the set.
        +
        Returns:
        +
        An order instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Ord

        +
        public static <A> Ord<P1<A>> p1Ord(Ord<A> oa)
        +
        An order instance for a product-1.
        +
        +
        Parameters:
        +
        oa - Order across the produced type.
        +
        Returns:
        +
        An order instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord

        +
        public static <A,B> Ord<P2<A,B>> p2Ord(Ord<A> oa,
+                                       Ord<B> ob)
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        Returns:
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord1

        +
        public static <A,B> Ord<P2<A,B>> p2Ord1(Ord<A> oa)
        +
        • +
      + + + +
        +
      • +

        p2Ord2

        +
        public static <A,B> Ord<P2<A,B>> p2Ord2(Ord<B> ob)
        +
        • +
      + + + +
        +
      • +

        p3Ord

        +
        public static <A,B,C> Ord<P3<A,B,C>> p3Ord(Ord<A> oa,
+                                           Ord<B> ob,
+                                           Ord<C> oc)
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        oc - An order instance for the third factor.
        +
        Returns:
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        comparableOrd

        +
        public static <A extends java.lang.Comparable<A>> Ord<A> comparableOrd()
        +
        An order instance for the Comparable interface.
        +
        +
        Returns:
        +
        An order instance for the Comparable interface.
        +
        +
        • +
      + + + +
        +
      • +

        hashOrd

        +
        @Deprecated
+public static <A> Ord<A> hashOrd()
        +
        Deprecated. As of release 4.7.
        +
        An order instance that uses Object.hashCode() for computing the order and equality, + thus objects returning the same hashCode are considered to be equals. + This is not safe and therefore this method is deprecated.
        +
        +
        Returns:
        +
        An order instance that is based on Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        hashEqualsOrd

        +
        @Deprecated
+public static <A> Ord<A> hashEqualsOrd()
        +
        Deprecated. As of release 4.7.
        +
        An order instance that uses Object.hashCode() and Object.equals(java.lang.Object) for computing + the order and equality. First the hashCode is compared, if this is equal, objects are compared + using Object.equals(java.lang.Object). + WARNING: This ordering violate antisymmetry on hash collisions.
        +
        +
        Returns:
        +
        An order instance that is based on Object.hashCode() and Object.equals(java.lang.Object).
        +
        +
        • +
      + + + +
        +
      • +

        toComparator

        +
        public java.util.Comparator<A> toComparator()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Ordering.html b/javadoc/4.8.1/functionaljava/fj/Ordering.html new file mode 100644 index 0000000..96f1035 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Ordering.html @@ -0,0 +1,401 @@ + + + + + +Ordering (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Ordering

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Ordering>
      • +
    • +
        +
      • fj.Ordering
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Ordering>
    +
    +
    +
    +
    public enum Ordering
+extends java.lang.Enum<Ordering>
    +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EQ +
      Equal.
      +
      GT +
      Greater than.
      +
      LT +
      Less than.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static OrderingfromInt(int cmp) 
      Orderingreverse() 
      inttoInt() 
      static OrderingvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Ordering[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        LT

        +
        public static final Ordering LT
        +
        Less than.
        +
        • +
      + + + +
        +
      • +

        EQ

        +
        public static final Ordering EQ
        +
        Equal.
        +
        • +
      + + + +
        +
      • +

        GT

        +
        public static final Ordering GT
        +
        Greater than.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Ordering[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Ordering c : Ordering.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Ordering valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public int toInt()
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Ordering reverse()
        +
        • +
      + + + +
        +
      • +

        fromInt

        +
        public static Ordering fromInt(int cmp)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P.html b/javadoc/4.8.1/functionaljava/fj/P.html new file mode 100644 index 0000000..2ec0028 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P.html @@ -0,0 +1,1057 @@ + + + + + +P (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class P
+extends java.lang.Object
    +
    Functions across products.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> P1<A>hardMemo(F0<A> f) +
      Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
      +
      static <A> P1<A>lazy(F<Unit,A> f) 
      static <A,B> P2<A,B>lazy(F<Unit,A> fa, + F<Unit,B> fb) 
      static <A,B,C> P3<A,B,C>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe) 
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff) 
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg) 
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg, + F<Unit,H> fh) 
      static <A> P1<A>lazy(F0<A> f) +
      Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
      +
      static <A,B> P2<A,B>lazy(F0<A> pa, + F0<B> pb) 
      static <A,B,C> P3<A,B,C>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe) 
      static <A,B,C,D,E,F>
      P6<A,B,C,D,E,F>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf) 
      static <A,B,C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg) 
      static <A,B,C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg, + F0<H> ph) 
      static <A,B> P2<A,B>lazyProduct(F0<P2<A,B>> f) 
      static <A> P1<A>p(A a) +
      A function that puts an element in a product-1.
      +
      static <A,B> P2<A,B>p(A a, + B b) +
      A function that puts elements in a product-2.
      +
      static <A,B,C> P3<A,B,C>p(A a, + B b, + C c) +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> P4<A,B,C,D>p(A a, + B b, + C c, + D d) +
      A function that puts elements in a product-4.
      +
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		p(A a, + B b, + C c, + D d, + E e) +
      A function that puts elements in a product-5.
      +
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		p(A a, + B b, + C c, + D d, + E e, + F$ f) +
      A function that puts elements in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      A function that puts elements in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      A function that puts elements in a product-8.
      +
      static <A> F<A,P1<A>>p1() +
      A function that puts an element in a product-1.
      +
      static <A,B> F<A,F<B,P2<A,B>>>p2() +
      A function that puts an element in a product-2.
      +
      static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>>p3() +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>>p4() +
      A function that puts an element in a product-4.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>>      		p5() +
      A function that puts an element in a product-5.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>>      		p6() +
      A function that puts an element in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>>      		p7() +
      A function that puts an element in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>>      		p8() +
      A function that puts an element in a product-8.
      +
      static <A> P1<A>softMemo(F0<A> f) +
      Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
      +
      static <A> P1<A>weakMemo(F0<A> f) +
      Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        p1

        +
        public static <A> F<A,P1<A>> p1()
        +
        A function that puts an element in a product-1.
        +
        +
        Returns:
        +
        A function that puts an element in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A> P1<A> p(A a)
        +
        A function that puts an element in a product-1.
        +
        +
        Parameters:
        +
        a - The element.
        +
        Returns:
        +
        The product-1.
        +
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public static <A> P1<A> hardMemo(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public static <A> P1<A> weakMemo(F0<A> f)
        +
        Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public static <A> P1<A> softMemo(F0<A> f)
        +
        Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie. to avoid OutOfMemoryErrors).
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F0<A> pa,
+                                 F0<B> pb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F0<A> pa,
+                                     F0<B> pb,
+                                     F0<C> pc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F0<A> pa,
+                                         F0<B> pb,
+                                         F0<C> pc,
+                                         F0<D> pd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F0<A> pa,
+                                             F0<B> pb,
+                                             F0<C> pc,
+                                             F0<D> pd,
+                                             F0<E> pe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F> P6<A,B,C,D,E,F> lazy(F0<A> pa,
+                                                 F0<B> pb,
+                                                 F0<C> pc,
+                                                 F0<D> pd,
+                                                 F0<E> pe,
+                                                 F0<F> pf)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G> P7<A,B,C,D,E,F,G> lazy(F0<A> pa,
+                                                     F0<B> pb,
+                                                     F0<C> pc,
+                                                     F0<D> pd,
+                                                     F0<E> pe,
+                                                     F0<F> pf,
+                                                     F0<G> pg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> lazy(F0<A> pa,
+                                                         F0<B> pb,
+                                                         F0<C> pc,
+                                                         F0<D> pd,
+                                                         F0<E> pe,
+                                                         F0<F> pf,
+                                                         F0<G> pg,
+                                                         F0<H> ph)
        +
        • +
      + + + +
        +
      • +

        lazyProduct

        +
        public static <A,B> P2<A,B> lazyProduct(F0<P2<A,B>> f)
        +
        • +
      + + + +
        +
      • +

        p2

        +
        public static <A,B> F<A,F<B,P2<A,B>>> p2()
        +
        A function that puts an element in a product-2.
        +
        +
        Returns:
        +
        A function that puts an element in a product-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B> P2<A,B> p(A a,
+                              B b)
        +
        A function that puts elements in a product-2.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        Returns:
        +
        The product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3

        +
        public static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>> p3()
        +
        A function that puts elements in a product-3.
        +
        +
        Returns:
        +
        A function that puts elements in a product-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C> P3<A,B,C> p(A a,
+                                  B b,
+                                  C c)
        +
        A function that puts elements in a product-3.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        Returns:
        +
        The product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4

        +
        public static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>> p4()
        +
        A function that puts an element in a product-4.
        +
        +
        Returns:
        +
        A function that puts an element in a product-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D> P4<A,B,C,D> p(A a,
+                                      B b,
+                                      C c,
+                                      D d)
        +
        A function that puts elements in a product-4.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        Returns:
        +
        The product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>> p5()
        +
        A function that puts an element in a product-5.
        +
        +
        Returns:
        +
        A function that puts an element in a product-5.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> p(A a,
+                                          B b,
+                                          C c,
+                                          D d,
+                                          E e)
        +
        A function that puts elements in a product-5.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        Returns:
        +
        The product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>> p6()
        +
        A function that puts an element in a product-6.
        +
        +
        Returns:
        +
        A function that puts an element in a product-6.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> p(A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f)
        +
        A function that puts elements in a product-6.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        Returns:
        +
        The product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>> p7()
        +
        A function that puts an element in a product-7.
        +
        +
        Returns:
        +
        A function that puts an element in a product-7.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> p(A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e,
+                                                    F$ f,
+                                                    G g)
        +
        A function that puts elements in a product-7.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        Returns:
        +
        The product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>> p8()
        +
        A function that puts an element in a product-8.
        +
        +
        Returns:
        +
        A function that puts an element in a product-8.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> p(A a,
+                                                        B b,
+                                                        C c,
+                                                        D d,
+                                                        E e,
+                                                        F$ f,
+                                                        G g,
+                                                        H h)
        +
        A function that puts elements in a product-8.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        h - An element.
        +
        Returns:
        +
        The product-8.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F<Unit,A> fa,
+                                 F<Unit,B> fb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F<Unit,A> fa,
+                                     F<Unit,B> fb,
+                                     F<Unit,C> fc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F<Unit,A> fa,
+                                         F<Unit,B> fb,
+                                         F<Unit,C> fc,
+                                         F<Unit,D> fd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F<Unit,A> fa,
+                                             F<Unit,B> fb,
+                                             F<Unit,C> fc,
+                                             F<Unit,D> fd,
+                                             F<Unit,E> fe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> lazy(F<Unit,A> fa,
+                                                   F<Unit,B> fb,
+                                                   F<Unit,C> fc,
+                                                   F<Unit,D> fd,
+                                                   F<Unit,E> fe,
+                                                   F<Unit,F$> ff)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> lazy(F<Unit,A> fa,
+                                                       F<Unit,B> fb,
+                                                       F<Unit,C> fc,
+                                                       F<Unit,D> fd,
+                                                       F<Unit,E> fe,
+                                                       F<Unit,F$> ff,
+                                                       F<Unit,G> fg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> lazy(F<Unit,A> fa,
+                                                           F<Unit,B> fb,
+                                                           F<Unit,C> fc,
+                                                           F<Unit,D> fd,
+                                                           F<Unit,E> fe,
+                                                           F<Unit,F$> ff,
+                                                           F<Unit,G> fg,
+                                                           F<Unit,H> fh)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P1.html b/javadoc/4.8.1/functionaljava/fj/P1.html new file mode 100644 index 0000000..33c6538 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P1.html @@ -0,0 +1,952 @@ + + + + + +P1 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P1<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<A>
    +
    +
    +
    Direct Known Subclasses:
    +
    $
    +
    +
    +
    +
    public abstract class P1<A>
+extends java.lang.Object
+implements F0<A>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P1() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> F<P1<A>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      <B> P1<B>apply(P1<F<A,B>> cf) +
      Performs function application within a P1 (applicative functor pattern).
      +
      <B> P1<B>bind(F<A,P1<B>> f) +
      Binds the given function to the value in a product-1 with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F2<A,B,C> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B> F<B,A>constant() +
      Returns a constant function that always uses this value.
      +
      static <A,B> F<A,P1<B>>curry(F<A,B> f) +
      Promotes the given function so that it returns its value in a P1.
      +
      booleanequals(java.lang.Object other) 
      Af() 
      static <A,B> F<P1<A>,P1<B>>fmap(F<A,B> f) +
      Deprecated.  +
      As of release 4.5, use map_(fj.F<A, B>)
      +
      +
      P1<A>hardMemo() +
      Returns a P1 that remembers its value.
      +
      inthashCode() 
      static <A> P1<A>join(P1<P1<A>> a) +
      Joins a P1 of a P1 with a bind operation.
      +
      static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on P1s.
      +
      <B,C> P1<C>liftM2(P1<B> pb, + F2<A,B,C> f) 
      static <A,B> F<P1<A>,P1<B>>map_(F<A,B> f) +
      Promote any function to a transformation between P1s.
      +
      <B> P1<B>map(F<A,B> f) +
      Map the element of the product.
      +
      P1<A>memo() +
      Deprecated.  +
      since 4.7. Use weakMemo() instead.
      +
      +
      static <A> P1<A>memo(F<Unit,A> f) +
      Deprecated.  +
      since 4.7. Use P.weakMemo(F0) instead.
      +
      +
      static <A> P1<A>memo(F0<A> f) +
      Deprecated.  +
      since 4.7. Use P.weakMemo(F0) instead.
      +
      +
      static <A> P1<Array<A>>sequence(Array<P1<A>> as) +
      Turns an array of P1s into a single P1 of an array.
      +
      static <A> P1<List<A>>sequence(List<P1<A>> as) +
      Turns a List of P1s into a single P1 of a List.
      +
      static <A> P1<Option<A>>sequence(Option<P1<A>> o) +
      Turns an optional P1 into a lazy option.
      +
      static <A> P1<Stream<A>>sequence(Stream<P1<A>> as) +
      Turns a stream of P1s into a single P1 of a stream.
      +
      static <A> F<List<P1<A>>,P1<List<A>>>sequenceList() +
      A first-class version of the sequence method for lists of P1s.
      +
      P1<A>softMemo() +
      Like memo, but the memoized value is wrapped into a SoftReference
      +
      java.lang.StringtoString() 
      <B,X> Either<X,P1<B>>traverseEither(F<A,Either<X,B>> f) +
      Traversable instance of P1 for Either
      +
      <B> List<P1<B>>traverseList(F<A,List<B>> f) +
      Traversable instance of P1 for List
      +
      <B> Option<P1<B>>traverseOption(F<A,Option<B>> f) +
      Traversable instance of P1 for Option
      +
      <B> Stream<P1<B>>traverseStream(F<A,Stream<B>> f) +
      Traversable instance of P1 for Stream
      +
      <B,E> Validation<E,P1<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traversable instance of P1 for Validation
      +
      P1<A>weakMemo() +
      Like memo, but the memoized value is wrapped into a WeakReference
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P1

        +
        public P1()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        public final A f()
        +
        +
        Specified by:
        +
        f in interface F0<A>
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<P1<A>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        @Deprecated
+public static <A,B> F<P1<A>,P1<B>> fmap(F<A,B> f)
        +
        Deprecated. As of release 4.5, use map_(fj.F<A, B>)
        +
        Promote any function to a transformation between P1s.
        +
        +
        Parameters:
        +
        f - A function to promote to a transformation between P1s.
        +
        Returns:
        +
        A function promoted to operate on P1s.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<P1<A>,P1<B>> map_(F<A,B> f)
        +
        Promote any function to a transformation between P1s.
        +
        +
        Parameters:
        +
        f - A function to promote to a transformation between P1s.
        +
        Returns:
        +
        A function promoted to operate on P1s.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> P1<B> bind(F<A,P1<B>> f)
        +
        Binds the given function to the value in a product-1 with a final join.
        +
        +
        Parameters:
        +
        f - A function to apply to the value in a product-1.
        +
        Returns:
        +
        The result of applying the given function to the value of given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B> F<A,P1<B>> curry(F<A,B> f)
        +
        Promotes the given function so that it returns its value in a P1.
        +
        +
        Parameters:
        +
        f - A function to have its result wrapped in a P1.
        +
        Returns:
        +
        A function whose result is wrapped in a P1.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> P1<B> apply(P1<F<A,B>> cf)
        +
        Performs function application within a P1 (applicative functor pattern).
        +
        +
        Parameters:
        +
        cf - The P1 function to apply.
        +
        Returns:
        +
        A new P1 after applying the given P1 function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        +
        Parameters:
        +
        cb - A given P1 to bind the given function with.
        +
        f - The function to apply to the values in the given P1s.
        +
        Returns:
        +
        A new P1 after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F2<A,B,C> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> P1<A> join(P1<P1<A>> a)
        +
        Joins a P1 of a P1 with a bind operation.
        +
        +
        Parameters:
        +
        a - The P1 of a P1 to join.
        +
        Returns:
        +
        A new P1 that is the join of the given P1.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on P1s.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over P1s.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> P1<C> liftM2(P1<B> pb,
+                                F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<List<A>> sequence(List<P1<A>> as)
        +
        Turns a List of P1s into a single P1 of a List.
        +
        +
        Parameters:
        +
        as - The list of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static <A> F<List<P1<A>>,P1<List<A>>> sequenceList()
        +
        A first-class version of the sequence method for lists of P1s.
        +
        +
        Returns:
        +
        A function from a List of P1s to a single P1 of a List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Stream<A>> sequence(Stream<P1<A>> as)
        +
        Turns a stream of P1s into a single P1 of a stream.
        +
        +
        Parameters:
        +
        as - The stream of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Option<A>> sequence(Option<P1<A>> o)
        +
        Turns an optional P1 into a lazy option.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Array<A>> sequence(Array<P1<A>> as)
        +
        Turns an array of P1s into a single P1 of an array.
        +
        +
        Parameters:
        +
        as - The array of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given array.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<P1<B>> traverseList(F<A,List<B>> f)
        +
        Traversable instance of P1 for List
        +
        +
        Parameters:
        +
        f - The function that takes A and produces a List (non-deterministic result)
        +
        Returns:
        +
        A List of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,X> Either<X,P1<B>> traverseEither(F<A,Either<X,B>> f)
        +
        Traversable instance of P1 for Either
        +
        +
        Parameters:
        +
        f - The function produces Either
        +
        Returns:
        +
        An Either of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<P1<B>> traverseOption(F<A,Option<B>> f)
        +
        Traversable instance of P1 for Option
        +
        +
        Parameters:
        +
        f - The function that produces Option
        +
        Returns:
        +
        An Option of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <B,E> Validation<E,P1<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traversable instance of P1 for Validation
        +
        +
        Parameters:
        +
        f - The function might produces Validation
        +
        Returns:
        +
        An Validation of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<P1<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traversable instance of P1 for Stream
        +
        +
        Parameters:
        +
        f - The function that produces Stream
        +
        Returns:
        +
        An Stream of P1
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> P1<B> map(F<A,B> f)
        +
        Map the element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public final P1<A> memo()
        +
        Deprecated. since 4.7. Use weakMemo() instead.
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public P1<A> hardMemo()
        +
        Returns a P1 that remembers its value.
        +
        +
        Returns:
        +
        A P1 that calls this P1 once and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public P1<A> weakMemo()
        +
        Like memo, but the memoized value is wrapped into a WeakReference
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public P1<A> softMemo()
        +
        Like memo, but the memoized value is wrapped into a SoftReference
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public static <A> P1<A> memo(F<Unit,A> f)
        +
        Deprecated. since 4.7. Use P.weakMemo(F0) instead.
        +
        • +
      + + + +
        +
      • +

        memo

        +
        @Deprecated
+public static <A> P1<A> memo(F0<A> f)
        +
        Deprecated. since 4.7. Use P.weakMemo(F0) instead.
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public final <B> F<B,A> constant()
        +
        Returns a constant function that always uses this value.
        +
        +
        Returns:
        +
        A constant function that always uses this value.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P2.Optic.html b/javadoc/4.8.1/functionaljava/fj/P2.Optic.html new file mode 100644 index 0000000..324c931 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P2.Optic.html @@ -0,0 +1,291 @@ + + + + + +P2.Optic (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P2.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    P2<A,B>
    +
    +
    +
    +
    public static final class P2.Optic
+extends java.lang.Object
    +
    Optic factory methods for a P2
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Lens<P2<A,B>,A>_1() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C>_1p() +
      Polyomorphic lens targeted on _1.
      +
      static <A,B> Lens<P2<A,B>,B>_2() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C>_2p() +
      Polyomorphic lens targeted on _2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        _1p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C> _1p()
        +
        Polyomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static <A,B> Lens<P2<A,B>,A> _1()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _2p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C> _2p()
        +
        Polyomorphic lens targeted on _2.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static <A,B> Lens<P2<A,B>,B> _2()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P2.html b/javadoc/4.8.1/functionaljava/fj/P2.html new file mode 100644 index 0000000..e0de739 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P2.html @@ -0,0 +1,1079 @@ + + + + + +P2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class P2<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P2<A,B>
+extends java.lang.Object
    +
    A product-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class P2.Optic +
      Optic factory methods for a P2
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P2() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<P2<A,B>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B> F<P2<A,B>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      <C> P3<A,B,C>append(C el) +
      Creates a P3 by adding the given element to the current P2
      +
      <C,D> P4<A,B,C,D>append(P2<C,D> el) +
      Creates a P4 by adding the given element to the current P2
      +
      <C,D,E> P5<A,B,C,D,E>append(P3<C,D,E> el) +
      Creates a P5 by adding the given element to the current P2
      +
      <C,D,E,F> P6<A,B,C,D,E,F>append(P4<C,D,E,F> el) +
      Creates a P6 by adding the given element to the current P2
      +
      <C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		append(P5<C,D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P2
      +
      <C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P6<C,D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P2
      +
      <C> P2<C,B>cobind(F<P2<A,B>,C> k) +
      Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
      +
      P2<P2<A,B>,B>duplicate() +
      Duplicates this product into the first element (Comonad pattern).
      +
      booleanequals(java.lang.Object other) 
      static <B,C,D> P2<C,D>fanout(F<B,C> f, + F<B,D> g, + B b) +
      Sends the given input value to both argument functions and combines their output.
      +
      inthashCode() 
      <C> P2<C,B>inject(C c) +
      Replaces the first element of this product with the given value.
      +
      static <A,B> P2<B,B>map(F<A,B> f, + P2<A,A> p) +
      Maps the given function across both the elements of the given product.
      +
      static <A,B,X> F<P2<A,B>,P2<X,B>>map1_(F<A,X> f) +
      Promotes a function so that it maps the first element of a product.
      +
      <X> P2<X,B>map1(F<A,X> f) +
      Map the first element of the product.
      +
      static <A,B,X> F<P2<A,B>,P2<A,X>>map2_(F<B,X> f) +
      Promotes a function so that it maps the second element of a product.
      +
      <X> P2<A,X>map2(F<B,X> f) +
      Map the second element of the product.
      +
      P2<A,B>memo() +
      Provides a memoising P2 that remembers its values.
      +
      <C> List<C>sequenceW(List<F<P2<A,B>,C>> fs) +
      Applies a list of comonadic functions to this product, returning a list of values.
      +
      <C> Stream<C>sequenceW(Stream<F<P2<A,B>,C>> fs) +
      Applies a stream of comonadic functions to this product, returning a stream of values.
      +
      static <A,B,C,D> F<P2<A,B>,P2<C,D>>split_(F<A,C> f, + F<B,D> g) +
      A first-class version of the split function.
      +
      <C,D> P2<C,D>split(F<A,C> f, + F<B,D> g) +
      Split this product between two argument functions and combine their output.
      +
      static <A,B> F<P2<A,B>,P2<B,A>>swap_() +
      Returns a curried form of swap().
      +
      P2<B,A>swap() +
      Swaps the elements around in this product.
      +
      java.lang.StringtoString() 
      <C,X> Either<X,P2<A,C>>traverseEither(F<B,Either<X,C>> f) 
      <C> IO<P2<A,C>>traverseIO(F<B,IO<C>> f) 
      <C> List<P2<A,C>>traverseList(F<B,List<C>> f) 
      <C> Option<P2<A,C>>traverseOption(F<B,Option<C>> f) 
      <C> Stream<P2<A,C>>traverseStream(F<B,Stream<C>> f) 
      static <A,B,C> F<P2<A,B>,C>tuple(F<A,F<B,C>> f) +
      Transforms a curried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F<P2<A,B>,C>tuple(F2<A,B,C> f) +
      Transforms an uncurried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F2<A,B,C>untuple(F<P2<A,B>,C> f) +
      Transforms a function of a product-2 to an uncurried function or arity-2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P2

        +
        public P2()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final P2<B,A> swap()
        +
        Swaps the elements around in this product.
        +
        +
        Returns:
        +
        A new product-2 with the elements swapped.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P2<X,B> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P2<A,X> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final <C,D> P2<C,D> split(F<A,C> f,
+                                 F<B,D> g)
        +
        Split this product between two argument functions and combine their output.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of this product.
        +
        g - A function that will map the second element of this product.
        +
        Returns:
        +
        A new product with the first function applied to the second element + and the second function applied to the second element.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <C> P2<C,B> cobind(F<P2<A,B>,C> k)
        +
        Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
        +
        +
        Parameters:
        +
        k - A function to map over the duplicated product.
        +
        Returns:
        +
        A new product with the result of the given function applied to this product as the first element, + and with the second element intact.
        +
        +
        • +
      + + + +
        +
      • +

        duplicate

        +
        public final P2<P2<A,B>,B> duplicate()
        +
        Duplicates this product into the first element (Comonad pattern).
        +
        +
        Returns:
        +
        A new product with this product in its first element and with the second element intact.
        +
        +
        • +
      + + + + + +
        +
      • +

        inject

        +
        public final <C> P2<C,B> inject(C c)
        +
        Replaces the first element of this product with the given value.
        +
        +
        Parameters:
        +
        c - The value with which to replace the first element of this product.
        +
        Returns:
        +
        A new product with the first element replaced with the given value.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> List<C> sequenceW(List<F<P2<A,B>,C>> fs)
        +
        Applies a list of comonadic functions to this product, returning a list of values.
        +
        +
        Parameters:
        +
        fs - A list of functions to apply to this product.
        +
        Returns:
        +
        A list of the results of applying the given list of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <C> List<P2<A,C>> traverseList(F<B,List<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <C> Stream<P2<A,C>> traverseStream(F<B,Stream<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<P2<A,C>> traverseIO(F<B,IO<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <C> Option<P2<A,C>> traverseOption(F<B,Option<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <C,X> Either<X,P2<A,C>> traverseEither(F<B,Either<X,C>> f)
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> Stream<C> sequenceW(Stream<F<P2<A,B>,C>> fs)
        +
        Applies a stream of comonadic functions to this product, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this product.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <C> P3<A,B,C> append(C el)
        +
        Creates a P3 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P3 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D> P4<A,B,C,D> append(P2<C,D> el)
        +
        Creates a P4 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E> P5<A,B,C,D,E> append(P3<C,D,E> el)
        +
        Creates a P5 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F> P6<A,B,C,D,E,F> append(P4<C,D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G> P7<A,B,C,D,E,F,G> append(P5<C,D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P6<C,D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P2<A,B> memo()
        +
        Provides a memoising P2 that remembers its values.
        +
        +
        Returns:
        +
        A P2 that calls this P2 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        split_

        +
        public static <A,B,C,D> F<P2<A,B>,P2<C,D>> split_(F<A,C> f,
+                                                  F<B,D> g)
        +
        A first-class version of the split function.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of the given product.
        +
        g - A function that will map the second element of the given product.
        +
        Returns:
        +
        A function that splits a given product between the two given functions and combines their output.
        +
        +
        • +
      + + + +
        +
      • +

        map1_

        +
        public static <A,B,X> F<P2<A,B>,P2<X,B>> map1_(F<A,X> f)
        +
        Promotes a function so that it maps the first element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the first element of products.
        +
        +
        • +
      + + + +
        +
      • +

        map2_

        +
        public static <A,B,X> F<P2<A,B>,P2<A,X>> map2_(F<B,X> f)
        +
        Promotes a function so that it maps the second element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the second element of products.
        +
        +
        • +
      + + + + + +
        +
      • +

        fanout

        +
        public static <B,C,D> P2<C,D> fanout(F<B,C> f,
+                                     F<B,D> g,
+                                     B b)
        +
        Sends the given input value to both argument functions and combines their output.
        +
        +
        Parameters:
        +
        f - A function to receive an input value.
        +
        g - A function to receive an input value.
        +
        b - An input value to send to both functions.
        +
        Returns:
        +
        The product of the two functions applied to the input value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> P2<B,B> map(F<A,B> f,
+                                P2<A,A> p)
        +
        Maps the given function across both the elements of the given product.
        +
        +
        Parameters:
        +
        f - A function to map over a product.
        +
        p - A product over which to map.
        +
        Returns:
        +
        A new product with the given function applied to both elements.
        +
        +
        • +
      + + + +
        +
      • +

        swap_

        +
        public static <A,B> F<P2<A,B>,P2<B,A>> swap_()
        +
        Returns a curried form of swap().
        +
        +
        Returns:
        +
        A curried form of swap().
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B> F<P2<A,B>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B> F<P2<A,B>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F<A,F<B,C>> f)
        +
        Transforms a curried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - a curried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
        +
        Transforms an uncurried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - an uncurried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        untuple

        +
        public static <A,B,C> F2<A,B,C> untuple(F<P2<A,B>,C> f)
        +
        Transforms a function of a product-2 to an uncurried function or arity-2.
        +
        +
        Parameters:
        +
        f - A function of a product-2 to transform into an uncurried function.
        +
        Returns:
        +
        The function, transformed to an uncurried function of arity-2.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P3.html b/javadoc/4.8.1/functionaljava/fj/P3.html new file mode 100644 index 0000000..170c974 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P3.html @@ -0,0 +1,686 @@ + + + + + +P3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P3<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P3<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P3<A,B,C>
+extends java.lang.Object
    +
    A product-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P3() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<P3<A,B,C>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      <D> P4<A,B,C,D>append(D el) +
      Creates a P4 by adding the given element to the current P3
      +
      <D,E> P5<A,B,C,D,E>append(P2<D,E> el) +
      Creates a P5 by adding the given element to the current P3
      +
      <D,E,F> P6<A,B,C,D,E,F>append(P3<D,E,F> el) +
      Creates a P6 by adding the given element to the current P3
      +
      <D,E,F,G> P7<A,B,C,D,E,F,G>append(P4<D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P3
      +
      <D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P5<D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P3
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P3<X,B,C>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P3<A,X,C>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P3<A,B,X>map3(F<C,X> f) +
      Map the third element of the product.
      +
      P3<A,B,C>memo() +
      Provides a memoising P3 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P3

        +
        public P3()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P3<X,B,C> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P3<A,X,C> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P3<A,B,X> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <D> P4<A,B,C,D> append(D el)
        +
        Creates a P4 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E> P5<A,B,C,D,E> append(P2<D,E> el)
        +
        Creates a P5 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F> P6<A,B,C,D,E,F> append(P3<D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G> P7<A,B,C,D,E,F,G> append(P4<D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P5<D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P3<A,B,C> memo()
        +
        Provides a memoising P3 that remembers its values.
        +
        +
        Returns:
        +
        A P3 that calls this P3 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C> F<P3<A,B,C>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C> F<P3<A,B,C>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C> F<P3<A,B,C>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P4.html b/javadoc/4.8.1/functionaljava/fj/P4.html new file mode 100644 index 0000000..4b5b699 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P4.html @@ -0,0 +1,746 @@ + + + + + +P4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P4<A,B,C,D>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P4<A,B,C,D>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P4<A,B,C,D>
+extends java.lang.Object
    +
    A product-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P4() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D> F<P4<A,B,C,D>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,D>__4() +
      Returns a function that returns the fourth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      <E> P5<A,B,C,D,E>append(E el) +
      Creates a P5 by adding the given element to the current P4
      +
      <E,F> P6<A,B,C,D,E,F>append(P2<E,F> el) +
      Creates a P6 by adding the given element to the current P4
      +
      <E,F,G> P7<A,B,C,D,E,F,G>append(P3<E,F,G> el) +
      Creates a P7 by adding the given element to the current P4
      +
      <E,F,G,H> P8<A,B,C,D,E,F,G,H>append(P4<E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P4
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P4<X,B,C,D>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P4<A,X,C,D>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P4<A,B,X,D>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P4<A,B,C,X>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      P4<A,B,C,D>memo() +
      Provides a memoising P4 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P4

        +
        public P4()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P4<X,B,C,D> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P4<A,X,C,D> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P4<A,B,X,D> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P4<A,B,C,X> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <E> P5<A,B,C,D,E> append(E el)
        +
        Creates a P5 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F> P6<A,B,C,D,E,F> append(P2<E,F> el)
        +
        Creates a P6 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G> P7<A,B,C,D,E,F,G> append(P3<E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P4<E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P4<A,B,C,D> memo()
        +
        Provides a memoising P4 that remembers its values.
        +
        +
        Returns:
        +
        A P4 that calls this P4 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P5.html b/javadoc/4.8.1/functionaljava/fj/P5.html new file mode 100644 index 0000000..3494e3d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P5.html @@ -0,0 +1,806 @@ + + + + + +P5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P5<A,B,C,D,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P5<A,B,C,D,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P5<A,B,C,D,E>
+extends java.lang.Object
    +
    A product-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P5() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      <F> P6<A,B,C,D,E,F>append(F el) +
      Creates a P6 by adding the given element to the current P5
      +
      <F,G> P7<A,B,C,D,E,F,G>append(P2<F,G> el) +
      Creates a P7 by adding the given element to the current P5
      +
      <F,G,H> P8<A,B,C,D,E,F,G,H>append(P3<F,G,H> el) +
      Creates a P8 by adding the given element to the current P5
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P5<X,B,C,D,E>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P5<A,X,C,D,E>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P5<A,B,X,D,E>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P5<A,B,C,X,E>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P5<A,B,C,D,X>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      P5<A,B,C,D,E>memo() +
      Provides a memoising P5 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P5

        +
        public P5()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P5<X,B,C,D,E> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P5<A,X,C,D,E> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P5<A,B,X,D,E> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P5<A,B,C,X,E> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P5<A,B,C,D,X> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <F> P6<A,B,C,D,E,F> append(F el)
        +
        Creates a P6 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G> P7<A,B,C,D,E,F,G> append(P2<F,G> el)
        +
        Creates a P7 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G,H> P8<A,B,C,D,E,F,G,H> append(P3<F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P5<A,B,C,D,E> memo()
        +
        Provides a memoising P5 that remembers its values.
        +
        +
        Returns:
        +
        A P5 that calls this P5 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P6.html b/javadoc/4.8.1/functionaljava/fj/P6.html new file mode 100644 index 0000000..c2c754e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P6.html @@ -0,0 +1,866 @@ + + + + + +P6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P6<A,B,C,D,E,F>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P6<A,B,C,D,E,F>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P6<A,B,C,D,E,F>
+extends java.lang.Object
    +
    A product-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P6() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      <G> P7<A,B,C,D,E,F,G>append(G el) +
      Creates a P7 by adding the given element to the current P6
      +
      <G,H> P8<A,B,C,D,E,F,G,H>append(P2<G,H> el) +
      Creates a P8 by adding the given element to the current P6
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P6<X,B,C,D,E,F>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P6<A,X,C,D,E,F>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P6<A,B,X,D,E,F>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P6<A,B,C,X,E,F>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P6<A,B,C,D,X,F>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P6<A,B,C,D,E,X>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      P6<A,B,C,D,E,F>memo() +
      Provides a memoising P6 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P6

        +
        public P6()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P6<X,B,C,D,E,F> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P6<A,X,C,D,E,F> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P6<A,B,X,D,E,F> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P6<A,B,C,X,E,F> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P6<A,B,C,D,X,F> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P6<A,B,C,D,E,X> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <G> P7<A,B,C,D,E,F,G> append(G el)
        +
        Creates a P7 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <G,H> P8<A,B,C,D,E,F,G,H> append(P2<G,H> el)
        +
        Creates a P8 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P6<A,B,C,D,E,F> memo()
        +
        Provides a memoising P6 that remembers its values.
        +
        +
        Returns:
        +
        A P6 that calls this P6 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P7.html b/javadoc/4.8.1/functionaljava/fj/P7.html new file mode 100644 index 0000000..04bceea --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P7.html @@ -0,0 +1,926 @@ + + + + + +P7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P7<A,B,C,D,E,F,G>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P7<A,B,C,D,E,F,G>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P7<A,B,C,D,E,F,G>
+extends java.lang.Object
    +
    A product-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P7() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      <H> P8<A,B,C,D,E,F,G,H>append(H el) +
      Creates a P8 by adding the given element to the current P7
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P7<X,B,C,D,E,F,G>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P7<A,X,C,D,E,F,G>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P7<A,B,X,D,E,F,G>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P7<A,B,C,X,E,F,G>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P7<A,B,C,D,X,F,G>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P7<A,B,C,D,E,X,G>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P7<A,B,C,D,E,F,X>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      P7<A,B,C,D,E,F,G>memo() +
      Provides a memoising P7 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P7

        +
        public P7()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P7<X,B,C,D,E,F,G> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P7<A,X,C,D,E,F,G> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P7<A,B,X,D,E,F,G> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P7<A,B,C,X,E,F,G> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P7<A,B,C,D,X,F,G> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P7<A,B,C,D,E,X,G> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P7<A,B,C,D,E,F,X> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <H> P8<A,B,C,D,E,F,G,H> append(H el)
        +
        Creates a P8 by adding the given element to the current P7
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P7 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P7<A,B,C,D,E,F,G> memo()
        +
        Provides a memoising P7 that remembers its values.
        +
        +
        Returns:
        +
        A P7 that calls this P7 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/P8.html b/javadoc/4.8.1/functionaljava/fj/P8.html new file mode 100644 index 0000000..cead94e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/P8.html @@ -0,0 +1,984 @@ + + + + + +P8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P8<A,B,C,D,E,F,G,H>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P8<A,B,C,D,E,F,G,H>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P8<A,B,C,D,E,F,G,H>
+extends java.lang.Object
    +
    A product-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P8() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,H>      		__8() +
      Returns a function that returns the eighth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      P1<H>_8_() +
      Returns the 1-product projection over the eighth element.
      +
      abstract H_8() +
      Access the eighth element of the product.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P8<X,B,C,D,E,F,G,H>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P8<A,X,C,D,E,F,G,H>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P8<A,B,X,D,E,F,G,H>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P8<A,B,C,X,E,F,G,H>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P8<A,B,C,D,X,F,G,H>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P8<A,B,C,D,E,X,G,H>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P8<A,B,C,D,E,F,X,H>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      <X> P8<A,B,C,D,E,F,G,X>map8(F<H,X> f) +
      Map the eighth element of the product.
      +
      P8<A,B,C,D,E,F,G,H>memo() +
      Provides a memoising P8 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P8

        +
        public P8()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public abstract H _8()
        +
        Access the eighth element of the product.
        +
        +
        Returns:
        +
        The eighth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P8<X,B,C,D,E,F,G,H> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P8<A,X,C,D,E,F,G,H> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P8<A,B,X,D,E,F,G,H> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P8<A,B,C,X,E,F,G,H> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P8<A,B,C,D,X,F,G,H> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P8<A,B,C,D,E,X,G,H> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P8<A,B,C,D,E,F,X,H> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map8

        +
        public final <X> P8<A,B,C,D,E,F,G,X> map8(F<H,X> f)
        +
        Map the eighth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + +
        +
      • +

        _8_

        +
        public final P1<H> _8_()
        +
        Returns the 1-product projection over the eighth element.
        +
        +
        Returns:
        +
        the 1-product projection over the eighth element.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P8<A,B,C,D,E,F,G,H> memo()
        +
        Provides a memoising P8 that remembers its values.
        +
        +
        Returns:
        +
        A P8 that calls this P8 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,H> __8()
        +
        Returns a function that returns the eighth element of a product.
        +
        +
        Returns:
        +
        A function that returns the eighth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Primitive.html b/javadoc/4.8.1/functionaljava/fj/Primitive.html new file mode 100644 index 0000000..82b8672 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Primitive.html @@ -0,0 +1,1121 @@ + + + + + +Primitive (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Primitive

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Primitive
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Primitive
+extends java.lang.Object
    +
    Functions that convert between Java primitive types.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,java.lang.Byte>Boolean_Byte +
      A function that converts booleans to bytes.
      +
      static F<java.lang.Boolean,java.lang.Character>Boolean_Character +
      A function that converts booleans to characters.
      +
      static F<java.lang.Boolean,java.lang.Double>Boolean_Double +
      A function that converts booleans to doubles.
      +
      static F<java.lang.Boolean,java.lang.Float>Boolean_Float +
      A function that converts booleans to floats.
      +
      static F<java.lang.Boolean,java.lang.Integer>Boolean_Integer +
      A function that converts booleans to integers.
      +
      static F<java.lang.Boolean,java.lang.Long>Boolean_Long +
      A function that converts booleans to longs.
      +
      static F<java.lang.Boolean,java.lang.Short>Boolean_Short +
      A function that converts booleans to shorts.
      +
      static F<java.lang.Byte,java.lang.Boolean>Byte_Boolean +
      A function that converts bytes to booleans.
      +
      static F<java.lang.Byte,java.lang.Character>Byte_Character +
      A function that converts bytes to characters.
      +
      static F<java.lang.Byte,java.lang.Double>Byte_Double +
      A function that converts bytes to doubles.
      +
      static F<java.lang.Byte,java.lang.Float>Byte_Float +
      A function that converts bytes to floats.
      +
      static F<java.lang.Byte,java.lang.Integer>Byte_Integer +
      A function that converts bytes to integers.
      +
      static F<java.lang.Byte,java.lang.Long>Byte_Long +
      A function that converts bytes to longs.
      +
      static F<java.lang.Byte,java.lang.Short>Byte_Short +
      A function that converts bytes to shorts.
      +
      static F<java.lang.Character,java.lang.Boolean>Character_Boolean +
      A function that converts characters to booleans.
      +
      static F<java.lang.Character,java.lang.Byte>Character_Byte +
      A function that converts characters to bytes.
      +
      static F<java.lang.Character,java.lang.Double>Character_Double +
      A function that converts characters to doubles.
      +
      static F<java.lang.Character,java.lang.Float>Character_Float +
      A function that converts characters to floats.
      +
      static F<java.lang.Character,java.lang.Integer>Character_Integer +
      A function that converts characters to integers.
      +
      static F<java.lang.Character,java.lang.Long>Character_Long +
      A function that converts characters to longs.
      +
      static F<java.lang.Character,java.lang.Short>Character_Short +
      A function that converts characters to shorts.
      +
      static F<java.lang.Double,java.lang.Boolean>Double_Boolean +
      A function that converts doubles to booleans.
      +
      static F<java.lang.Double,java.lang.Byte>Double_Byte +
      A function that converts doubles to bytes.
      +
      static F<java.lang.Double,java.lang.Character>Double_Character +
      A function that converts doubles to characters.
      +
      static F<java.lang.Double,java.lang.Float>Double_Float +
      A function that converts doubles to floats.
      +
      static F<java.lang.Double,java.lang.Integer>Double_Integer +
      A function that converts doubles to integers.
      +
      static F<java.lang.Double,java.lang.Long>Double_Long +
      A function that converts doubles to longs.
      +
      static F<java.lang.Double,java.lang.Short>Double_Short +
      A function that converts doubles to shorts.
      +
      static F<java.lang.Float,java.lang.Boolean>Float_Boolean +
      A function that converts floats to booleans.
      +
      static F<java.lang.Float,java.lang.Byte>Float_Byte +
      A function that converts floats to bytes.
      +
      static F<java.lang.Float,java.lang.Character>Float_Character +
      A function that converts floats to characters.
      +
      static F<java.lang.Float,java.lang.Double>Float_Double +
      A function that converts floats to doubles.
      +
      static F<java.lang.Float,java.lang.Integer>Float_Integer +
      A function that converts floats to integers.
      +
      static F<java.lang.Float,java.lang.Long>Float_Long +
      A function that converts floats to longs.
      +
      static F<java.lang.Float,java.lang.Short>Float_Short +
      A function that converts floats to shorts.
      +
      static F<java.lang.Integer,java.lang.Boolean>Integer_Boolean +
      A function that converts integers to booleans.
      +
      static F<java.lang.Integer,java.lang.Byte>Integer_Byte +
      A function that converts integers to bytes.
      +
      static F<java.lang.Integer,java.lang.Character>Integer_Character +
      A function that converts integers to characters.
      +
      static F<java.lang.Integer,java.lang.Double>Integer_Double +
      A function that converts integers to doubles.
      +
      static F<java.lang.Integer,java.lang.Float>Integer_Float +
      A function that converts integers to floats.
      +
      static F<java.lang.Integer,java.lang.Long>Integer_Long +
      A function that converts integers to longs.
      +
      static F<java.lang.Integer,java.lang.Short>Integer_Short +
      A function that converts integers to shorts.
      +
      static F<java.lang.Long,java.lang.Boolean>Long_Boolean +
      A function that converts longs to booleans.
      +
      static F<java.lang.Long,java.lang.Byte>Long_Byte +
      A function that converts longs to bytes.
      +
      static F<java.lang.Long,java.lang.Character>Long_Character +
      A function that converts longs to characters.
      +
      static F<java.lang.Long,java.lang.Double>Long_Double +
      A function that converts longs to doubles.
      +
      static F<java.lang.Long,java.lang.Float>Long_Float +
      A function that converts longs to floats.
      +
      static F<java.lang.Long,java.lang.Integer>Long_Integer +
      A function that converts longs to integers.
      +
      static F<java.lang.Long,java.lang.Short>Long_Short +
      A function that converts longs to shorts.
      +
      static F<java.lang.Short,java.lang.Boolean>Short_Boolean +
      A function that converts shorts to booleans.
      +
      static F<java.lang.Short,java.lang.Byte>Short_Byte +
      A function that converts shorts to bytes.
      +
      static F<java.lang.Short,java.lang.Character>Short_Character +
      A function that converts shorts to characters.
      +
      static F<java.lang.Short,java.lang.Double>Short_Double +
      A function that converts shorts to doubles.
      +
      static F<java.lang.Short,java.lang.Float>Short_Float +
      A function that converts shorts to floats.
      +
      static F<java.lang.Short,java.lang.Integer>Short_Integer +
      A function that converts shorts to integers.
      +
      static F<java.lang.Short,java.lang.Long>Short_Long +
      A function that converts shorts to longs.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        Boolean_Byte

        +
        public static final F<java.lang.Boolean,java.lang.Byte> Boolean_Byte
        +
        A function that converts booleans to bytes.
        +
        • +
      + + + +
        +
      • +

        Boolean_Character

        +
        public static final F<java.lang.Boolean,java.lang.Character> Boolean_Character
        +
        A function that converts booleans to characters.
        +
        • +
      + + + +
        +
      • +

        Boolean_Double

        +
        public static final F<java.lang.Boolean,java.lang.Double> Boolean_Double
        +
        A function that converts booleans to doubles.
        +
        • +
      + + + +
        +
      • +

        Boolean_Float

        +
        public static final F<java.lang.Boolean,java.lang.Float> Boolean_Float
        +
        A function that converts booleans to floats.
        +
        • +
      + + + +
        +
      • +

        Boolean_Integer

        +
        public static final F<java.lang.Boolean,java.lang.Integer> Boolean_Integer
        +
        A function that converts booleans to integers.
        +
        • +
      + + + +
        +
      • +

        Boolean_Long

        +
        public static final F<java.lang.Boolean,java.lang.Long> Boolean_Long
        +
        A function that converts booleans to longs.
        +
        • +
      + + + +
        +
      • +

        Boolean_Short

        +
        public static final F<java.lang.Boolean,java.lang.Short> Boolean_Short
        +
        A function that converts booleans to shorts.
        +
        • +
      + + + +
        +
      • +

        Byte_Boolean

        +
        public static final F<java.lang.Byte,java.lang.Boolean> Byte_Boolean
        +
        A function that converts bytes to booleans.
        +
        • +
      + + + +
        +
      • +

        Byte_Character

        +
        public static final F<java.lang.Byte,java.lang.Character> Byte_Character
        +
        A function that converts bytes to characters.
        +
        • +
      + + + +
        +
      • +

        Byte_Double

        +
        public static final F<java.lang.Byte,java.lang.Double> Byte_Double
        +
        A function that converts bytes to doubles.
        +
        • +
      + + + +
        +
      • +

        Byte_Float

        +
        public static final F<java.lang.Byte,java.lang.Float> Byte_Float
        +
        A function that converts bytes to floats.
        +
        • +
      + + + +
        +
      • +

        Byte_Integer

        +
        public static final F<java.lang.Byte,java.lang.Integer> Byte_Integer
        +
        A function that converts bytes to integers.
        +
        • +
      + + + +
        +
      • +

        Byte_Long

        +
        public static final F<java.lang.Byte,java.lang.Long> Byte_Long
        +
        A function that converts bytes to longs.
        +
        • +
      + + + +
        +
      • +

        Byte_Short

        +
        public static final F<java.lang.Byte,java.lang.Short> Byte_Short
        +
        A function that converts bytes to shorts.
        +
        • +
      + + + +
        +
      • +

        Character_Boolean

        +
        public static final F<java.lang.Character,java.lang.Boolean> Character_Boolean
        +
        A function that converts characters to booleans.
        +
        • +
      + + + +
        +
      • +

        Character_Byte

        +
        public static final F<java.lang.Character,java.lang.Byte> Character_Byte
        +
        A function that converts characters to bytes.
        +
        • +
      + + + +
        +
      • +

        Character_Double

        +
        public static final F<java.lang.Character,java.lang.Double> Character_Double
        +
        A function that converts characters to doubles.
        +
        • +
      + + + +
        +
      • +

        Character_Float

        +
        public static final F<java.lang.Character,java.lang.Float> Character_Float
        +
        A function that converts characters to floats.
        +
        • +
      + + + +
        +
      • +

        Character_Integer

        +
        public static final F<java.lang.Character,java.lang.Integer> Character_Integer
        +
        A function that converts characters to integers.
        +
        • +
      + + + +
        +
      • +

        Character_Long

        +
        public static final F<java.lang.Character,java.lang.Long> Character_Long
        +
        A function that converts characters to longs.
        +
        • +
      + + + +
        +
      • +

        Character_Short

        +
        public static final F<java.lang.Character,java.lang.Short> Character_Short
        +
        A function that converts characters to shorts.
        +
        • +
      + + + +
        +
      • +

        Double_Boolean

        +
        public static final F<java.lang.Double,java.lang.Boolean> Double_Boolean
        +
        A function that converts doubles to booleans.
        +
        • +
      + + + +
        +
      • +

        Double_Byte

        +
        public static final F<java.lang.Double,java.lang.Byte> Double_Byte
        +
        A function that converts doubles to bytes.
        +
        • +
      + + + +
        +
      • +

        Double_Character

        +
        public static final F<java.lang.Double,java.lang.Character> Double_Character
        +
        A function that converts doubles to characters.
        +
        • +
      + + + +
        +
      • +

        Double_Float

        +
        public static final F<java.lang.Double,java.lang.Float> Double_Float
        +
        A function that converts doubles to floats.
        +
        • +
      + + + +
        +
      • +

        Double_Integer

        +
        public static final F<java.lang.Double,java.lang.Integer> Double_Integer
        +
        A function that converts doubles to integers.
        +
        • +
      + + + +
        +
      • +

        Double_Long

        +
        public static final F<java.lang.Double,java.lang.Long> Double_Long
        +
        A function that converts doubles to longs.
        +
        • +
      + + + +
        +
      • +

        Double_Short

        +
        public static final F<java.lang.Double,java.lang.Short> Double_Short
        +
        A function that converts doubles to shorts.
        +
        • +
      + + + +
        +
      • +

        Float_Boolean

        +
        public static final F<java.lang.Float,java.lang.Boolean> Float_Boolean
        +
        A function that converts floats to booleans.
        +
        • +
      + + + +
        +
      • +

        Float_Byte

        +
        public static final F<java.lang.Float,java.lang.Byte> Float_Byte
        +
        A function that converts floats to bytes.
        +
        • +
      + + + +
        +
      • +

        Float_Character

        +
        public static final F<java.lang.Float,java.lang.Character> Float_Character
        +
        A function that converts floats to characters.
        +
        • +
      + + + +
        +
      • +

        Float_Double

        +
        public static final F<java.lang.Float,java.lang.Double> Float_Double
        +
        A function that converts floats to doubles.
        +
        • +
      + + + +
        +
      • +

        Float_Integer

        +
        public static final F<java.lang.Float,java.lang.Integer> Float_Integer
        +
        A function that converts floats to integers.
        +
        • +
      + + + +
        +
      • +

        Float_Long

        +
        public static final F<java.lang.Float,java.lang.Long> Float_Long
        +
        A function that converts floats to longs.
        +
        • +
      + + + +
        +
      • +

        Float_Short

        +
        public static final F<java.lang.Float,java.lang.Short> Float_Short
        +
        A function that converts floats to shorts.
        +
        • +
      + + + +
        +
      • +

        Integer_Boolean

        +
        public static final F<java.lang.Integer,java.lang.Boolean> Integer_Boolean
        +
        A function that converts integers to booleans.
        +
        • +
      + + + +
        +
      • +

        Integer_Byte

        +
        public static final F<java.lang.Integer,java.lang.Byte> Integer_Byte
        +
        A function that converts integers to bytes.
        +
        • +
      + + + +
        +
      • +

        Integer_Character

        +
        public static final F<java.lang.Integer,java.lang.Character> Integer_Character
        +
        A function that converts integers to characters.
        +
        • +
      + + + +
        +
      • +

        Integer_Double

        +
        public static final F<java.lang.Integer,java.lang.Double> Integer_Double
        +
        A function that converts integers to doubles.
        +
        • +
      + + + +
        +
      • +

        Integer_Float

        +
        public static final F<java.lang.Integer,java.lang.Float> Integer_Float
        +
        A function that converts integers to floats.
        +
        • +
      + + + +
        +
      • +

        Integer_Long

        +
        public static final F<java.lang.Integer,java.lang.Long> Integer_Long
        +
        A function that converts integers to longs.
        +
        • +
      + + + +
        +
      • +

        Integer_Short

        +
        public static final F<java.lang.Integer,java.lang.Short> Integer_Short
        +
        A function that converts integers to shorts.
        +
        • +
      + + + +
        +
      • +

        Long_Boolean

        +
        public static final F<java.lang.Long,java.lang.Boolean> Long_Boolean
        +
        A function that converts longs to booleans.
        +
        • +
      + + + +
        +
      • +

        Long_Byte

        +
        public static final F<java.lang.Long,java.lang.Byte> Long_Byte
        +
        A function that converts longs to bytes.
        +
        • +
      + + + +
        +
      • +

        Long_Character

        +
        public static final F<java.lang.Long,java.lang.Character> Long_Character
        +
        A function that converts longs to characters.
        +
        • +
      + + + +
        +
      • +

        Long_Double

        +
        public static final F<java.lang.Long,java.lang.Double> Long_Double
        +
        A function that converts longs to doubles.
        +
        • +
      + + + +
        +
      • +

        Long_Float

        +
        public static final F<java.lang.Long,java.lang.Float> Long_Float
        +
        A function that converts longs to floats.
        +
        • +
      + + + +
        +
      • +

        Long_Integer

        +
        public static final F<java.lang.Long,java.lang.Integer> Long_Integer
        +
        A function that converts longs to integers.
        +
        • +
      + + + +
        +
      • +

        Long_Short

        +
        public static final F<java.lang.Long,java.lang.Short> Long_Short
        +
        A function that converts longs to shorts.
        +
        • +
      + + + +
        +
      • +

        Short_Boolean

        +
        public static final F<java.lang.Short,java.lang.Boolean> Short_Boolean
        +
        A function that converts shorts to booleans.
        +
        • +
      + + + +
        +
      • +

        Short_Byte

        +
        public static final F<java.lang.Short,java.lang.Byte> Short_Byte
        +
        A function that converts shorts to bytes.
        +
        • +
      + + + +
        +
      • +

        Short_Character

        +
        public static final F<java.lang.Short,java.lang.Character> Short_Character
        +
        A function that converts shorts to characters.
        +
        • +
      + + + +
        +
      • +

        Short_Double

        +
        public static final F<java.lang.Short,java.lang.Double> Short_Double
        +
        A function that converts shorts to doubles.
        +
        • +
      + + + +
        +
      • +

        Short_Float

        +
        public static final F<java.lang.Short,java.lang.Float> Short_Float
        +
        A function that converts shorts to floats.
        +
        • +
      + + + +
        +
      • +

        Short_Integer

        +
        public static final F<java.lang.Short,java.lang.Integer> Short_Integer
        +
        A function that converts shorts to integers.
        +
        • +
      + + + +
        +
      • +

        Short_Long

        +
        public static final F<java.lang.Short,java.lang.Long> Short_Long
        +
        A function that converts shorts to longs.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Rng.html b/javadoc/4.8.1/functionaljava/fj/Rng.html new file mode 100644 index 0000000..d60ddc3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Rng.html @@ -0,0 +1,315 @@ + + + + + +Rng (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Rng

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Rng
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    LcgRng
    +
    +
    +
    +
    public abstract class Rng
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Rng() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Rng

        +
        public Rng()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextInt

        +
        public abstract P2<Rng,java.lang.Integer> nextInt()
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public abstract P2<Rng,java.lang.Long> nextLong()
        +
        • +
      + + + +
        +
      • +

        range

        +
        public final P2<Rng,java.lang.Integer> range(int low,
+                                             int high)
        +
        • +
      + + + +
        +
      • +

        nextNatural

        +
        public final P2<Rng,java.lang.Integer> nextNatural()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Semigroup.AltDefinition.html b/javadoc/4.8.1/functionaljava/fj/Semigroup.AltDefinition.html new file mode 100644 index 0000000..5a26731 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Semigroup.AltDefinition.html @@ -0,0 +1,263 @@ + + + + + +Semigroup.AltDefinition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Semigroup.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Semigroup<A>
    +
    +
    +
    +
    public static interface Semigroup.AltDefinition<A>
+extends Semigroup.Definition<A>
    +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Semigroup.Definition.html b/javadoc/4.8.1/functionaljava/fj/Semigroup.Definition.html new file mode 100644 index 0000000..3c71f32 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Semigroup.Definition.html @@ -0,0 +1,294 @@ + + + + + +Semigroup.Definition (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Semigroup.html b/javadoc/4.8.1/functionaljava/fj/Semigroup.html new file mode 100644 index 0000000..7c4e9ce --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Semigroup.html @@ -0,0 +1,1356 @@ + + + + + +Semigroup (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Semigroup<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Semigroup<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Semigroup<A>
+extends java.lang.Object
    +
    Implementations must satisfy the law of associativity: +
      +
    • Associativity; forall x. forall y. forall z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionSemigroup

        +
        public static final Semigroup<java.lang.Integer> intAdditionSemigroup
        +
        A semigroup that adds integers.
        +
        • +
      + + + +
        +
      • +

        doubleAdditionSemigroup

        +
        @Deprecated
+public static final Semigroup<java.lang.Double> doubleAdditionSemigroup
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        intMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMultiplicationSemigroup
        +
        A semigroup that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        doubleMultiplicationSemigroup

        +
        @Deprecated
+public static final Semigroup<java.lang.Double> doubleMultiplicationSemigroup
        +
        Deprecated. Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
        +
        • +
      + + + +
        +
      • +

        intMaximumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMaximumSemigroup
        +
        A semigroup that yields the maximum of integers.
        +
        • +
      + + + +
        +
      • +

        intMinimumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMinimumSemigroup
        +
        A semigroup that yields the minimum of integers.
        +
        • +
      + + + +
        +
      • +

        bigintAdditionSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintAdditionSemigroup
        +
        A semigroup that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMultiplicationSemigroup
        +
        A semigroup that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMaximumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMaximumSemigroup
        +
        A semigroup that yields the maximum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMinimumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMinimumSemigroup
        +
        A semigroup that yields the minimum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalAdditionSemigroup
        +
        A semigroup that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalMultiplicationSemigroup
        +
        A semigroup that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMaximumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMaximumSemigroup
        +
        A semigroup that yields the maximum of big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMinimumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMinimumSemigroup
        +
        A semigroup that yields the minimum of big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationSemigroup

        +
        public static final Semigroup<Natural> naturalMultiplicationSemigroup
        +
        A semigroup that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionSemigroup

        +
        public static final Semigroup<Natural> naturalAdditionSemigroup
        +
        A semigroup that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMaximumSemigroup

        +
        public static final Semigroup<Natural> naturalMaximumSemigroup
        +
        A semigroup that yields the maximum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMinimumSemigroup

        +
        public static final Semigroup<Natural> naturalMinimumSemigroup
        +
        A semigroup that yields the minimum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionSemigroup

        +
        public static final Semigroup<java.lang.Long> longAdditionSemigroup
        +
        A semigroup that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Long> longMultiplicationSemigroup
        +
        A semigroup that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        longMaximumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMaximumSemigroup
        +
        A semigroup that yields the maximum of longs.
        +
        • +
      + + + +
        +
      • +

        longMinimumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMinimumSemigroup
        +
        A semigroup that yields the minimum of longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> disjunctionSemigroup
        +
        A semigroup that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionSemiGroup

        +
        public static final Semigroup<java.lang.Boolean> exclusiveDisjunctionSemiGroup
        +
        A semigroup that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> conjunctionSemigroup
        +
        A semigroup that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringSemigroup

        +
        public static final Semigroup<java.lang.String> stringSemigroup
        +
        A semigroup that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferSemigroup

        +
        public static final Semigroup<java.lang.StringBuffer> stringBufferSemigroup
        +
        A semigroup that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderSemigroup

        +
        public static final Semigroup<java.lang.StringBuilder> stringBuilderSemigroup
        +
        A semigroup that appends string builders.
        +
        • +
      + + + +
        +
      • +

        unitSemigroup

        +
        public static final Semigroup<Unit> unitSemigroup
        +
        A semigroup for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this semigroup.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this semigroup.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this semigroup.
        +
        +
        Returns:
        +
        A function that sums according to this semigroup.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply1p

        +
        public A multiply1p(int n,
+                    A a)
        +
        Returns a value summed n + 1 times ( + a + a + ... + a) The default definition uses peasant + multiplication, exploiting associativity to only require O(log n) uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed n + 1 times
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumNel

        +
        public A sumNel(NonEmptyList<A> as)
        +
        Sums the given values with left-fold.
        +
        • +
      + + + + + +
        +
      • +

        sumStream

        +
        public A sumStream(A a,
+                   F0<Stream<A>> as)
        +
        Sums the given values with left-fold, shortcutting the computation as early as possible.
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Semigroup<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public Monoid<Option<A>> lift()
        +
        Lifts the semigroup to obtain a trivial monoid.
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Semigroup<B> xmap(F<A,B> f,
+                             F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + + + + + + + +
        +
      • +

        monoid

        +
        public Monoid<A> monoid(A zero)
        +
        Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.Definition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.AltDefinition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F<A,F<A,A>> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F2<A,A,A> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(Definition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        firstSemigroup

        +
        public static <A> Semigroup<A> firstSemigroup()
        +
        A semigroup which always uses the "first" (left-hand side) value.
        +
        • +
      + + + +
        +
      • +

        lastSemigroup

        +
        public static <A> Semigroup<A> lastSemigroup()
        +
        A semigroup which always uses the "last" (right-hand side) value.
        +
        • +
      + + + +
        +
      • +

        functionSemigroup

        +
        public static <A,B> Semigroup<F<A,B>> functionSemigroup(Semigroup<B> sb)
        +
        A semigroup for functions.
        +
        +
        Parameters:
        +
        sb - The smeigroup for the codomain.
        +
        Returns:
        +
        A semigroup for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listSemigroup

        +
        public static <A> Semigroup<List<A>> listSemigroup()
        +
        A semigroup for lists.
        +
        +
        Returns:
        +
        A semigroup for lists.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListSemigroup

        +
        public static <A> Semigroup<NonEmptyList<A>> nonEmptyListSemigroup()
        +
        A semigroup for non-empty lists.
        +
        +
        Returns:
        +
        A semigroup for non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionSemigroup

        +
        @Deprecated
+public static <A> Semigroup<Option<A>> optionSemigroup()
        +
        Deprecated. since 4.7. Use firstOptionSemigroup().
        +
        A semigroup for optional values.
        +
        +
        Returns:
        +
        A semigroup for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> firstOptionSemigroup()
        +
        A semigroup for optional values that take the first available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> lastOptionSemigroup()
        +
        A semigroup for optional values that take the last available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamSemigroup

        +
        public static <A> Semigroup<Stream<A>> streamSemigroup()
        +
        A semigroup for streams.
        +
        +
        Returns:
        +
        A semigroup for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arraySemigroup

        +
        public static <A> Semigroup<Array<A>> arraySemigroup()
        +
        A semigroup for arrays.
        +
        +
        Returns:
        +
        A semigroup for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        p1Semigroup

        +
        public static <A> Semigroup<P1<A>> p1Semigroup(Semigroup<A> sa)
        +
        A lazy semigroup for unary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's type.
        +
        Returns:
        +
        A semigroup for unary products.
        +
        +
        • +
      + + + +
        +
      • +

        p2Semigroup

        +
        public static <A,B> Semigroup<P2<A,B>> p2Semigroup(Semigroup<A> sa,
+                                                   Semigroup<B> sb)
        +
        A lazy semigroup for binary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's first type.
        +
        sb - A semigroup for the product's second type.
        +
        Returns:
        +
        A semigroup for binary products.
        +
        +
        • +
      + + + +
        +
      • +

        ioSemigroup

        +
        public static <A> Semigroup<IO<A>> ioSemigroup(Semigroup<A> sa)
        +
        A semigroup for IO values.
        +
        • +
      + + + +
        +
      • +

        setSemigroup

        +
        public static <A> Semigroup<Set<A>> setSemigroup()
        +
        A semigroup for sets.
        +
        +
        Returns:
        +
        a semigroup for sets.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Show.html b/javadoc/4.8.1/functionaljava/fj/Show.html new file mode 100644 index 0000000..3a95a82 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Show.html @@ -0,0 +1,1759 @@ + + + + + +Show (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Show<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Show<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Show<A>
+extends java.lang.Object
    +
    Renders an object for display.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanShow

        +
        public static final Show<java.lang.Boolean> booleanShow
        +
        A show instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteShow

        +
        public static final Show<java.lang.Byte> byteShow
        +
        A show instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charShow

        +
        public static final Show<java.lang.Character> charShow
        +
        A show instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleShow

        +
        public static final Show<java.lang.Double> doubleShow
        +
        A show instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatShow

        +
        public static final Show<java.lang.Float> floatShow
        +
        A show instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intShow

        +
        public static final Show<java.lang.Integer> intShow
        +
        A show instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintShow

        +
        public static final Show<java.math.BigInteger> bigintShow
        +
        A show instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalShow

        +
        public static final Show<java.math.BigDecimal> bigdecimalShow
        +
        A show instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longShow

        +
        public static final Show<java.lang.Long> longShow
        +
        A show instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortShow

        +
        public static final Show<java.lang.Short> shortShow
        +
        A show instance for the short type.
        +
        • +
      + + + +
        +
      • +

        stringShow

        +
        public static final Show<java.lang.String> stringShow
        +
        A show instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferShow

        +
        public static final Show<java.lang.StringBuffer> stringBufferShow
        +
        A show instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderShow

        +
        public static final Show<java.lang.StringBuilder> stringBuilderShow
        +
        A show instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        naturalShow

        +
        public static final Show<Natural> naturalShow
        +
        A show instance for natural numbers.
        +
        • +
      + + + +
        +
      • +

        lazyStringShow

        +
        public static final Show<LazyString> lazyStringShow
        +
        A show instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static final Show<HList.HNil> HListShow
        +
        A show instance for the empty heterogeneous Stream.
        +
        • +
      + + + +
        +
      • +

        bitSetShow

        +
        public static final Show<BitSet> bitSetShow
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        contramap

        +
        public <B> Show<B> contramap(F<B,A> f)
        +
        Maps the given function across this show as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new show.
        +
        +
        • +
      + + + + + +
        +
      • +

        show

        +
        public Stream<java.lang.Character> show(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showl

        +
        public List<java.lang.Character> showl(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showS

        +
        public java.lang.String showS(A a)
        +
        Returns the display rendering of the given argument as a String.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument as a String.
        +
        +
        • +
      + + + +
        +
      • +

        showS_

        +
        public F<A,java.lang.String> showS_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + +
        +
      • +

        show_

        +
        public F<A,Stream<java.lang.Character>> show_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + + + +
        +
      • +

        println

        +
        public Unit println(A a)
        +
        Prints the given argument to the standard output stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        print

        +
        public Unit print(A a)
        +
        Prints the given argument to the standard output stream.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        printlnE

        +
        public void printlnE(A a)
        +
        Prints the given argument to the standard error stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<A> show(F<A,Stream<java.lang.Character>> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        showS

        +
        public static <A> Show<A> showS(F<A,java.lang.String> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        anyShow

        +
        public static <A> Show<A> anyShow()
        +
        Returns a show instance that uses Object.toString() to perform the display rendering.
        +
        +
        Returns:
        +
        A show instance that uses Object.toString() to perform the display rendering.
        +
        +
        • +
      + + + +
        +
      • +

        optionShow

        +
        public static <A> Show<Option<A>> optionShow(Show<A> sa)
        +
        A show instance for the Option type.
        +
        +
        Parameters:
        +
        sa - Show for the element of the option.
        +
        Returns:
        +
        A show instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherShow

        +
        public static <A,B> Show<Either<A,B>> eitherShow(Show<A> sa,
+                                                 Show<B> sb)
        +
        A show instance for the Either type.
        +
        +
        Parameters:
        +
        sa - Show for the left side of the Either.
        +
        sb - Show for the right side of the Either.
        +
        Returns:
        +
        A show instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        resultShow

        +
        public static <I,A> Show<Result<I,A>> resultShow(Show<A> sa,
+                                                 Show<I> si)
        +
        A show instance for the Result type.
        +
        +
        Parameters:
        +
        sa - Show for the Result value.
        +
        si - Show for the Result remainder.
        +
        Returns:
        +
        A show instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationShow

        +
        public static <A,B> Show<Validation<A,B>> validationShow(Show<A> sa,
+                                                         Show<B> sb)
        +
        A show instance for the Validation type.
        +
        +
        Parameters:
        +
        sa - Show for the fail side of the Validation.
        +
        sb - Show for the success side of the Validation.
        +
        Returns:
        +
        A show instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listShow

        +
        public static <A> Show<List<A>> listShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the Stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListShow

        +
        public static <A> Show<NonEmptyList<A>> nonEmptyListShow(Show<A> sa)
        +
        A show instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the non-empty Stream.
        +
        Returns:
        +
        A show instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        treeShow

        +
        public static <A> Show<Tree<A>> treeShow(Show<A> sa)
        +
        A show instance for the Tree type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the tree.
        +
        Returns:
        +
        A show instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        digitShow

        +
        public static <V,A> Show<Digit<V,A>> digitShow(Show<V> sv,
+                                               Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        nodeShow

        +
        public static <V,A> Show<Node<V,A>> nodeShow(Show<V> sv,
+                                             Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        fingerTreeShow

        +
        public static <V,A> Show<FingerTree<V,A>> fingerTreeShow(Show<V> sv,
+                                                         Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        seqShow

        +
        public static <A> Show<Seq<A>> seqShow(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        setShow

        +
        public static <A> Show<Set<A>> setShow(Show<A> sa)
        +
        A show instance for the Set type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the set.
        +
        Returns:
        +
        A show instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapShow

        +
        public static <K,V> Show<TreeMap<K,V>> treeMapShow(Show<K> sk,
+                                                   Show<V> sv)
        +
        A show instance for the TreeMap type.
        +
        +
        Parameters:
        +
        sk - Show for the keys of the TreeMap.
        +
        sv - Show for the values of the TreeMap.
        +
        Returns:
        +
        A show instance for the TreeMap type.
        +
        +
        • +
      + + + +
        +
      • +

        p2MapShow

        +
        public static <A,B> Show<P2<A,B>> p2MapShow(Show<A> sa,
+                                            Show<B> sb)
        +
        A show instance for the tuple-2 type in the style of a mapping from A to B.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb,
+                                         java.lang.String start,
+                                         java.lang.String sep,
+                                         java.lang.String end)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the tuple.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa,
+                                             java.lang.String start,
+                                             java.lang.String sep,
+                                             java.lang.String end)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the stream.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow_

        +
        public static <A> F<Stream<A>,Stream<java.lang.Character>> streamShow_(Show<A> sa,
+                                                                       java.lang.String start,
+                                                                       java.lang.String sep,
+                                                                       java.lang.String end)
        +
        Returns the transformation equivalent for the stream show.
        +
        • +
      + + + +
        +
      • +

        arrayShow

        +
        public static <A> Show<Array<A>> arrayShow(Show<A> sa)
        +
        A show instance for the Array type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the array.
        +
        Returns:
        +
        A show instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        classShow

        +
        public static <A> Show<Class<A>> classShow()
        +
        A show instance for the Class type.
        +
        +
        Returns:
        +
        A show instance for the Class type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Show

        +
        public static <A> Show<P1<A>> p1Show(Show<A> sa)
        +
        A show instance for the tuple-1 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-1 type.
        +
        +
        • +
      + + + +
        +
      • +

        p1ShowLazy

        +
        public static <A> Show<P1<A>> p1ShowLazy(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p1ShowEager

        +
        public static <A> Show<P1<A>> p1ShowEager(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p3Show

        +
        public static <A,B,C> Show<P3<A,B,C>> p3Show(Show<A> sa,
+                                             Show<B> sb,
+                                             Show<C> sc)
        +
        A show instance for the tuple-3 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-3 type.
        +
        +
        • +
      + + + +
        +
      • +

        p4Show

        +
        public static <A,B,C,D> Show<P4<A,B,C,D>> p4Show(Show<A> sa,
+                                                 Show<B> sb,
+                                                 Show<C> sc,
+                                                 Show<D> sd)
        +
        A show instance for the tuple-4 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-4 type.
        +
        +
        • +
      + + + +
        +
      • +

        p5Show

        +
        public static <A,B,C,D,E> Show<P5<A,B,C,D,E>> p5Show(Show<A> sa,
+                                                     Show<B> sb,
+                                                     Show<C> sc,
+                                                     Show<D> sd,
+                                                     Show<E> se)
        +
        A show instance for the tuple-5 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-5 type.
        +
        +
        • +
      + + + +
        +
      • +

        p6Show

        +
        public static <A,B,C,D,E,F$> Show<P6<A,B,C,D,E,F$>> p6Show(Show<A> sa,
+                                                           Show<B> sb,
+                                                           Show<C> sc,
+                                                           Show<D> sd,
+                                                           Show<E> se,
+                                                           Show<F$> sf)
        +
        A show instance for the tuple-6 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-6 type.
        +
        +
        • +
      + + + +
        +
      • +

        p7Show

        +
        public static <A,B,C,D,E,F$,G> Show<P7<A,B,C,D,E,F$,G>> p7Show(Show<A> sa,
+                                                               Show<B> sb,
+                                                               Show<C> sc,
+                                                               Show<D> sd,
+                                                               Show<E> se,
+                                                               Show<F$> sf,
+                                                               Show<G> sg)
        +
        A show instance for the tuple-7 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-7 type.
        +
        +
        • +
      + + + +
        +
      • +

        p8Show

        +
        public static <A,B,C,D,E,F$,G,H> Show<P8<A,B,C,D,E,F$,G,H>> p8Show(Show<A> sa,
+                                                                   Show<B> sb,
+                                                                   Show<C> sc,
+                                                                   Show<D> sd,
+                                                                   Show<E> se,
+                                                                   Show<F$> sf,
+                                                                   Show<G> sg,
+                                                                   Show<H> sh)
        +
        A show instance for the tuple-8 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        sh - Show for the eighth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-8 type.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        v2Show

        +
        public static <A> Show<V2<A>> v2Show(Show<A> ea)
        +
        A show instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Show

        +
        public static <A> Show<V3<A>> v3Show(Show<A> ea)
        +
        A show instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Show

        +
        public static <A> Show<V4<A>> v4Show(Show<A> ea)
        +
        A show instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Show

        +
        public static <A> Show<V5<A>> v5Show(Show<A> ea)
        +
        A show instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Show

        +
        public static <A> Show<V6<A>> v6Show(Show<A> ea)
        +
        A show instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Show

        +
        public static <A> Show<V7<A>> v7Show(Show<A> ea)
        +
        A show instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Show

        +
        public static <A> Show<V8<A>> v8Show(Show<A> ea)
        +
        A show instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        unlineShow

        +
        public static <A> Show<Stream<A>> unlineShow(Show<A> sa)
        +
        A show instance for streams that splits into lines.
        +
        +
        Parameters:
        +
        sa - A show instance for the elements of a stream.
        +
        Returns:
        +
        A show instance for streams that splits into lines.
        +
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static <E,L extends HList<L>> Show<HList.HCons<E,L>> HListShow(Show<E> e,
+                                                                      Show<L> l)
        +
        A show instance for heterogeneous Streams.
        +
        +
        Parameters:
        +
        e - A show instance for the first element of the Stream.
        +
        l - A show instance for the rest of the Stream.
        +
        Returns:
        +
        a show instance for heterogeneous Streams.
        +
        +
        • +
      + + + +
        +
      • +

        hamtNodeShow

        +
        public static <K,V> Show<Node<K,V>> hamtNodeShow(Show<K> sk,
+                                                 Show<V> sv)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Try.html b/javadoc/4.8.1/functionaljava/fj/Try.html new file mode 100644 index 0000000..9f02980 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Try.html @@ -0,0 +1,434 @@ + + + + + +Try (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Try

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Try
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Try
+extends java.lang.Object
    +
    Created by mperry on 24/07/2014.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,E extends java.lang.Exception>
      P1<Validation<E,A>>      		f(Try0<A,E> t) +
      Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,E extends java.lang.Exception>
      F<A,Validation<E,B>>      		f(Try1<A,B,E> t) +
      Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,E extends java.lang.Exception>
      F2<A,B,Validation<E,C>>      		f(Try2<A,B,C,E> t) +
      Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E extends java.lang.Exception>
      F3<A,B,C,Validation<E,D>>      		f(Try3<A,B,C,D,E> t) +
      Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,Z extends java.lang.Exception>
      F4<A,B,C,D,Validation<Z,E>>      		f(Try4<A,B,C,D,E,Z> t) +
      Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,Z extends java.lang.Exception>
      F5<A,B,C,D,E,Validation<Z,F>>      		f(Try5<A,B,C,D,E,F,Z> t) +
      Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,Z extends java.lang.Exception>
      F6<A,B,C,D,E,F,Validation<Z,G>>      		f(Try6<A,B,C,D,E,F,G,Z> t) +
      Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
      F7<A,B,C,D,E,F,G,Validation<Z,H>>      		f(Try7<A,B,C,D,E,F,G,H,Z> t) +
      Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
      F8<A,B,C,D,E,F,G,H,Validation<Z,I>>      		f(Try8<A,B,C,D,E,F,G,H,I,Z> t) +
      Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A> IO<A>io(Try0<A,? extends java.io.IOException> t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public static <A,E extends java.lang.Exception> P1<Validation<E,A>> f(Try0<A,E> t)
        +
        Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try0 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,E extends java.lang.Exception> F<A,Validation<E,B>> f(Try1<A,B,E> t)
        +
        Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try1 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,E extends java.lang.Exception> F2<A,B,Validation<E,C>> f(Try2<A,B,C,E> t)
        +
        Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try2 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E extends java.lang.Exception> F3<A,B,C,Validation<E,D>> f(Try3<A,B,C,D,E> t)
        +
        Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try3 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,Z extends java.lang.Exception> F4<A,B,C,D,Validation<Z,E>> f(Try4<A,B,C,D,E,Z> t)
        +
        Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try4 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,Z extends java.lang.Exception> F5<A,B,C,D,E,Validation<Z,F>> f(Try5<A,B,C,D,E,F,Z> t)
        +
        Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try5 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,Z extends java.lang.Exception> F6<A,B,C,D,E,F,Validation<Z,G>> f(Try6<A,B,C,D,E,F,G,Z> t)
        +
        Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try6 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception> F7<A,B,C,D,E,F,G,Validation<Z,H>> f(Try7<A,B,C,D,E,F,G,H,Z> t)
        +
        Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try7 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> F8<A,B,C,D,E,F,G,H,Validation<Z,I>> f(Try8<A,B,C,D,E,F,G,H,I,Z> t)
        +
        Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try8 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        io

        +
        public static <A> IO<A> io(Try0<A,? extends java.io.IOException> t)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/TryEffect.html b/javadoc/4.8.1/functionaljava/fj/TryEffect.html new file mode 100644 index 0000000..fcd444b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/TryEffect.html @@ -0,0 +1,340 @@ + + + + + +TryEffect (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class TryEffect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.TryEffect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class TryEffect
+extends java.lang.Object
    +
    Created by mperry on 29/08/2014.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Unit.html b/javadoc/4.8.1/functionaljava/fj/Unit.html new file mode 100644 index 0000000..466229e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Unit.html @@ -0,0 +1,260 @@ + + + + + +Unit (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Unit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Unit
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Unit
+extends java.lang.Object
    +
    The unit type which has only one value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static Unitunit() +
      The only value of the unit type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static Unit unit()
        +
        The only value of the unit type.
        +
        +
        Returns:
        +
        The only value of the unit type.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/Void.html b/javadoc/4.8.1/functionaljava/fj/Void.html new file mode 100644 index 0000000..2a59cc3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/Void.html @@ -0,0 +1,239 @@ + + + + + +Void (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Void

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Void
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Void
+extends java.lang.Object
    +
    A logically uninhabited data type.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract <X> Xabsurd() +
      Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        absurd

        +
        public abstract <X> X absurd()
        +
        Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/Trampoline.html b/javadoc/4.8.1/functionaljava/fj/control/Trampoline.html new file mode 100644 index 0000000..74c5c8d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/Trampoline.html @@ -0,0 +1,604 @@ + + + + + +Trampoline (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control
+

Class Trampoline<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.Trampoline<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Trampoline<A>
+extends java.lang.Object
    +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack. + It represent suspendable coroutines with subroutine calls, reified as a data structure.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Trampoline

        +
        public Trampoline()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pure

        +
        public static <A> F<A,Trampoline<A>> pure()
        +
        +
        Returns:
        +
        The first-class version of pure.
        +
        +
        • +
      + + + + + +
        +
      • +

        pure

        +
        public static <A> Trampoline<A> pure(A a)
        +
        Constructs a pure computation that results in the given value.
        +
        +
        Parameters:
        +
        a - The value of the result.
        +
        Returns:
        +
        A trampoline that results in the given value.
        +
        +
        • +
      + + + +
        +
      • +

        suspend

        +
        public static <A> Trampoline<A> suspend(F0<Trampoline<A>> a)
        +
        Suspends the given computation in a thunk.
        +
        +
        Parameters:
        +
        a - A trampoline suspended in a thunk.
        +
        Returns:
        +
        A trampoline whose next step runs the given thunk.
        +
        +
        • +
      + + + +
        +
      • +

        suspend

        +
        public static <A> Trampoline<A> suspend(P1<Trampoline<A>> a)
        +
        Suspends the given computation in a thunk.
        +
        +
        Parameters:
        +
        a - A trampoline suspended in a thunk.
        +
        Returns:
        +
        A trampoline whose next step runs the given thunk.
        +
        +
        • +
      + + + +
        +
      • +

        suspend_

        +
        public static <A> F<P1<Trampoline<A>>,Trampoline<A>> suspend_()
        +
        +
        Returns:
        +
        The first-class version of suspend.
        +
        +
        • +
      + + + +
        +
      • +

        fold

        +
        protected abstract <R> R fold(F<fj.control.Trampoline.Normal<A>,R> n,
+                              F<fj.control.Trampoline.Codense<A>,R> gs)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public abstract <B> Trampoline<B> bind(F<A,Trampoline<B>> f)
        +
        Binds the given continuation to the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that constructs a trampoline from the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then continues with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Trampoline<B> map(F<A,B> f)
        +
        Maps the given function across the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that gets applied to the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then applies the given function to the result.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Trampoline<A>,Trampoline<B>>> map_()
        +
        +
        Returns:
        +
        The first-class version of map.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        resume

        +
        public abstract Either<P1<Trampoline<A>>,A> resume()
        +
        Runs a single step of this computation.
        +
        +
        Returns:
        +
        The next step of this compuation.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final A run()
        +
        Runs this computation all the way to the end, in constant stack.
        +
        +
        Returns:
        +
        The end result of this computation.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Trampoline<B> apply(Trampoline<F<A,B>> lf)
        +
        Performs function application within a Trampoline (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - A Trampoline resulting in the function to apply.
        +
        Returns:
        +
        A new Trampoline after applying the given function through this Trampoline.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Trampoline<C> bind(Trampoline<B> lb,
+                                      F<A,F<B,C>> f)
        +
        Binds the given function across the result of this Trampoline and the given Trampoline.
        +
        +
        Parameters:
        +
        lb - A given Trampoline to bind the given function with.
        +
        f - The function to combine the results of this Trampoline and the given Trampoline.
        +
        Returns:
        +
        A new Trampoline combining the results of the two trampolines with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Trampoline<A>,F<Trampoline<B>,Trampoline<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on Trampolines.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on Trampolines.
        +
        Returns:
        +
        The given function, promoted to operate on Trampolines.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Trampoline<C> zipWith(Trampoline<B> b,
+                                         F2<A,B,C> f)
        +
        Combines two trampolines so they run cooperatively. The results are combined with the given function.
        +
        +
        Parameters:
        +
        b - Another trampoline to combine with this trampoline.
        +
        f - A function to combine the results of the two trampolines.
        +
        Returns:
        +
        A new trampoline that runs this trampoline and the given trampoline simultaneously.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/Connector.html b/javadoc/4.8.1/functionaljava/fj/control/db/Connector.html new file mode 100644 index 0000000..73f0b8f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/Connector.html @@ -0,0 +1,275 @@ + + + + + +Connector (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class Connector

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.Connector
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Connector
+extends java.lang.Object
    +
    A method of connecting to the database.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Connector() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract java.sql.Connectionconnect() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Connector

        +
        public Connector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        connect

        +
        public abstract java.sql.Connection connect()
+                                     throws java.sql.SQLException
        +
        +
        Throws:
        +
        java.sql.SQLException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/DB.html b/javadoc/4.8.1/functionaljava/fj/control/db/DB.html new file mode 100644 index 0000000..48a5d87 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/DB.html @@ -0,0 +1,459 @@ + + + + + +DB (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class DB<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DB<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class DB<A>
+extends java.lang.Object
    +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DB() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      F<java.sql.Connection,java.util.concurrent.Callable<A>>asFunction() +
      Returns the callable-valued function projection of this database action.
      +
      <B> DB<B>bind(F<A,DB<B>> f) +
      Binds the given action across the result of this database action.
      +
      static <A> DB<A>db(F<java.sql.Connection,A> f) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>db(Try1<java.sql.Connection,A,java.sql.SQLException> t) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>join(DB<DB<A>> a) +
      Removes one layer of monadic structure.
      +
      static <A,B> F<DB<A>,DB<B>>liftM(F<A,B> f) +
      Promotes any given function so that it transforms between values in the database.
      +
      <B> DB<B>map(F<A,B> f) +
      Map a function over the result of this action.
      +
      abstract Arun(java.sql.Connection c) +
      Executes the database action, given a database connection.
      +
      static <A> DB<A>unit(A a) +
      Constructs a database action that returns the given value completely intact.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DB

        +
        public DB()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public abstract A run(java.sql.Connection c)
+               throws java.sql.SQLException
        +
        Executes the database action, given a database connection.
        +
        +
        Parameters:
        +
        c - The connection against which to execute the action.
        +
        Returns:
        +
        The result of the action.
        +
        Throws:
        +
        java.sql.SQLException - if a database error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(F<java.sql.Connection,A> f)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        f - A function from a database connection to a value.
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(Try1<java.sql.Connection,A,java.sql.SQLException> t)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        t - A function from a database connection to a value allowed to throw + SQLException
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        asFunction

        +
        public final F<java.sql.Connection,java.util.concurrent.Callable<A>> asFunction()
        +
        Returns the callable-valued function projection of this database action.
        +
        +
        Returns:
        +
        The callable-valued function which is isomorphic to this database action.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> DB<B> map(F<A,B> f)
        +
        Map a function over the result of this action.
        +
        +
        Parameters:
        +
        f - The function to map over the result.
        +
        Returns:
        +
        A new database action that applies the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        liftM

        +
        public static <A,B> F<DB<A>,DB<B>> liftM(F<A,B> f)
        +
        Promotes any given function so that it transforms between values in the database.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function equivalent to the given one, which operates on values in the database.
        +
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> DB<A> unit(A a)
        +
        Constructs a database action that returns the given value completely intact.
        +
        +
        Parameters:
        +
        a - A value to be wrapped in a database action.
        +
        Returns:
        +
        A new database action that returns the given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> DB<B> bind(F<A,DB<B>> f)
        +
        Binds the given action across the result of this database action.
        +
        +
        Parameters:
        +
        f - The function to bind across the result of this database action.
        +
        Returns:
        +
        A new database action equivalent to applying the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> DB<A> join(DB<DB<A>> a)
        +
        Removes one layer of monadic structure.
        +
        +
        Parameters:
        +
        a - A database action that results in another.
        +
        Returns:
        +
        A new database action equivalent to the result of the given action.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/DbState.html b/javadoc/4.8.1/functionaljava/fj/control/db/DbState.html new file mode 100644 index 0000000..dd06721 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/DbState.html @@ -0,0 +1,358 @@ + + + + + +DbState (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.db
+

Class DbState

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DbState
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DbState
+extends java.lang.Object
    +
    Performs database I/O, in order to read or write the database state.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ConnectordriverManager(java.lang.String url) +
      A simple connector (the default) that gets connections to the given database URL from the driver manager.
      +
      static DbStatereader(Connector pc) +
      Returns a new reader that reads the database via the given Connector.
      +
      static DbStatereader(java.lang.String url) +
      Creates a database state reader given a connection URL.
      +
      <A> Arun(DB<A> dba) +
      Runs the given database action as a single transaction.
      +
      static DbStatewriter(Connector pc) +
      Returns a new writer that writes the database via the given Connector.
      +
      static DbStatewriter(java.lang.String url) +
      Creates a database state writer given a connection URL.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        driverManager

        +
        public static Connector driverManager(java.lang.String url)
        +
        A simple connector (the default) that gets connections to the given database URL from the driver manager.
        +
        +
        Parameters:
        +
        url - The database URL to connect to.
        +
        Returns:
        +
        A connector that generates connections to the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(java.lang.String url)
        +
        Creates a database state reader given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state reader that reads the given database.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(java.lang.String url)
        +
        Creates a database state writer given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state writer that writes the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(Connector pc)
        +
        Returns a new reader that reads the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new reader that reads the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(Connector pc)
        +
        Returns a new writer that writes the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new writer that writes the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public <A> A run(DB<A> dba)
+          throws java.sql.SQLException
        +
        Runs the given database action as a single transaction.
        +
        +
        Parameters:
        +
        dba - A database action to run.
        +
        Returns:
        +
        The result of running the action against the database.
        +
        Throws:
        +
        java.sql.SQLException - in case of a database error.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/package-frame.html b/javadoc/4.8.1/functionaljava/fj/control/db/package-frame.html new file mode 100644 index 0000000..5a477a6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/package-frame.html @@ -0,0 +1,22 @@ + + + + + +fj.control.db (core 4.8.1 API) + + + + + +

fj.control.db

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/package-summary.html b/javadoc/4.8.1/functionaljava/fj/control/db/package-summary.html new file mode 100644 index 0000000..2f5352c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/package-summary.html @@ -0,0 +1,163 @@ + + + + + +fj.control.db (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.db

+
+
Abstractions for JDBC connections.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Connector +
    A method of connecting to the database.
    +
    DB<A> +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    DbState +
    Performs database I/O, in order to read or write the database state.
    +
    +
    • +
+ + + +

Package fj.control.db Description

+
Abstractions for JDBC connections.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/db/package-tree.html b/javadoc/4.8.1/functionaljava/fj/control/db/package-tree.html new file mode 100644 index 0000000..c865be2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/db/package-tree.html @@ -0,0 +1,137 @@ + + + + + +fj.control.db Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.db

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/package-frame.html b/javadoc/4.8.1/functionaljava/fj/control/package-frame.html new file mode 100644 index 0000000..06700ef --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/package-frame.html @@ -0,0 +1,20 @@ + + + + + +fj.control (core 4.8.1 API) + + + + + +

fj.control

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/control/package-summary.html b/javadoc/4.8.1/functionaljava/fj/control/package-summary.html new file mode 100644 index 0000000..9eab88b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/package-summary.html @@ -0,0 +1,151 @@ + + + + + +fj.control (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control

+
+
Functional control abstractions.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Trampoline<A> +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
    +
    +
    • +
+ + + +

Package fj.control Description

+
Functional control abstractions.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/package-tree.html b/javadoc/4.8.1/functionaljava/fj/control/package-tree.html new file mode 100644 index 0000000..92384a9 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/package-tree.html @@ -0,0 +1,135 @@ + + + + + +fj.control Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/Actor.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/Actor.html new file mode 100644 index 0000000..ab7d151 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/Actor.html @@ -0,0 +1,371 @@ + + + + + +Actor (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Actor<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Actor<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Actor<A>
+extends java.lang.Object
    +
    Light weight actors for Java. Concurrency is controlled by a parallel Strategy. + The Strategy serves as the Actor's execution engine, and as its mailbox. +

    + Given some effect, the Actor performs the effect on its messages using its Strategy, transforming them + into instances of fj.P1. The P1 represents a possibly running computation which is executing the effect. +

    + NOTE: A value of this type may generally process more than one message at a time, depending on its Strategy. + An actor is not thread-safe unless either its Effect imposes an order on incoming messages or its Strategy is + single-threaded. + + A queue actor which imposes an order on its messages is provided by the queueActor(fj.control.parallel.Strategy<fj.Unit>, fj.function.Effect1<T>) static method.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      P1<Unit>act(A a) +
      Pass a message to this actor, applying its side-effect to the message.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + Effect1<A> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + F<A,P1<Unit>> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      <B> Actor<B>contramap(F<B,A> f) +
      Contravariant functor pattern.
      +
      Actor<Promise<A>>promise() +
      Transforms this actor to an actor on promises.
      +
      static <T> Actor<T>queueActor(Strategy<Unit> s, + Effect1<T> ea) +
      An Actor equipped with a queue and which is guaranteed to process one message at a time.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        queueActor

        +
        public static <T> Actor<T> queueActor(Strategy<Unit> s,
+                                      Effect1<T> ea)
        +
        An Actor equipped with a queue and which is guaranteed to process one message at a time. + With respect to an enqueueing actor or thread, this actor will process messages in the same order + as they are sent.
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 Effect1<A> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 F<A,P1<Unit>> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The function projection of a side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + + + +
        +
      • +

        act

        +
        public P1<Unit> act(A a)
        +
        Pass a message to this actor, applying its side-effect to the message. The side-effect is applied in a concurrent + computation, resulting in a product referencing that computation.
        +
        +
        Parameters:
        +
        a - The message to send to this actor.
        +
        Returns:
        +
        A unit-product that represents the action running concurrently.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Actor<B> contramap(F<B,A> f)
        +
        Contravariant functor pattern. Creates a new actor whose message is transformed by the given function + before being passed to this actor.
        +
        +
        Parameters:
        +
        f - The function to use for the transformation
        +
        Returns:
        +
        A new actor which passes its messages through the given function, to this actor.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public Actor<Promise<A>> promise()
        +
        Transforms this actor to an actor on promises.
        +
        +
        Returns:
        +
        A new actor, equivalent to this actor, that acts on promises.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/Callables.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/Callables.html new file mode 100644 index 0000000..646ac18 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/Callables.html @@ -0,0 +1,731 @@ + + + + + +Callables (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Callables

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Callables
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Callables
+extends java.lang.Object
    +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.concurrent.Callable<B>apply(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<F<A,B>> cf) +
      Performs function application within a callable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>>arrow() +
      Provides a transformation from a function to a Callable-valued function that is equivalent to it.
      +
      static <A,B,C> java.util.concurrent.Callable<C>bind(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given callables with a final join.
      +
      static <A,B> java.util.concurrent.Callable<B>bind(java.util.concurrent.Callable<A> a, + F<A,java.util.concurrent.Callable<B>> f) +
      Binds the given function to the value in a Callable with a final join.
      +
      static <A> F<A,java.util.concurrent.Callable<A>>callable() +
      Provides a transformation from a value to a Callable that completely preserves that value.
      +
      static <A> java.util.concurrent.Callable<A>callable(A a) +
      Returns a callable that completely preserves the argument.
      +
      static <A> java.util.concurrent.Callable<A>callable(java.lang.Exception e) +
      Returns a callable that throws the given exception.
      +
      static <A,B> F<A,java.util.concurrent.Callable<B>>callable(F<A,B> f) +
      Wraps a given function's return value in a Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>>either() +
      Returns a transformation from a Callable to an Either.
      +
      static <A> P1<Either<java.lang.Exception,A>>either(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into either an exception or the value in the Callable.
      +
      static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>>fmap(F<A,B> f) +
      Lifts any function to a function on Callables.
      +
      static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>>fromEither() +
      Returns a transformation from an Either to a Callable.
      +
      static <A> java.util.concurrent.Callable<A>fromEither(F0<Either<java.lang.Exception,A>> e) +
      Turns a given Either value into the equivalent Callable.
      +
      static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>>fromOption() +
      Returns a transformation from an optional value to a Callable
      +
      static <A> java.util.concurrent.Callable<A>fromOption(F0<Option<A>> o) +
      Turns an optional value into a Callable.
      +
      static <A> java.util.concurrent.Callable<A>join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a) +
      Joins a Callable of a Callable with a bind operation.
      +
      static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on callables.
      +
      static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>>normalise() +
      A first-class version of the normalise function.
      +
      static <A> java.util.concurrent.Callable<A>normalise(java.util.concurrent.Callable<A> a) +
      Normalises the given Callable by calling it and wrapping the result in a new Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>>option() +
      Returns a transformation from a Callable to an optional value.
      +
      static <A> P1<Option<A>>option(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into an optional value.
      +
      static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>>sequence_() +
      A first-class version of the sequence method.
      +
      static <A> java.util.concurrent.Callable<List<A>>sequence(List<java.util.concurrent.Callable<A>> as) +
      Turns a List of Callables into a single Callable of a List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(A a)
        +
        Returns a callable that completely preserves the argument. The unit function for Callables.
        +
        +
        Parameters:
        +
        a - A value to preserve in a Callable
        +
        Returns:
        +
        A Callable that yields the argument when called.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(java.lang.Exception e)
        +
        Returns a callable that throws the given exception. The unit function for Callables.
        +
        +
        Parameters:
        +
        e - The exception to throw when the Callable is called.
        +
        Returns:
        +
        A callable that always throws the given exception.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> F<A,java.util.concurrent.Callable<A>> callable()
        +
        Provides a transformation from a value to a Callable that completely preserves that value.
        +
        +
        Returns:
        +
        A function from a value to a Callable that completely preserves that value.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A,B> F<A,java.util.concurrent.Callable<B>> callable(F<A,B> f)
        +
        Wraps a given function's return value in a Callable. + The Kleisli arrow for Callables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Callable.
        +
        Returns:
        +
        The equivalent function whose return value is wrapped in a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>> arrow()
        +
        Provides a transformation from a function to a Callable-valued function that is equivalent to it. + The first-class Kleisli arrow for Callables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Callable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.concurrent.Callable<B> bind(java.util.concurrent.Callable<A> a,
+                                                          F<A,java.util.concurrent.Callable<B>> f)
        +
        Binds the given function to the value in a Callable with a final join.
        +
        +
        Parameters:
        +
        a - A value in a Callable to which to apply a function.
        +
        f - A function to apply to the value in a Callable.
        +
        Returns:
        +
        The result of applying the function in the second argument to the value of the Callable in the first.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>> fmap(F<A,B> f)
        +
        Lifts any function to a function on Callables.
        +
        +
        Parameters:
        +
        f - A function to lift to a function on Callables.
        +
        Returns:
        +
        That function lifted to a function on Callables.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> java.util.concurrent.Callable<B> apply(java.util.concurrent.Callable<A> ca,
+                                                           java.util.concurrent.Callable<F<A,B>> cf)
        +
        Performs function application within a callable (applicative functor pattern).
        +
        +
        Parameters:
        +
        ca - The callable to which to apply a function.
        +
        cf - The callable function to apply.
        +
        Returns:
        +
        A new callable after applying the given callable function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> java.util.concurrent.Callable<C> bind(java.util.concurrent.Callable<A> ca,
+                                                            java.util.concurrent.Callable<B> cb,
+                                                            F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given callables with a final join.
        +
        +
        Parameters:
        +
        ca - A given callable to bind the given function with.
        +
        cb - A given callable to bind the given function with.
        +
        f - The function to apply to the values in the given callables.
        +
        Returns:
        +
        A new callable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> java.util.concurrent.Callable<A> join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a)
        +
        Joins a Callable of a Callable with a bind operation.
        +
        +
        Parameters:
        +
        a - The Callable of a Callable to join.
        +
        Returns:
        +
        A new Callable that is the join of the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on callables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over callables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> java.util.concurrent.Callable<List<A>> sequence(List<java.util.concurrent.Callable<A>> as)
        +
        Turns a List of Callables into a single Callable of a List.
        +
        +
        Parameters:
        +
        as - The list of callables to transform.
        +
        Returns:
        +
        A single callable for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>> sequence_()
        +
        A first-class version of the sequence method.
        +
        +
        Returns:
        +
        A function from a List of Callables to a single Callable of a List.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> P1<Option<A>> option(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into an optional value.
        +
        +
        Parameters:
        +
        a - The callable to convert to an optional value.
        +
        Returns:
        +
        An optional value that yields the value in the Callable, or None if the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>> option()
        +
        Returns a transformation from a Callable to an optional value.
        +
        +
        Returns:
        +
        a function that turns a Callable into an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> P1<Either<java.lang.Exception,A>> either(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into either an exception or the value in the Callable.
        +
        +
        Parameters:
        +
        a - The callable to convert to an Either value.
        +
        Returns:
        +
        Either the value in the given Callable, or the Exception with which the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>> either()
        +
        Returns a transformation from a Callable to an Either.
        +
        +
        Returns:
        +
        a function that turns a Callable into an Either.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> java.util.concurrent.Callable<A> fromEither(F0<Either<java.lang.Exception,A>> e)
        +
        Turns a given Either value into the equivalent Callable.
        +
        +
        Parameters:
        +
        e - Either an exception or a value to wrap in a Callable
        +
        Returns:
        +
        A Callable equivalent to the given Either value.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>> fromEither()
        +
        Returns a transformation from an Either to a Callable.
        +
        +
        Returns:
        +
        a function that turns an Either into a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> java.util.concurrent.Callable<A> fromOption(F0<Option<A>> o)
        +
        Turns an optional value into a Callable.
        +
        +
        Parameters:
        +
        o - An optional value to turn into a Callable.
        +
        Returns:
        +
        A Callable that yields some value or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>> fromOption()
        +
        Returns a transformation from an optional value to a Callable
        +
        +
        Returns:
        +
        A function that turns an optional value into a Callable that yields some value + or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> java.util.concurrent.Callable<A> normalise(java.util.concurrent.Callable<A> a)
        +
        Normalises the given Callable by calling it and wrapping the result in a new Callable. + If the given Callable throws an Exception, the resulting Callable will throw that same Exception.
        +
        +
        Parameters:
        +
        a - The callable to evaluate.
        +
        Returns:
        +
        A normalised callable that just returns the result of calling the given callable.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>> normalise()
        +
        A first-class version of the normalise function.
        +
        +
        Returns:
        +
        A function that normalises the given Callable by calling it and wrapping the result in a new Callable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/ParModule.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/ParModule.html new file mode 100644 index 0000000..e96cbdf --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/ParModule.html @@ -0,0 +1,1412 @@ + + + + + +ParModule (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class ParModule

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.ParModule
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class ParModule
+extends java.lang.Object
    +
    A module of higher-order concurrency features.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> F<Effect1<A>,Actor<A>>actor() +
      A first-class constructor of actors.
      +
      <A> Actor<A>actor(Effect1<A> e) +
      Creates a concurrent actor that is guaranteed to process only one message at a time.
      +
      <A> F<Effect1<A>,Actor<A>>effect() +
      A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
      +
      <A> Actor<A>effect(Effect1<A> e) +
      Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
      +
      <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>>mapList() +
      First-class function that maps a concurrent function over a List inside a promise.
      +
      <A,B> Promise<List<B>>mapM(List<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
      +
      <A,B> Promise<P1<B>>mapM(P1<A> a, + F<A,Promise<B>> f) +
      Maps a concurrent function over a Product-1 inside a Promise.
      +
      <A,B> Promise<Stream<B>>mapM(Stream<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
      +
      <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>>mapStream() +
      First-class function that maps a concurrent function over a Stream inside a promise.
      +
      <A,B> Promise<NonEmptyList<B>>parExtend(NonEmptyList<A> as, + F<NonEmptyList<A>,B> f) +
      Maps the given function across all sublists of the given NonEmptyList in parallel.
      +
      <A,B> Promise<Tree<B>>parExtend(Tree<A> ta, + F<Tree<A>,B> f) +
      Maps the given function across all subtrees of the given Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parExtend(TreeZipper<A> za, + F<TreeZipper<A>,B> f) +
      Maps the given function across all positions of the given TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parExtend(Zipper<A> za, + F<Zipper<A>,B> f) +
      Maps the given function across all positions of the given zipper in parallel.
      +
      <A,B> Promise<Array<B>>parFlatMap(Array<A> as, + F<A,Array<B>> f) +
      Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
      +
      <A,B> Promise<java.lang.Iterable<B>>parFlatMap(java.lang.Iterable<A> as, + F<A,java.lang.Iterable<B>> f) +
      Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
      +
      <A,B> Promise<List<B>>parFlatMap(List<A> as, + F<A,List<B>> f) +
      Binds a list-valued function across a list in parallel, concatenating the results into a new list.
      +
      <A,B> Promise<Stream<B>>parFlatMap(Stream<A> as, + F<A,Stream<B>> f) +
      Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce, + F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking) +
      Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce, + F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking) +
      Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<Array<B>>parMap(Array<A> as, + F<A,B> f) +
      Maps across an Array in parallel.
      +
      <A,B> Promise<java.lang.Iterable<B>>parMap(java.lang.Iterable<A> as, + F<A,B> f) +
      Maps across an Iterable in parallel.
      +
      <A,B> Promise<List<B>>parMap(List<A> as, + F<A,B> f) +
      Maps across a list in parallel.
      +
      <A,B> Promise<NonEmptyList<B>>parMap(NonEmptyList<A> as, + F<A,B> f) +
      Maps across a nonempty list in parallel.
      +
      <A,B> Promise<Stream<B>>parMap(Stream<A> as, + F<A,B> f) +
      Maps across a Stream in parallel.
      +
      <A,B> Promise<Tree<B>>parMap(Tree<A> ta, + F<A,B> f) +
      Maps a function across a Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parMap(TreeZipper<A> za, + F<A,B> f) +
      Maps a function across a TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parMap(Zipper<A> za, + F<A,B> f) +
      Maps a function across a Zipper in parallel.
      +
      <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>>parMapArray() +
      A first-class function that maps another function across an array in parallel.
      +
      <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>>parMapIterable() +
      A first-class function that maps another function across an iterable in parallel.
      +
      <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>>parMapList() +
      A first-class function that maps another function across a list in parallel.
      +
      <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>>parMapStream() +
      A first-class function that maps another function across a stream in parallel.
      +
      <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>>parMapTree() +
      A first-class function that maps across a Tree in parallel.
      +
      static ParModuleparModule(Strategy<Unit> u) +
      Constructor method for ParModule
      +
      <A,B,C> Promise<Array<C>>parZipWith(Array<A> as, + Array<B> bs, + F<A,F<B,C>> f) +
      Zips two arrays together with a given function, in parallel.
      +
      <A,B,C> Promise<java.lang.Iterable<C>>parZipWith(java.lang.Iterable<A> as, + java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips two iterables together with a given function, in parallel.
      +
      <A,B,C> Promise<List<C>>parZipWith(List<A> as, + List<B> bs, + F<A,F<B,C>> f) +
      Zips two lists together with a given function, in parallel.
      +
      <A,B,C> Promise<Stream<C>>parZipWith(Stream<A> as, + Stream<B> bs, + F<A,F<B,C>> f) +
      Zips two streams together with a given function, in parallel.
      +
      <A> F<P1<A>,Promise<A>>promise() +
      Returns a function that evaluates a given product concurrently and returns a Promise of the result.
      +
      <A,B> F<A,Promise<B>>promise(F<A,B> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A,B,C> F2<A,B,Promise<C>>promise(F2<A,B,C> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A> Promise<A>promise(P1<A> p) +
      Evaluates the given product concurrently and returns a Promise of the result.
      +
      <A,B> F<F<A,B>,F<A,Promise<B>>>promisePure() +
      Returns a function that promotes a given function to a concurrent function that returns a Promise.
      +
      <A> Promise<List<A>>sequence(List<Promise<A>> ps) +
      List iteration inside a Promise.
      +
      <A> Promise<P1<A>>sequence(P1<Promise<A>> p) +
      Traverses a product-1 inside a promise.
      +
      <A> Promise<Stream<A>>sequence(Stream<Promise<A>> ps) +
      Stream iteration inside a Promise.
      +
      <A> F<List<Promise<A>>,Promise<List<A>>>sequenceList() +
      A first-class function that traverses a list inside a promise.
      +
      <A> F<Stream<Promise<A>>,Promise<Stream<A>>>sequenceStream() +
      A first-class function that traverses a stream inside a promise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        parModule

        +
        public static ParModule parModule(Strategy<Unit> u)
        +
        Constructor method for ParModule
        +
        +
        Parameters:
        +
        u - A parallel strategy for the module.
        +
        Returns:
        +
        A ParModule that uses the given strategy for parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> Promise<A> promise(P1<A> p)
        +
        Evaluates the given product concurrently and returns a Promise of the result.
        +
        +
        Parameters:
        +
        p - A product to evaluate concurrently.
        +
        Returns:
        +
        A Promise of the value of the given product, that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> F<P1<A>,Promise<A>> promise()
        +
        Returns a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        Returns:
        +
        a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B> F<A,Promise<B>> promise(F<A,B> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promisePure

        +
        public <A,B> F<F<A,B>,F<A,Promise<B>>> promisePure()
        +
        Returns a function that promotes a given function to a concurrent function that returns a Promise. + The pure Kleisli arrow of Promise.
        +
        +
        Returns:
        +
        A higher-order function that takes pure functions to promise-valued functions.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B,C> F2<A,B,Promise<C>> promise(F2<A,B,C> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> Actor<A> effect(Effect1<A> e)
        +
        Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that does not guarantee ordering of its messages.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> F<Effect1<A>,Actor<A>> effect()
        +
        A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Returns:
        +
        A function that takes an effect and returns a concurrent effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> Actor<A> actor(Effect1<A> e)
        +
        Creates a concurrent actor that is guaranteed to process only one message at a time.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that is guaranteed to process its messages in order.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> F<Effect1<A>,Actor<A>> actor()
        +
        A first-class constructor of actors.
        +
        +
        Returns:
        +
        A function that takes an effect and returns an actor that processes messages in some order.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<List<A>> sequence(List<Promise<A>> ps)
        +
        List iteration inside a Promise. Traverses a List of Promises yielding a Promise of a List.
        +
        +
        Parameters:
        +
        ps - A list of promises to sequence.
        +
        Returns:
        +
        A promise of the List of values promised by the list of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public <A> F<List<Promise<A>>,Promise<List<A>>> sequenceList()
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<Stream<A>> sequence(Stream<Promise<A>> ps)
        +
        Stream iteration inside a Promise. Traverses a Stream of Promises yielding a Promise of a Stream.
        +
        +
        Parameters:
        +
        ps - A Stream of promises to sequence.
        +
        Returns:
        +
        A promise of the Stream of values promised by the Stream of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public <A> F<Stream<Promise<A>>,Promise<Stream<A>>> sequenceStream()
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<P1<A>> sequence(P1<Promise<A>> p)
        +
        Traverses a product-1 inside a promise.
        +
        +
        Parameters:
        +
        p - A product-1 of a promised value.
        +
        Returns:
        +
        A promise of a product of the value promised by the argument.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<List<B>> mapM(List<A> as,
+                                   F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
        +
        +
        Parameters:
        +
        as - A list to map across.
        +
        f - A promise-valued function to map across the list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>> mapList()
        +
        First-class function that maps a concurrent function over a List inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a List inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<Stream<B>> mapM(Stream<A> as,
+                                     F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
        +
        +
        Parameters:
        +
        as - A Stream to map across.
        +
        f - A promise-valued function to map across the Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>> mapStream()
        +
        First-class function that maps a concurrent function over a Stream inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a Stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<P1<B>> mapM(P1<A> a,
+                                 F<A,Promise<B>> f)
        +
        Maps a concurrent function over a Product-1 inside a Promise.
        +
        +
        Parameters:
        +
        a - A product-1 across which to map.
        +
        f - A concurrent function to map over the product inside a promise.
        +
        Returns:
        +
        A promised product of the result of mapping the given function over the given product.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<List<B>> parMap(List<A> as,
+                                     F<A,B> f)
        +
        Maps across a list in parallel.
        +
        +
        Parameters:
        +
        as - A list to map across in parallel.
        +
        f - A function to map across the given list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>> parMapList()
        +
        A first-class function that maps another function across a list in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a list in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<NonEmptyList<B>> parMap(NonEmptyList<A> as,
+                                             F<A,B> f)
        +
        Maps across a nonempty list in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to map across in parallel.
        +
        f - A function to map across the given NonEmptyList.
        +
        Returns:
        +
        A Promise of a new NonEmptyList with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Stream<B>> parMap(Stream<A> as,
+                                       F<A,B> f)
        +
        Maps across a Stream in parallel.
        +
        +
        Parameters:
        +
        as - A Stream to map across in parallel.
        +
        f - A function to map across the given Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapStream

        +
        public <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>> parMapStream()
        +
        A first-class function that maps another function across a stream in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a stream in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parMap(java.lang.Iterable<A> as,
+                                                   F<A,B> f)
        +
        Maps across an Iterable in parallel.
        +
        +
        Parameters:
        +
        as - An Iterable to map across in parallel.
        +
        f - A function to map across the given Iterable.
        +
        Returns:
        +
        A Promise of a new Iterable with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapIterable

        +
        public <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>> parMapIterable()
        +
        A first-class function that maps another function across an iterable in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an iterable in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Array<B>> parMap(Array<A> as,
+                                      F<A,B> f)
        +
        Maps across an Array in parallel.
        +
        +
        Parameters:
        +
        as - An array to map across in parallel.
        +
        f - A function to map across the given Array.
        +
        Returns:
        +
        A Promise of a new Array with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>> parMapArray()
        +
        A first-class function that maps another function across an array in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an array in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Zipper<B>> parMap(Zipper<A> za,
+                                       F<A,B> f)
        +
        Maps a function across a Zipper in parallel.
        +
        +
        Parameters:
        +
        za - A Zipper to map across in parallel.
        +
        f - A function to map across the given Zipper.
        +
        Returns:
        +
        A promise of a new Zipper with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Tree<B>> parMap(Tree<A> ta,
+                                     F<A,B> f)
        +
        Maps a function across a Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A Tree to map across in parallel.
        +
        f - A function to map across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapTree

        +
        public <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>> parMapTree()
        +
        A first-class function that maps across a Tree in parallel.
        +
        +
        Returns:
        +
        A function that maps a given function across a Tree in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<TreeZipper<B>> parMap(TreeZipper<A> za,
+                                           F<A,B> f)
        +
        Maps a function across a TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to map across in parallel.
        +
        f - A function to map across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper with the given function applied to each element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<List<B>> parFlatMap(List<A> as,
+                                         F<A,List<B>> f)
        +
        Binds a list-valued function across a list in parallel, concatenating the results into a new list.
        +
        +
        Parameters:
        +
        as - A list to bind across in parallel.
        +
        f - A function to bind across the given list in parallel.
        +
        Returns:
        +
        A promise of a new List with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Stream<B>> parFlatMap(Stream<A> as,
+                                           F<A,Stream<B>> f)
        +
        Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
        +
        +
        Parameters:
        +
        as - A Stream to bind across in parallel.
        +
        f - A function to bind across the given Stream in parallel.
        +
        Returns:
        +
        A promise of a new Stream with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Array<B>> parFlatMap(Array<A> as,
+                                          F<A,Array<B>> f)
        +
        Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
        +
        +
        Parameters:
        +
        as - An Array to bind across in parallel.
        +
        f - A function to bind across the given Array in parallel.
        +
        Returns:
        +
        A promise of a new Array with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parFlatMap(java.lang.Iterable<A> as,
+                                                       F<A,java.lang.Iterable<B>> f)
        +
        Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
        +
        +
        Parameters:
        +
        as - A Iterable to bind across in parallel.
        +
        f - A function to bind across the given Iterable in parallel.
        +
        Returns:
        +
        A promise of a new Iterable with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<List<C>> parZipWith(List<A> as,
+                                           List<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips two lists together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A list to zip with another in parallel.
        +
        bs - A list to zip with another in parallel.
        +
        f - A function with which to zip two lists in parallel.
        +
        Returns:
        +
        A Promise of a new list with the results of applying the given function across the two lists in lockstep.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Stream<C>> parZipWith(Stream<A> as,
+                                             Stream<B> bs,
+                                             F<A,F<B,C>> f)
        +
        Zips two streams together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A stream to zip with another in parallel.
        +
        bs - A stream to zip with another in parallel.
        +
        f - A function with which to zip two streams in parallel.
        +
        Returns:
        +
        A Promise of a new stream with the results of applying the given function across the two streams, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Array<C>> parZipWith(Array<A> as,
+                                            Array<B> bs,
+                                            F<A,F<B,C>> f)
        +
        Zips two arrays together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An array to zip with another in parallel.
        +
        bs - An array to zip with another in parallel.
        +
        f - A function with which to zip two arrays in parallel.
        +
        Returns:
        +
        A Promise of a new array with the results of applying the given function across the two arrays, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<java.lang.Iterable<C>> parZipWith(java.lang.Iterable<A> as,
+                                                         java.lang.Iterable<B> bs,
+                                                         F<A,F<B,C>> f)
        +
        Zips two iterables together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An iterable to zip with another in parallel.
        +
        bs - An iterable to zip with another in parallel.
        +
        f - A function with which to zip two iterables in parallel.
        +
        Returns:
        +
        A Promise of a new iterable with the results of applying the given function across the two iterables, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given stream in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - A stream to map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking)
        +
        Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid. The stream is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - A stream to chunk, then map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the stream should be split into chunks. Should return the first chunk + and the rest of the stream.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking)
        +
        Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid. The Iterable is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - An Iterable to chunk, then map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the Iterable should be split into chunks. Should return the first chunk + and the rest of the Iterable.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - An Iterable to map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The Monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Zipper<B>> parExtend(Zipper<A> za,
+                                          F<Zipper<A>,B> f)
        +
        Maps the given function across all positions of the given zipper in parallel.
        +
        +
        Parameters:
        +
        za - A zipper to extend the given function across.
        +
        f - A function to extend across the given zipper.
        +
        Returns:
        +
        A promise of a new zipper of the results of applying the given function to all positions of the given + zipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Tree<B>> parExtend(Tree<A> ta,
+                                        F<Tree<A>,B> f)
        +
        Maps the given function across all subtrees of the given Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A tree to extend the given function across.
        +
        f - A function to extend across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree of the results of applying the given function to all subtrees of the given Tree.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<TreeZipper<B>> parExtend(TreeZipper<A> za,
+                                              F<TreeZipper<A>,B> f)
        +
        Maps the given function across all positions of the given TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to extend the given function across.
        +
        f - A function to extend across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper of the results of applying the given function to all positions of the + given TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<NonEmptyList<B>> parExtend(NonEmptyList<A> as,
+                                                F<NonEmptyList<A>,B> f)
        +
        Maps the given function across all sublists of the given NonEmptyList in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to extend the given function across.
        +
        f - A function to extend across the given NonEmptyList
        +
        Returns:
        +
        A promise of a new NonEmptyList of the results of applying the given function to all sublists of the + given NonEmptyList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/Promise.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/Promise.html new file mode 100644 index 0000000..5264435 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/Promise.html @@ -0,0 +1,864 @@ + + + + + +Promise (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Promise<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Promise<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Promise<A>
+extends java.lang.Object
    +
    Represents a non-blocking future value. Products, functions, and actors, given to the methods on this class, + are executed concurrently, and the Promise serves as a handle on the result of the computation. Provides monadic + operations so that future computations can be combined +

    + Author: Runar

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Promise<B>apply(Promise<F<A,B>> pf) +
      Performs function application within a promise (applicative functor pattern).
      +
      <B> Promise<B>bind(F<A,Promise<B>> f) +
      Binds the given function over this promise, with a final join.
      +
      <B,C> Promise<C>bind(P1<Promise<B>> p, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      <B,C> Promise<C>bind(Promise<B> pb, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      Aclaim() +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      Option<A>claim(long timeout, + java.util.concurrent.TimeUnit unit) +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      <B> Promise<B>cobind(F<Promise<A>,B> f) +
      Binds the given function across a promise of this promise (Comonad pattern).
      +
      Promise<Promise<A>>cojoin() +
      Duplicates this promise to a promise of itself (Comonad pattern).
      +
      static <A,B> F<Promise<A>,Promise<B>>fmap_(F<A,B> f) +
      Promotes any function to a transformation between promises (covariant functor pattern).
      +
      <B> Promise<B>fmap(F<A,B> f) +
      Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
      +
      static <A,B> F<List<A>,Promise<B>>foldRight(Strategy<Unit> s, + F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across a list in constant stack space.
      +
      static <A,B> F<Stream<A>,Promise<B>>foldRightS(Strategy<Unit> s, + F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across a Stream in constant stack space.
      +
      booleanisFulfilled() +
      Returns true if this promise has been fulfilled.
      +
      static <A> Promise<A>join(Promise<Promise<A>> p) +
      Turns a promise of a promise into just a promise.
      +
      static <A> Promise<A>join(Strategy<Unit> s, + P1<Promise<A>> p) +
      Turns a product of a promise into just a promise.
      +
      static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on promises.
      +
      static <A> F<P1<A>,Promise<A>>promise(Strategy<Unit> s) +
      Provides a first-class unit function for promises.
      +
      static <A> Promise<java.util.concurrent.Callable<A>>promise(Strategy<Unit> s, + java.util.concurrent.Callable<A> a) +
      Provides a promise to call the given Callable in the future.
      +
      static <A,B> F<A,Promise<B>>promise(Strategy<Unit> s, + F<A,B> f) +
      Transforms any function so that it returns a promise of a value instead of an actual value.
      +
      static <A> Promise<A>promise(Strategy<Unit> s, + P1<A> a) +
      Promises to provide the value of the given 1-product, in the future.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequence(Strategy<Unit> s) +
      First-class version of the sequence function through a List.
      +
      static <A> Promise<List<A>>sequence(Strategy<Unit> s, + List<Promise<A>> as) +
      Turns a List of promises into a single promise of a List.
      +
      static <A> Promise<P1<A>>sequence(Strategy<Unit> s, + P1<Promise<A>> p) +
      Transforms a product of a promise to a promise of a product.
      +
      static <A> Promise<Stream<A>>sequence(Strategy<Unit> s, + Stream<Promise<A>> as) +
      Turns a Stream of promises into a single promise of a Stream.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequenceS(Strategy<Unit> s) +
      First-class version of the sequence function through a Stream.
      +
      <B> Stream<B>sequenceW(Stream<F<Promise<A>,B>> fs) +
      Applies a stream of comonadic functions to this promise, returning a stream of values.
      +
      voidto(Actor<A> a) +
      Promises to send a value to the given actor in the future.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<A> promise(Strategy<Unit> s,
+                                     P1<A> a)
        +
        Promises to provide the value of the given 1-product, in the future. + Represents the unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The 1-product to evaluate concurrently.
        +
        Returns:
        +
        A promise representing the future result of evaluating the given 1-product.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> F<P1<A>,Promise<A>> promise(Strategy<Unit> s)
        +
        Provides a first-class unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil promises.
        +
        Returns:
        +
        A function that, given a 1-product, yields a promise of that product's value.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<java.util.concurrent.Callable<A>> promise(Strategy<Unit> s,
+                                                                    java.util.concurrent.Callable<A> a)
        +
        Provides a promise to call the given Callable in the future.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The Callable to evaluate concurrently.
        +
        Returns:
        +
        A promise of a new Callable that will return the result of calling the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A,B> F<A,Promise<B>> promise(Strategy<Unit> s,
+                                            F<A,B> f)
        +
        Transforms any function so that it returns a promise of a value instead of an actual value. + Represents the Kleisli arrow for the Promise monad.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        f - The function to turn into a promise-valued function.
        +
        Returns:
        +
        The given function transformed into a function that returns a promise.
        +
        +
        • +
      + + + +
        +
      • +

        to

        +
        public void to(Actor<A> a)
        +
        Promises to send a value to the given actor in the future.
        +
        +
        Parameters:
        +
        a - An actor that will receive this Promise's value in the future.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Promise<B> fmap(F<A,B> f)
        +
        Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to apply to this promise's future value.
        +
        Returns:
        +
        A promise representing the future result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<Promise<A>,Promise<B>> fmap_(F<A,B> f)
        +
        Promotes any function to a transformation between promises (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to promote to a transformation between promises.
        +
        Returns:
        +
        That function lifted to a function on Promises.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Promise<Promise<A>> p)
        +
        Turns a promise of a promise into just a promise. The join function for the Promise monad. + Promise to give it a Promise of an A, and it will promise you an A in return.
        +
        +
        Parameters:
        +
        p - A promise of a promise.
        +
        Returns:
        +
        The promised promise.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Strategy<Unit> s,
+                                  P1<Promise<A>> p)
        +
        Turns a product of a promise into just a promise. Does not block on the product by calling it, + but creates a new promise with a final join.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        p - A product-1 of a promise to turn into just a promise.
        +
        Returns:
        +
        The joined promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Promise<B> bind(F<A,Promise<B>> f)
        +
        Binds the given function over this promise, with a final join. + The bind function for the Promise monad.
        +
        +
        Parameters:
        +
        f - The function to bind over this promise.
        +
        Returns:
        +
        The result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Promise<B> apply(Promise<F<A,B>> pf)
        +
        Performs function application within a promise (applicative functor pattern).
        +
        +
        Parameters:
        +
        pf - The promised function to apply.
        +
        Returns:
        +
        A new promise after applying the given promised function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(Promise<B> pb,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        pb - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(P1<Promise<B>> p,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        p - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on promises.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<List<A>> sequence(Strategy<Unit> s,
+                                            List<Promise<A>> as)
        +
        Turns a List of promises into a single promise of a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The list of promises to transform.
        +
        Returns:
        +
        A single promise for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequence(Strategy<Unit> s)
        +
        First-class version of the sequence function through a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given list of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a list.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<Stream<A>> sequence(Strategy<Unit> s,
+                                              Stream<Promise<A>> as)
        +
        Turns a Stream of promises into a single promise of a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The Stream of promises to transform.
        +
        Returns:
        +
        A single promise for the given Stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceS

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequenceS(Strategy<Unit> s)
        +
        First-class version of the sequence function through a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given Stream of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a Stream..
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<P1<A>> sequence(Strategy<Unit> s,
+                                          P1<Promise<A>> p)
        +
        Transforms a product of a promise to a promise of a product.
        +
        +
        Parameters:
        +
        s - The strategy with which to traverse the promise.
        +
        p - A product of a promise to traverse.
        +
        Returns:
        +
        A promised product.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<List<A>,Promise<B>> foldRight(Strategy<Unit> s,
+                                                    F<A,F<B,B>> f,
+                                                    B b)
        +
        Performs a right-fold reduction across a list in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the list.
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightS

        +
        public static <A,B> F<Stream<A>,Promise<B>> foldRightS(Strategy<Unit> s,
+                                                       F<A,F<P1<B>,B>> f,
+                                                       B b)
        +
        Performs a right-fold reduction across a Stream in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the Stream.
        +
        f - The function to apply on each element of the Stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public A claim()
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Returns:
        +
        The promised value.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public Option<A> claim(long timeout,
+                       java.util.concurrent.TimeUnit unit)
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Parameters:
        +
        timeout - the maximum time to wait
        +
        unit - the time unit of the timeout argument
        +
        Returns:
        +
        The promised value, or none if the timeout was reached.
        +
        +
        • +
      + + + +
        +
      • +

        isFulfilled

        +
        public boolean isFulfilled()
        +
        Returns true if this promise has been fulfilled.
        +
        +
        Returns:
        +
        true if this promise has been fulfilled.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Promise<B> cobind(F<Promise<A>,B> f)
        +
        Binds the given function across a promise of this promise (Comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to apply within a new promise of this promise.
        +
        Returns:
        +
        A new promise of the result of applying the given function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Promise<Promise<A>> cojoin()
        +
        Duplicates this promise to a promise of itself (Comonad pattern).
        +
        +
        Returns:
        +
        a promise of this promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public <B> Stream<B> sequenceW(Stream<F<Promise<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this promise, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this promise.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this promise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/Strategy.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/Strategy.html new file mode 100644 index 0000000..9ad5a7c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/Strategy.html @@ -0,0 +1,1118 @@ + + + + + +Strategy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Strategy<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Strategy<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strategy<A>
+extends java.lang.Object
    +
    Functional-style parallel evaluation strategies. + A Strategy is a method of evaluating a product-1, yielding another product-1 from which the result of its evaluation + can be retrieved at a later time. +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Strategy<java.util.concurrent.Callable<A>>callableStrategy(Strategy<java.util.concurrent.Callable<A>> s) +
      Provides a normalising strategy that fully evaluates its Callable argument.
      +
      static <A> Strategy<A>completionStrategy(java.util.concurrent.CompletionService<A> s) +
      Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
      +
      <B> F<B,P1<A>>concurry(F<B,A> f) +
      Promotes a function to a concurrent function.
      +
      <B,C> F<B,F<C,P1<A>>>concurry(F2<B,C,A> f) +
      Promotes a function of arity-2 to a concurrent function.
      +
      Strategy<A>contramap(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
      +
      static <A> Effect1<java.util.concurrent.Future<A>>discard() +
      Returns an Effect that waits for a given Future to obtain a value, discarding the value.
      +
      Strategy<A>errorStrategy(Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>errorStrategy(Strategy<A> s, + Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>executorStrategy(java.util.concurrent.ExecutorService s) +
      Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
      +
      F<P1<A>,P1<A>>f() +
      Returns the functional representation of this Strategy, a function that evaluates a product-1.
      +
      static <A> Strategy<A>idStrategy() +
      Provides a strategy that performs no evaluation of its argument.
      +
      Strategy<A>map(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's domain (Invariant Functor pattern).
      +
      static <A> List<P1<A>>mergeAll(List<java.util.concurrent.Future<A>> xs) +
      Waits for every Future in a list to obtain a value, and collects those values in a list.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<A>>obtain() +
      Returns a function which returns a product-1 which waits for the given Future to obtain a value.
      +
      static <A> P1<A>obtain(java.util.concurrent.Future<A> t) +
      Provides a product-1 that waits for the given future to obtain a value.
      +
      P1<A>par(P1<A> a) +
      Apply the strategy to the given product-1.
      +
      static <A,B> P1<Array<B>>parFlatMap(Strategy<Array<B>> s, + F<A,Array<B>> f, + Array<A> as) +
      Binds the given function in parallel across the given array, using the given strategy, with a final join.
      +
      static <A,B> P1<List<B>>parFlatMap(Strategy<List<B>> s, + F<A,List<B>> f, + List<A> as) +
      Binds the given function in parallel across the given list, using the given strategy, with a final join.
      +
      P1<List<A>>parList(List<P1<A>> ps) +
      Evaluates a list of product-1s in parallel.
      +
      static <A> P1<List<A>>parListChunk(Strategy<List<A>> s, + int chunkLength, + List<P1<A>> as) +
      Sequentially evaluates chunks (sub-sequences) of a list in parallel.
      +
      <B> P1<Array<A>>parMap(F<B,A> f, + Array<B> bs) +
      Maps the given function over the given array in parallel using this strategy.
      +
      <B> P1<List<A>>parMap(F<B,A> f, + List<B> bs) +
      Maps the given function over the given list in parallel using this strategy.
      +
      <B> Array<A>parMap1(F<B,A> f, + Array<B> bs) +
      A strict version of parMap over arrays.
      +
      <B> List<A>parMap1(F<B,A> f, + List<B> bs) +
      A strict version of parMap over lists.
      +
      <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>>parMapArray() +
      First-class version of parMap on arrays.
      +
      <B> F<Array<B>,P1<Array<A>>>parMapArray(F<B,A> f) +
      Promotes a function to a parallel function on arrays using this strategy.
      +
      <B> F<F<B,A>,F<Array<B>,Array<A>>>parMapArray1() +
      First-class version of parMap1 on arrays (parallel array functor).
      +
      <B> F<F<B,A>,F<List<B>,P1<List<A>>>>parMapList() +
      First-class version of parMap on lists.
      +
      <B> F<List<B>,P1<List<A>>>parMapList(F<B,A> f) +
      Promotes a function to a parallel function on lists using this strategy.
      +
      <B> F<F<B,A>,F<List<B>,List<A>>>parMapList1() +
      First-class version of parMap1 on lists (parallel list functor).
      +
      <B,C> F2<Array<B>,Array<C>,P1<Array<A>>>parZipArrayWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
      +
      <B,C> F2<List<B>,List<C>,P1<List<A>>>parZipListWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
      +
      <B,C> P1<Array<A>>parZipWith(F2<B,C,A> f, + Array<B> bs, + Array<C> cs) +
      Zips together two arrays in parallel using a given function, with this strategy.
      +
      <B,C> P1<List<A>>parZipWith(F2<B,C,A> f, + List<B> bs, + List<C> cs) +
      Zips together two lists in parallel using a given function, with this strategy.
      +
      static <A> Strategy<A>seqStrategy() +
      Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
      +
      static <A> Strategy<A>simpleThreadStrategy() +
      Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
      +
      static <A> Strategy<A>strategy(F<P1<A>,P1<A>> f) +
      Constructs a strategy from the given evaluation function.
      +
      <B> Strategy<B>xmap(F<P1<A>,P1<B>> f, + F<P1<B>,P1<A>> g) +
      Maps the given bijective transformation across this strategy (Exponential Functor pattern).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public F<P1<A>,P1<A>> f()
        +
        Returns the functional representation of this Strategy, a function that evaluates a product-1.
        +
        +
        Returns:
        +
        The function representing this strategy, which evaluates a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        strategy

        +
        public static <A> Strategy<A> strategy(F<P1<A>,P1<A>> f)
        +
        Constructs a strategy from the given evaluation function.
        +
        +
        Parameters:
        +
        f - The execution function for the strategy
        +
        Returns:
        +
        A strategy that uses the given function to evaluate product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        par

        +
        public P1<A> par(P1<A> a)
        +
        Apply the strategy to the given product-1.
        +
        +
        Parameters:
        +
        a - A P1 to evaluate according to this strategy.
        +
        Returns:
        +
        A P1 that yields the value from calling the given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B> F<B,P1<A>> concurry(F<B,A> f)
        +
        Promotes a function to a concurrent function.
        +
        +
        Parameters:
        +
        f - A function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a Future value.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B,C> F<B,F<C,P1<A>>> concurry(F2<B,C,A> f)
        +
        Promotes a function of arity-2 to a concurrent function.
        +
        +
        Parameters:
        +
        f - The function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a product-1 that returns the value.
        +
        +
        • +
      + + + +
        +
      • +

        mergeAll

        +
        public static <A> List<P1<A>> mergeAll(List<java.util.concurrent.Future<A>> xs)
        +
        Waits for every Future in a list to obtain a value, and collects those values in a list.
        +
        +
        Parameters:
        +
        xs - The list of Futures from which to get values.
        +
        Returns:
        +
        A list of values extracted from the Futures in the argument list.
        +
        +
        • +
      + + + +
        +
      • +

        parList

        +
        public P1<List<A>> parList(List<P1<A>> ps)
        +
        Evaluates a list of product-1s in parallel.
        +
        +
        Parameters:
        +
        ps - A list to evaluate in parallel.
        +
        Returns:
        +
        A list of the values of the product-1s in the argument.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<List<A>> parMap(F<B,A> f,
+                              List<B> bs)
        +
        Maps the given function over the given list in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<Array<A>> parMap(F<B,A> f,
+                               Array<B> bs)
        +
        Maps the given function over the given array in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> List<A> parMap1(F<B,A> f,
+                           List<B> bs)
        +
        A strict version of parMap over lists. + Maps the given function over the given list in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> Array<A> parMap1(F<B,A> f,
+                            Array<B> bs)
        +
        A strict version of parMap over arrays. + Maps the given function over the given arrays in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        An array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<List<B>,P1<List<A>>> parMapList(F<B,A> f)
        +
        Promotes a function to a parallel function on lists using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on lists.
        +
        Returns:
        +
        The function transformed into a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<F<B,A>,F<List<B>,P1<List<A>>>> parMapList()
        +
        First-class version of parMap on lists.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList1

        +
        public <B> F<F<B,A>,F<List<B>,List<A>>> parMapList1()
        +
        First-class version of parMap1 on lists (parallel list functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<Array<B>,P1<Array<A>>> parMapArray(F<B,A> f)
        +
        Promotes a function to a parallel function on arrays using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on arrays.
        +
        Returns:
        +
        The function transformed into a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>> parMapArray()
        +
        First-class version of parMap on arrays.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray1

        +
        public <B> F<F<B,A>,F<Array<B>,Array<A>>> parMapArray1()
        +
        First-class version of parMap1 on arrays (parallel array functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<List<B>> parFlatMap(Strategy<List<B>> s,
+                                           F<A,List<B>> f,
+                                           List<A> as)
        +
        Binds the given function in parallel across the given list, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given list.
        +
        as - The list across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<Array<B>> parFlatMap(Strategy<Array<B>> s,
+                                            F<A,Array<B>> f,
+                                            Array<A> as)
        +
        Binds the given function in parallel across the given array, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given array.
        +
        as - The array across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parListChunk

        +
        public static <A> P1<List<A>> parListChunk(Strategy<List<A>> s,
+                                           int chunkLength,
+                                           List<P1<A>> as)
        +
        Sequentially evaluates chunks (sub-sequences) of a list in parallel. Splits the list into chunks, + evaluating the chunks simultaneously, but each chunk as a sequence.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        chunkLength - The length of each sequence.
        +
        as - The list to evaluate in parallel chunks.
        +
        Returns:
        +
        A product-1 containing the list of results extracted from the given list of product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<List<A>> parZipWith(F2<B,C,A> f,
+                                    List<B> bs,
+                                    List<C> cs)
        +
        Zips together two lists in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the lists, position-wise, + passing elements from the first list to the first argument of the function, and elements from the second list + to the second argument of the function, yielding a list of the results. + If the lists are not of the same length, the remaining elements of the longer list are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A list to zip with the given function.
        +
        cs - A list to zip with the given function.
        +
        Returns:
        +
        The list of the results of calling the given function on corresponding elements of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<Array<A>> parZipWith(F2<B,C,A> f,
+                                     Array<B> bs,
+                                     Array<C> cs)
        +
        Zips together two arrays in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the arrays, position-wise, + passing elements from the first array to the first argument of the function, and elements from the second array + to the second argument of the function, yielding a array of the results. + If the arrays are not of the same length, the remaining elements of the longer array are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A array to zip with the given function.
        +
        cs - A array to zip with the given function.
        +
        Returns:
        +
        The array of the results of calling the given function on corresponding elements of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parZipListWith

        +
        public <B,C> F2<List<B>,List<C>,P1<List<A>>> parZipListWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two lists using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parZipArrayWith

        +
        public <B,C> F2<Array<B>,Array<C>,P1<Array<A>>> parZipArrayWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two arrays using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<A>> obtain()
        +
        Returns a function which returns a product-1 which waits for the given Future to obtain a value.
        +
        +
        Returns:
        +
        A function which, given a Future, yields a product-1 that waits for it.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> P1<A> obtain(java.util.concurrent.Future<A> t)
        +
        Provides a product-1 that waits for the given future to obtain a value.
        +
        +
        Parameters:
        +
        t - A Future for which to wait.
        +
        Returns:
        +
        A product-1 that waits for the given future to obtain a value.
        +
        +
        • +
      + + + +
        +
      • +

        discard

        +
        public static <A> Effect1<java.util.concurrent.Future<A>> discard()
        +
        Returns an Effect that waits for a given Future to obtain a value, discarding the value.
        +
        +
        Returns:
        +
        An effect, which, given a Future, waits for it to obtain a value, discarding the value.
        +
        +
        • +
      + + + +
        +
      • +

        simpleThreadStrategy

        +
        public static <A> Strategy<A> simpleThreadStrategy()
        +
        Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        Returns:
        +
        a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        • +
      + + + +
        +
      • +

        executorStrategy

        +
        public static <A> Strategy<A> executorStrategy(java.util.concurrent.ExecutorService s)
        +
        Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
        +
        +
        Parameters:
        +
        s - The ExecutorService to use for scheduling evaluations.
        +
        Returns:
        +
        A Strategy that uses the provided ExecutorService to control the method and degree + of parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        completionStrategy

        +
        public static <A> Strategy<A> completionStrategy(java.util.concurrent.CompletionService<A> s)
        +
        Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
        +
        +
        Parameters:
        +
        s - The CompletionService to use for scheduling evaluations and detect their completion.
        +
        Returns:
        +
        A Strategy that uses the provided CompletionService to control the method and degree of parallelism, + and notifies the service of task completion.
        +
        +
        • +
      + + + +
        +
      • +

        seqStrategy

        +
        public static <A> Strategy<A> seqStrategy()
        +
        Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        idStrategy

        +
        public static <A> Strategy<A> idStrategy()
        +
        Provides a strategy that performs no evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs no evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Strategy<B> xmap(F<P1<A>,P1<B>> f,
+                            F<P1<B>,P1<A>> g)
        +
        Maps the given bijective transformation across this strategy (Exponential Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        g - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that maps to this strategy and back again.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public Strategy<A> map(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's domain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        Returns:
        +
        A new strategy that applies the given transformation after each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public Strategy<A> contramap(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that applies the given transformation before each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public Strategy<A> errorStrategy(Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by this strategy and applies + the given side-effect to them.
        +
        +
        Parameters:
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public static <A> Strategy<A> errorStrategy(Strategy<A> s,
+                                            Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by the given strategy + and applies the given side-effect to them.
        +
        +
        Parameters:
        +
        s - The strategy to equip with an error-handling effect.
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        callableStrategy

        +
        public static <A> Strategy<java.util.concurrent.Callable<A>> callableStrategy(Strategy<java.util.concurrent.Callable<A>> s)
        +
        Provides a normalising strategy that fully evaluates its Callable argument.
        +
        +
        Parameters:
        +
        s - A non-normalising strategy to use for the evaluation.
        +
        Returns:
        +
        A new strategy that fully evaluates Callables, using the given strategy.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/package-frame.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-frame.html new file mode 100644 index 0000000..decae68 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-frame.html @@ -0,0 +1,24 @@ + + + + + +fj.control.parallel (core 4.8.1 API) + + + + + +

fj.control.parallel

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/package-summary.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-summary.html new file mode 100644 index 0000000..0ed7900 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-summary.html @@ -0,0 +1,175 @@ + + + + + +fj.control.parallel (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.parallel

+
+
Parallelization strategies.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Actor<A> +
    Light weight actors for Java.
    +
    Callables +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    ParModule +
    A module of higher-order concurrency features.
    +
    Promise<A> +
    Represents a non-blocking future value.
    +
    Strategy<A> +
    Functional-style parallel evaluation strategies.
    +
    +
    • +
+ + + +

Package fj.control.parallel Description

+
Parallelization strategies.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/control/parallel/package-tree.html b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-tree.html new file mode 100644 index 0000000..0ca037d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/control/parallel/package-tree.html @@ -0,0 +1,139 @@ + + + + + +fj.control.parallel Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.parallel

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/$.html b/javadoc/4.8.1/functionaljava/fj/data/$.html new file mode 100644 index 0000000..e8cc691 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/$.html @@ -0,0 +1,300 @@ + + + + + +$ (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class $<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<B>
      • +
    • +
        +
      • fj.data.$<A,B>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<B>
    +
    +
    +
    +
    public final class $<A,B>
+extends P1<B>
    +
    The constant arrow, for attaching a new name to an existing type. For every pair of types A and B, this type + is the identity morphism from B to B.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        __

        +
        public static <A,B> $<A,B> __(B b)
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> $<A,B> constant(B b)
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public B _1()
        +
        Description copied from class: P1
        +
        Access the first element of the product.
        +
        +
        Specified by:
        +
        _1 in class P1<B>
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Array.ImmutableProjection.html b/javadoc/4.8.1/functionaljava/fj/data/Array.ImmutableProjection.html new file mode 100644 index 0000000..cc69779 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Array.ImmutableProjection.html @@ -0,0 +1,679 @@ + + + + + +Array.ImmutableProjection (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array.ImmutableProjection<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array.ImmutableProjection<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Array<A>
    +
    +
    +
    +
    public static final class Array.ImmutableProjection<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Projects an array by providing only operations which do not mutate.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      intlength() +
      Returns the length of this array.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element + in Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Array.html b/javadoc/4.8.1/functionaljava/fj/data/Array.html new file mode 100644 index 0000000..f7cf5c8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Array.html @@ -0,0 +1,1719 @@ + + + + + +Array (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Array<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an interface to arrays.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Array.ImmutableProjection<A> +
      Projects an array by providing only operations which do not mutate.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      java.lang.Object[]array() +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>array(A... as) +
      Constructs an array from the given elements.
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>arrayArray(A... as) +
      Returns a copy of the underlying primitive array.
      +
      java.util.List<A>asJavaList() +
      Projects an unmodifiable list view of this array.
      +
      <B,C> Array<C>bind(Array<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B,C> Array<C>bind(Array<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      static <T> T[]copyOf(T[] a, + int len) 
      static <T,U> T[]copyOf(U[] a, + int len, + java.lang.Class<? extends T[]> newType) 
      static char[]copyOfRange(char[] a, + int from, + int to) 
      static <A> Array<A>empty() +
      Returns an empty array.
      +
      booleanequals(java.lang.Object o) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      inthashCode() 
      Array.ImmutableProjection<A>immutable() 
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      static <A> Array<A>iterableArray(java.lang.Iterable<A> i) +
      Takes the given iterable to an array.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      static <A> Array<A>iteratorArray(java.util.Iterator<A> i) +
      Creates an Array from the iterator.
      +
      static <A> F<Array<Array<A>>,Array<A>>join() +
      A first-class version of join
      +
      static <A> Array<A>join(Array<Array<A>> o) +
      Joins the given array of arrays using a bind operation.
      +
      intlength() +
      Returns the length of this array.
      +
      static <A,B> F<F<A,B>,F<Array<A>,Array<B>>>map() +
      First-class map function for Arrays.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      static Array<java.lang.Integer>range(int from, + int to) +
      Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>scanLeft(F<B,F<A,B>> f, + B b) +
      Performs a fold left accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F<A,F<A,A>> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F2<A,A,A> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F2<A,B,B> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F<A,F<A,A>> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F2<A,A,A> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      Unitset(int index, + A a) +
      Sets the element at the given index to the given value.
      +
      static <A> Array<A>single(A a) +
      Constructs a singleton array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.ArrayList<A>toJavaList() +
      Returns a java.util.ArrayList projection of this array.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element in + Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      java.lang.StringtoString() 
      static <A,B> P2<Array<A>,Array<B>>unzip(Array<P2<A,B>> xs) +
      Transforms an array of pairs into an array of first components and an array of second components.
      +
      static <A> F<A[],Array<A>>wrap() +
      First-class wrapper function for arrays.
      +
      <B> Array<P2<A,B>>zip(Array<B> bs) +
      Zips this array with the given array to produce an array of pairs.
      +
      Array<P2<A,java.lang.Integer>>zipIndex() +
      Zips this array with the index of its element as a pair.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F<A,F<B,C>> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F2<A,B,C> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public Unit set(int index,
+                A a)
        +
        Sets the element at the given index to the given value.
        +
        +
        Parameters:
        +
        index - The index at which to set the given value.
        +
        a - The value to set at the given index.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public A[] array(java.lang.Class<A[]> c)
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Parameters:
        +
        c - A class for the returned array.
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public java.lang.Object[] array()
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Returns:
        +
        A copy of the underlying primitive array;
        +
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element in + Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F<B,F<A,B>> f,
+                             B b)
        +
        Performs a fold left accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F2<B,A,B> f,
+                             B b)
        +
        Performs a left-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F2<A,A,A> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F2<A,A,A> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F<A,F<B,C>> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F2<A,B,C> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Array<A> empty()
        +
        Returns an empty array.
        +
        +
        Returns:
        +
        An empty array.
        +
        +
        • +
      + + + + + +
        +
      • +

        array

        +
        @SafeVarargs
+public static <A> Array<A> array(A... as)
        +
        Constructs an array from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct the array with.
        +
        Returns:
        +
        A new array of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Array<A> single(A a)
        +
        Constructs a singleton array.
        +
        +
        Parameters:
        +
        a - The element to put in the array.
        +
        Returns:
        +
        An array with the given single element.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A> F<A[],Array<A>> wrap()
        +
        First-class wrapper function for arrays.
        +
        +
        Returns:
        +
        A function that wraps a given array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Array<A>,Array<B>>> map()
        +
        First-class map function for Arrays.
        +
        +
        Returns:
        +
        A function that maps a given function across a given array.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Array<A> join(Array<Array<A>> o)
        +
        Joins the given array of arrays using a bind operation.
        +
        +
        Parameters:
        +
        o - The array of arrays to join.
        +
        Returns:
        +
        A new array that is the join of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Array<Array<A>>,Array<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a array of arrays using a bind operation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this array.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this array, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on the elements of this array.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + array.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this array.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Array<java.lang.Integer> range(int from,
+                                             int to)
        +
        Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the array (inclusive).
        +
        to - The maximum value for the array (exclusive).
        +
        Returns:
        +
        An array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F<A,F<B,C>> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F2<A,B,C> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> Array<P2<A,B>> zip(Array<B> bs)
        +
        Zips this array with the given array to produce an array of pairs. If this array and the given + array have different lengths, then the longer array is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public Array<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this array with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new array with the same length as this array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        asJavaList

        +
        public java.util.List<A> asJavaList()
        +
        Projects an unmodifiable list view of this array.
        +
        +
        Returns:
        +
        An unmodifiable list view of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.ArrayList<A> toJavaList()
        +
        Returns a java.util.ArrayList projection of this array.
        +
        • +
      + + + +
        +
      • +

        iterableArray

        +
        public static <A> Array<A> iterableArray(java.lang.Iterable<A> i)
        +
        Takes the given iterable to an array.
        +
        +
        Parameters:
        +
        i - The iterable to take to an array.
        +
        Returns:
        +
        An array from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorArray

        +
        public static <A> Array<A> iteratorArray(java.util.Iterator<A> i)
        +
        Creates an Array from the iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayArray

        +
        @SafeVarargs
+public static <A> Array<A> arrayArray(A... as)
        +
        Returns a copy of the underlying primitive array. + Equivalent to array(A...)
        +
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Array<A>,Array<B>> unzip(Array<P2<A,B>> xs)
        +
        Transforms an array of pairs into an array of first components and an array of second components.
        +
        +
        Parameters:
        +
        xs - The array of pairs to transform.
        +
        Returns:
        +
        An array of first components and an array of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T,U> T[] copyOf(U[] a,
+                               int len,
+                               java.lang.Class<? extends T[]> newType)
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T> T[] copyOf(T[] a,
+                             int len)
        +
        • +
      + + + +
        +
      • +

        copyOfRange

        +
        public static char[] copyOfRange(char[] a,
+                                 int from,
+                                 int to)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Conversions.html b/javadoc/4.8.1/functionaljava/fj/data/Conversions.html new file mode 100644 index 0000000..4b4972a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Conversions.html @@ -0,0 +1,1607 @@ + + + + + +Conversions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Conversions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Conversions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Conversions
+extends java.lang.Object
    +
    Functions that convert between data structure types.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        List_String

        +
        public static final F<List<java.lang.Character>,java.lang.String> List_String
        +
        A function that converts lists to strings.
        +
        • +
      + + + +
        +
      • +

        List_StringBuffer

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuffer> List_StringBuffer
        +
        A function that converts lists to string buffers.
        +
        • +
      + + + +
        +
      • +

        List_StringBuilder

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuilder> List_StringBuilder
        +
        A function that converts lists to string builders.
        +
        • +
      + + + +
        +
      • +

        Array_String

        +
        public static final F<Array<java.lang.Character>,java.lang.String> Array_String
        +
        A function that converts arrays to strings.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuffer

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuffer> Array_StringBuffer
        +
        A function that converts arrays to string buffers.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuilder

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuilder> Array_StringBuilder
        +
        A function that converts arrays to string builders.
        +
        • +
      + + + +
        +
      • +

        Stream_String

        +
        public static final F<Stream<java.lang.Character>,java.lang.String> Stream_String
        +
        A function that converts streams to strings.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuffer

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuffer> Stream_StringBuffer
        +
        A function that converts streams to string buffers.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuilder

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuilder> Stream_StringBuilder
        +
        A function that converts streams to string builders.
        +
        • +
      + + + +
        +
      • +

        Option_String

        +
        public static final F<Option<java.lang.Character>,java.lang.String> Option_String
        +
        A function that converts options to strings.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuffer

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuffer> Option_StringBuffer
        +
        A function that converts options to string buffers.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuilder

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuilder> Option_StringBuilder
        +
        A function that converts options to string builders.
        +
        • +
      + + + +
        +
      • +

        String_List

        +
        public static final F<java.lang.String,List<java.lang.Character>> String_List
        +
        A function that converts strings to lists.
        +
        • +
      + + + +
        +
      • +

        String_Array

        +
        public static final F<java.lang.String,Array<java.lang.Character>> String_Array
        +
        A function that converts strings to arrays.
        +
        • +
      + + + +
        +
      • +

        String_Option

        +
        public static final F<java.lang.String,Option<java.lang.Character>> String_Option
        +
        A function that converts strings to options.
        +
        • +
      + + + +
        +
      • +

        String_Stream

        +
        public static final F<java.lang.String,Stream<java.lang.Character>> String_Stream
        +
        A function that converts strings to streams.
        +
        • +
      + + + +
        +
      • +

        String_StringBuffer

        +
        public static final F<java.lang.String,java.lang.StringBuffer> String_StringBuffer
        +
        A function that converts strings to string buffers.
        +
        • +
      + + + +
        +
      • +

        String_StringBuilder

        +
        public static final F<java.lang.String,java.lang.StringBuilder> String_StringBuilder
        +
        A function that converts strings to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_List

        +
        public static final F<java.lang.StringBuffer,List<java.lang.Character>> StringBuffer_List
        +
        A function that converts string buffers to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Array

        +
        public static final F<java.lang.StringBuffer,Array<java.lang.Character>> StringBuffer_Array
        +
        A function that converts string buffers to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stream

        +
        public static final F<java.lang.StringBuffer,Stream<java.lang.Character>> StringBuffer_Stream
        +
        A function that converts string buffers to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Option

        +
        public static final F<java.lang.StringBuffer,Option<java.lang.Character>> StringBuffer_Option
        +
        A function that converts string buffers to options.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_String

        +
        public static final F<java.lang.StringBuffer,java.lang.String> StringBuffer_String
        +
        A function that converts string buffers to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_StringBuilder

        +
        public static final F<java.lang.StringBuffer,java.lang.StringBuilder> StringBuffer_StringBuilder
        +
        A function that converts string buffers to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_List

        +
        public static final F<java.lang.StringBuilder,List<java.lang.Character>> StringBuilder_List
        +
        A function that converts string builders to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Array

        +
        public static final F<java.lang.StringBuilder,Array<java.lang.Character>> StringBuilder_Array
        +
        A function that converts string builders to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stream

        +
        public static final F<java.lang.StringBuilder,Stream<java.lang.Character>> StringBuilder_Stream
        +
        A function that converts string builders to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Option

        +
        public static final F<java.lang.StringBuilder,Option<java.lang.Character>> StringBuilder_Option
        +
        A function that converts string builders to options.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_String

        +
        public static final F<java.lang.StringBuilder,java.lang.String> StringBuilder_String
        +
        A function that converts string builders to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_StringBuffer

        +
        public static final F<java.lang.StringBuilder,java.lang.StringBuffer> StringBuilder_StringBuffer
        +
        A function that converts string builders to string buffers.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_Array

        +
        public static <A> F<List<A>,Array<A>> List_Array()
        +
        A function that converts lists to arrays.
        +
        +
        Returns:
        +
        A function that converts lists to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stream

        +
        public static <A> F<List<A>,Stream<A>> List_Stream()
        +
        A function that converts lists to streams.
        +
        +
        Returns:
        +
        A function that converts lists to streams.
        +
        +
        • +
      + + + +
        +
      • +

        List_Option

        +
        public static <A> F<List<A>,Option<A>> List_Option()
        +
        A function that converts lists to options.
        +
        +
        Returns:
        +
        A function that converts lists to options.
        +
        +
        • +
      + + + +
        +
      • +

        List_Either

        +
        public static <A,B> F<P1<A>,F<List<B>,Either<A,B>>> List_Either()
        +
        A function that converts lists to eithers.
        +
        +
        Returns:
        +
        A function that converts lists to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Array_List

        +
        public static <A> F<Array<A>,List<A>> Array_List()
        +
        A function that converts arrays to lists.
        +
        +
        Returns:
        +
        A function that converts arrays to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stream

        +
        public static <A> F<Array<A>,Stream<A>> Array_Stream()
        +
        A function that converts arrays to streams.
        +
        +
        Returns:
        +
        A function that converts arrays to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Option

        +
        public static <A> F<Array<A>,Option<A>> Array_Option()
        +
        A function that converts arrays to options.
        +
        +
        Returns:
        +
        A function that converts arrays to options.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Either

        +
        public static <A,B> F<P1<A>,F<Array<B>,Either<A,B>>> Array_Either()
        +
        A function that converts arrays to eithers.
        +
        +
        Returns:
        +
        A function that converts arrays to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_List

        +
        public static <A> F<Stream<A>,List<A>> Stream_List()
        +
        A function that converts streams to lists.
        +
        +
        Returns:
        +
        A function that converts streams to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Array

        +
        public static <A> F<Stream<A>,Array<A>> Stream_Array()
        +
        A function that converts streams to arrays.
        +
        +
        Returns:
        +
        A function that converts streams to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Option

        +
        public static <A> F<Stream<A>,Option<A>> Stream_Option()
        +
        A function that converts streams to options.
        +
        +
        Returns:
        +
        A function that converts streams to options.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Either

        +
        public static <A,B> F<P1<A>,F<Stream<B>,Either<A,B>>> Stream_Either()
        +
        A function that converts streams to eithers.
        +
        +
        Returns:
        +
        A function that converts streams to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Option_List

        +
        public static <A> F<Option<A>,List<A>> Option_List()
        +
        A function that converts options to lists.
        +
        +
        Returns:
        +
        A function that converts options to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Array

        +
        public static <A> F<Option<A>,Array<A>> Option_Array()
        +
        A function that converts options to arrays.
        +
        +
        Returns:
        +
        A function that converts options to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stream

        +
        public static <A> F<Option<A>,Stream<A>> Option_Stream()
        +
        A function that converts options to streams.
        +
        +
        Returns:
        +
        A function that converts options to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Either

        +
        public static <A,B> F<P1<A>,F<Option<B>,Either<A,B>>> Option_Either()
        +
        A function that converts options to eithers.
        +
        +
        Returns:
        +
        A function that converts options to eithers.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        Effect0_P1

        +
        public static P1<Unit> Effect0_P1(Effect0 e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<A,Unit> Effect1_F(Effect1<A> e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<Effect1<A>,F<A,Unit>> Effect1_F()
        +
        • +
      + + + +
        +
      • +

        Effect_IO

        +
        public static IO<Unit> Effect_IO(Effect0 e)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        Either_ListA

        +
        public static <A,B> F<Either<A,B>,List<A>> Either_ListA()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ListB

        +
        public static <A,B> F<Either<A,B>,List<B>> Either_ListB()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayA

        +
        public static <A,B> F<Either<A,B>,Array<A>> Either_ArrayA()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayB

        +
        public static <A,B> F<Either<A,B>,Array<B>> Either_ArrayB()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamA

        +
        public static <A,B> F<Either<A,B>,Stream<A>> Either_StreamA()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamB

        +
        public static <A,B> F<Either<A,B>,Stream<B>> Either_StreamB()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionA

        +
        public static <A,B> F<Either<A,B>,Option<A>> Either_OptionA()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionB

        +
        public static <A,B> F<Either<A,B>,Option<B>> Either_OptionB()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.String> Either_StringA()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.String> Either_StringB()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuffer> Either_StringBufferA()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuffer> Either_StringBufferB()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuilder> Either_StringBuilderA()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuilder> Either_StringBuilderB()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> SafeIO<A> F_SafeIO(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> F<F<Unit,A>,SafeIO<A>> F_SafeIO()
        +
        • +
      + + + +
        +
      • +

        String_Either

        +
        public static <A> F<P1<A>,F<java.lang.String,Either<A,java.lang.Character>>> String_Either()
        +
        A function that converts string to eithers.
        +
        +
        Returns:
        +
        A function that converts string to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuffer,Either<A,java.lang.Character>>> StringBuffer_Either()
        +
        A function that converts string buffers to eithers.
        +
        +
        Returns:
        +
        A function that converts string buffers to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuilder,Either<A,java.lang.Character>>> StringBuilder_Either()
        +
        A function that converts string builders to eithers.
        +
        +
        Returns:
        +
        A function that converts string builders to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> SafeIO<Validation<Z,A>> Try_SafeIO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> F<Try0<A,Z>,SafeIO<Validation<Z,A>>> Try_SafeIO()
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> IO<A> Try_IO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> F<Try0<A,Z>,IO<A>> Try_IO()
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<A,Validation<Z,B>> Try_F(Try1<A,B,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<Try1<A,B,Z>,F<A,Validation<Z,B>>> Try_F()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/DList.html b/javadoc/4.8.1/functionaljava/fj/data/DList.html new file mode 100644 index 0000000..f2d18d8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/DList.html @@ -0,0 +1,474 @@ + + + + + +DList (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class DList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.DList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DList<A>
+extends java.lang.Object
    +
    Difference List. It converts left associative appends into right associative ones to improve performance.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DList<A>append(DList<A> other) +
      Appends two DLists together to produce a new DList.
      +
      static <A> DList<A>arrayDList(A... as) +
      Creates a DList from an array
      +
      DList<A>cons(A a) +
      Prepends a single element on the DList to produce a new DList.
      +
      static <A> DList<A>dlist(F<List<A>,Trampoline<List<A>>> f) +
      Creates a DList from the function + + For alternatives functions to create a DList:
      +
      static <A> DList<A>iterableDList(java.lang.Iterable<A> it) +
      Creates a DList from an Iterable
      +
      static <A> DList<A>iteratorDList(java.util.Iterator<A> it) +
      Creates a DList from an Iterator
      +
      static <A> DList<A>listDList(List<A> a) +
      Creates a DList from a List
      +
      static <A> DList<A>nil() +
      A empty DList.
      +
      List<A>run() +
      Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
      +
      static <A> DList<A>single(A a) +
      Produces a DList with one element.
      +
      DList<A>snoc(A a) +
      Appends a single element on the end of the DList to produce a new DList.
      +
      java.util.List<A>toJavaList() +
      Converts the DList to a standard java.util.List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        listDList

        +
        public static <A> DList<A> listDList(List<A> a)
        +
        Creates a DList from a List
        +
        • +
      + + + +
        +
      • +

        iterableDList

        +
        public static <A> DList<A> iterableDList(java.lang.Iterable<A> it)
        +
        Creates a DList from an Iterable
        +
        • +
      + + + +
        +
      • +

        iteratorDList

        +
        public static <A> DList<A> iteratorDList(java.util.Iterator<A> it)
        +
        Creates a DList from an Iterator
        +
        • +
      + + + + + +
        +
      • +

        arrayDList

        +
        @SafeVarargs
+public static <A> DList<A> arrayDList(A... as)
        +
        Creates a DList from an array
        +
        • +
      + + + +
        +
      • +

        run

        +
        public List<A> run()
        +
        Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List. + This is what converts the appending operation from left associative to right associative, + giving DList it's speed.
        +
        +
        Returns:
        +
        the final List
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the DList to a standard java.util.List.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> DList<A> nil()
        +
        A empty DList.
        +
        +
        Type Parameters:
        +
        A -
        +
        Returns:
        +
        a empty DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> DList<A> single(A a)
        +
        Produces a DList with one element.
        +
        +
        Type Parameters:
        +
        A -
        +
        Parameters:
        +
        a - the element in the DList.
        +
        Returns:
        +
        a DList with one element.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public DList<A> cons(A a)
        +
        Prepends a single element on the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public DList<A> snoc(A a)
        +
        Appends a single element on the end of the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public DList<A> append(DList<A> other)
        +
        Appends two DLists together to produce a new DList.
        +
        +
        Parameters:
        +
        other - the other DList to append on the end of this one.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Either.LeftProjection.html b/javadoc/4.8.1/functionaljava/fj/data/Either.LeftProjection.html new file mode 100644 index 0000000..a76c8c0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Either.LeftProjection.html @@ -0,0 +1,794 @@ + + + + + +Either.LeftProjection (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.LeftProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.LeftProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.LeftProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A left projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<X,B>apply(Either<F<A,X>,B> e) +
      Function application on this projection's value.
      +
      <X> Either<X,B>bind(F<A,Either<X,B>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<A,X>>filter(F<A,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<A,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<X,B>map(F<A,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Aon(F<B,A> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      AorValue(A a) +
      The value of this projection or the given argument.
      +
      AorValue(F0<A> a) +
      The value of this projection or the given argument.
      +
      <X> Either<X,B>sequence(Either<X,B> e) +
      Anonymous bind through this projection.
      +
      Array<A>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<A>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<A>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<A>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<C,B>>traverseIO(F<A,IO<C>> f) +
      Anonymous bind through this projection.
      +
      <C> List<Either<C,B>>traverseList(F<A,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<C,B>>traverseOption(F<A,Option<C>> f) 
      <C> Stream<Either<C,B>>traverseStream(F<A,Stream<C>> f) 
      Avalue() +
      The value of this projection or fails with a specialised error message.
      +
      AvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      AvalueE(java.lang.String err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(java.lang.String err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public A orValue(F0<A> a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orValue

        +
        public A orValue(A a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public A on(F<B,A> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<X,B> map(F<A,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<X,B> bind(F<A,Either<X,B>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<X,B> sequence(Either<X,B> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<C,B>> traverseList(F<A,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<C,B>> traverseIO(F<A,IO<C>> f)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<A,X>> filter(F<A,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<X,B> apply(Either<F<A,X>,B> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Either.RightProjection.html b/javadoc/4.8.1/functionaljava/fj/data/Either.RightProjection.html new file mode 100644 index 0000000..b85814a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Either.RightProjection.html @@ -0,0 +1,761 @@ + + + + + +Either.RightProjection (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.RightProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.RightProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<B>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.RightProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<B>
    +
    A right projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<A,X>apply(Either<A,F<B,X>> e) +
      Function application on this projection's value.
      +
      <X> Either<A,X>bind(F<B,Either<A,X>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<B,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<X,B>>filter(F<B,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
      +
      booleanforall(F<B,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<B,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<B> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<B>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<A,X>map(F<B,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Bon(F<A,B> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      BorValue(F0<B> b) +
      The value of this projection or the given argument.
      +
      <X> Either<A,X>sequence(Either<A,X> e) +
      Anonymous bind through this projection.
      +
      Array<B>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<B>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<B>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<B>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<B>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<A,C>>traverseIO(F<B,IO<C>> f) +
      Traverse with a function that has IO effect
      +
      <C> List<Either<A,C>>traverseList(F<B,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<A,C>>traverseOption(F<B,Option<C>> f) 
      <C> P1<Either<A,C>>traverseP1(F<B,P1<C>> f) 
      <C> Stream<Either<A,C>>traverseStream(F<B,Stream<C>> f) 
      Bvalue() +
      The value of this projection or fails with a specialised error message.
      +
      BvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<B> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<B>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public B valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public B value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public B orValue(F0<B> b)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        b - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public B on(F<A,B> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<B,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<B> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<A,X> map(F<B,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<A,X> bind(F<B,Either<A,X>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<A,X> sequence(Either<A,X> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<A,C>> traverseList(F<B,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<A,C>> traverseIO(F<B,IO<C>> f)
        +
        Traverse with a function that has IO effect
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <C> P1<Either<A,C>> traverseP1(F<B,P1<C>> f)
        +
        • +
      + + + + + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<X,B>> filter(F<B,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<A,X> apply(Either<A,F<B,X>> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<B,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<B,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<B> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<B> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<B> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<B> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<B> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Either.html b/javadoc/4.8.1/functionaljava/fj/data/Either.html new file mode 100644 index 0000000..f58a5ac --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Either.html @@ -0,0 +1,944 @@ + + + + + +Either (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Either<A,B>
+extends java.lang.Object
    +
    The Either type represents a value of one of two possible types (a disjoint union). + The data constructors; Left and Right represent the two possible + values. The Either type is often used as an alternative to + scala.Option where Left represents failure (by convention) and + Right is akin to Some.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        left

        +
        public final Either.LeftProjection<A,B> left()
        +
        Projects this either as a left.
        +
        +
        Returns:
        +
        A left projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public final Either.RightProjection<A,B> right()
        +
        Projects this either as a right.
        +
        +
        Returns:
        +
        A right projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        isLeft

        +
        public abstract boolean isLeft()
        +
        Returns true if this either is a left, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a left, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isRight

        +
        public abstract boolean isRight()
        +
        Returns true if this either is a right, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a right, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public abstract <X> X either(F<A,X> left,
+                             F<B,X> right)
        +
        The catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public final <X,Y> Either<X,Y> bimap(F<A,X> left,
+                                     F<B,Y> right)
        +
        Map the given functions across the appropriate side.
        +
        +
        Parameters:
        +
        left - The function to map if this is left.
        +
        right - The function to map if this is right.
        +
        Returns:
        +
        A new either value after mapping with the appropriate function applied.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final Either<B,A> swap()
        +
        If this is a left, then return the left value in right, or vice versa.
        +
        +
        Returns:
        +
        The value of this either swapped to the opposing side.
        +
        +
        • +
      + + + + + +
        +
      • +

        left

        +
        public static <A,B> Either<A,B> left(A a)
        +
        Construct a left value of either.
        +
        +
        Parameters:
        +
        a - The value underlying the either.
        +
        Returns:
        +
        A left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A,B> F<A,Either<A,B>> left_()
        +
        A function that constructs a left value of either.
        +
        +
        Returns:
        +
        A function that constructs a left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A,B> F<B,Either<A,B>> right_()
        +
        A function that constructs a right value of either.
        +
        +
        Returns:
        +
        A function that constructs a right value of either.
        +
        +
        • +
      + + + + + +
        +
      • +

        right

        +
        public static <A,B> Either<A,B> right(B b)
        +
        Construct a right value of either.
        +
        +
        Parameters:
        +
        b - The value underlying the either.
        +
        Returns:
        +
        A right value of either.
        +
        +
        • +
      + + + +
        +
      • +

        either_

        +
        public static <A,B,X> F<Either<A,B>,X> either_(F<A,X> left,
+                                               F<B,X> right)
        +
        First class catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        leftMap_

        +
        public static <A,B,X> F<F<A,X>,F<Either<A,B>,Either<X,B>>> leftMap_()
        +
        +
        Returns:
        +
        A function that maps another function across an either's left projection.
        +
        +
        • +
      + + + +
        +
      • +

        rightMap_

        +
        public static <A,B,X> F<F<B,X>,F<Either<A,B>,Either<A,X>>> rightMap_()
        +
        +
        Returns:
        +
        A function that maps another function across an either's right projection.
        +
        +
        • +
      + + + +
        +
      • +

        joinLeft

        +
        public static <A,B> Either<A,B> joinLeft(Either<Either<A,B>,B> e)
        +
        Joins an either through left.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + +
        +
      • +

        joinRight

        +
        public static <A,B> Either<A,B> joinRight(Either<A,Either<A,B>> e)
        +
        Joins an either through right.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceLeft

        +
        public static <A,X> Either<List<A>,X> sequenceLeft(List<Either<A,X>> a)
        +
        Sequences through the left side of the either monad with a list of values.
        +
        +
        Parameters:
        +
        a - The list of values to sequence with the either monad.
        +
        Returns:
        +
        A sequenced value.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceRight

        +
        public static <B,X> Either<X,List<B>> sequenceRight(List<Either<X,B>> a)
        +
        Sequences through the right side of the either monad with a list of values.
        +
        +
        Parameters:
        +
        a - The list of values to sequence with the either monad.
        +
        Returns:
        +
        A sequenced value.
        +
        +
        • +
      + + + +
        +
      • +

        traverseListRight

        +
        public final <C> List<Either<A,C>> traverseListRight(F<B,List<C>> f)
        +
        Traversable instance of RightProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseListLeft

        +
        public final <C> List<Either<C,B>> traverseListLeft(F<A,List<C>> f)
        +
        Traversable instance of LeftProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIORight

        +
        public final <C> IO<Either<A,C>> traverseIORight(F<B,IO<C>> f)
        +
        Traversable instance of RightProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIOLeft

        +
        public final <C> IO<Either<C,B>> traverseIOLeft(F<A,IO<C>> f)
        +
        Traversable instance of LeftProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionRight

        +
        public final <C> Option<Either<A,C>> traverseOptionRight(F<B,Option<C>> f)
        +
        Traversable instance of RightProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionLeft

        +
        public final <C> Option<Either<C,B>> traverseOptionLeft(F<A,Option<C>> f)
        +
        Traversable instance of LeftProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamRight

        +
        public final <C> Stream<Either<A,C>> traverseStreamRight(F<B,Stream<C>> f)
        +
        Traversable instance of RightProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamLeft

        +
        public final <C> Stream<Either<C,B>> traverseStreamLeft(F<A,Stream<C>> f)
        +
        Traversable instance of LeftProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public static <A> A reduce(Either<A,A> e)
        +
        Takes an Either to its contained value within left or right.
        +
        +
        Parameters:
        +
        e - The either to reduce.
        +
        Returns:
        +
        An Either to its contained value within left or right.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A,B> Either<A,B> iif(boolean c,
+                                    F0<B> right,
+                                    F0<A> left)
        +
        If the condition satisfies, return the given A in left, otherwise, return the given B in right.
        +
        +
        Parameters:
        +
        c - The condition to test.
        +
        right - The right value to use if the condition satisfies.
        +
        left - The left value to use if the condition does not satisfy.
        +
        Returns:
        +
        A constructed either based on the given condition.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public static <A,B> List<A> lefts(List<Either<A,B>> es)
        +
        Returns all the left values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible left values.
        +
        Returns:
        +
        All the left values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public static <A,B> List<B> rights(List<Either<A,B>> es)
        +
        Returns all the right values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible right values.
        +
        Returns:
        +
        All the right values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Enumerator.html b/javadoc/4.8.1/functionaljava/fj/data/Enumerator.html new file mode 100644 index 0000000..a0e7e7a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Enumerator.html @@ -0,0 +1,858 @@ + + + + + +Enumerator (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Enumerator<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Enumerator<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Enumerator<A>
+extends java.lang.Object
    +
    Abstracts over a type that may have a successor and/or predecessor value. This implies ordering for that type. A user + may construct an enumerator with an optimised version for plus, otherwise a default is implemented using + the given successor/predecessor implementations. +

    + For any enumerator e, the following laws must satisfy: +

      +
    • forall a. e.successor(a).forall(\t -> e.predecessor(t).forall(\z -> z == a))
      • +
    • forall a. e.predecessor(a).forall(\t -> e.successor(t).forall(\z -> z == a))
      • +
    • e.max().forall(\t -> e.successor(t).isNone)
      • +
    • e.min().forall(\t -> e.predecessor(t).isNone)
      • +
    • forall a n. e.plus(a, 0) == Some(a)
      • +
    • forall a n | n > 0. e.plus(a, n) == e.plus(a, n - 1)
      • +
    • forall a n | n < 0. e.plus(a, n) == e.plus(a, n + 1)
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEnumerator

        +
        public static final Enumerator<java.lang.Boolean> booleanEnumerator
        +
        An enumerator for boolean.
        +
        • +
      + + + +
        +
      • +

        byteEnumerator

        +
        public static final Enumerator<java.lang.Byte> byteEnumerator
        +
        An enumerator for byte.
        +
        • +
      + + + +
        +
      • +

        charEnumerator

        +
        public static final Enumerator<java.lang.Character> charEnumerator
        +
        An enumerator for char.
        +
        • +
      + + + +
        +
      • +

        doubleEnumerator

        +
        public static final Enumerator<java.lang.Double> doubleEnumerator
        +
        An enumerator for double.
        +
        • +
      + + + +
        +
      • +

        floatEnumerator

        +
        public static final Enumerator<java.lang.Float> floatEnumerator
        +
        An enumerator for float.
        +
        • +
      + + + +
        +
      • +

        intEnumerator

        +
        public static final Enumerator<java.lang.Integer> intEnumerator
        +
        An enumerator for int.
        +
        • +
      + + + +
        +
      • +

        bigintEnumerator

        +
        public static final Enumerator<java.math.BigInteger> bigintEnumerator
        +
        An enumerator for BigInteger.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEnumerator

        +
        public static final Enumerator<java.math.BigDecimal> bigdecimalEnumerator
        +
        An enumerator for BigDecimal.
        +
        • +
      + + + +
        +
      • +

        longEnumerator

        +
        public static final Enumerator<java.lang.Long> longEnumerator
        +
        An enumerator for long.
        +
        • +
      + + + +
        +
      • +

        shortEnumerator

        +
        public static final Enumerator<java.lang.Short> shortEnumerator
        +
        An enumerator for short.
        +
        • +
      + + + +
        +
      • +

        orderingEnumerator

        +
        public static final Enumerator<Ordering> orderingEnumerator
        +
        An enumerator for Ordering.
        +
        • +
      + + + +
        +
      • +

        naturalEnumerator

        +
        public static final Enumerator<Natural> naturalEnumerator
        +
        An enumerator for Natural
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        successor

        +
        public F<A,Option<A>> successor()
        +
        Returns the potential successor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential successor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        successor

        +
        public Option<A> successor(A a)
        +
        Returns the potential successor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the successor of.
        +
        Returns:
        +
        The potential successor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        predecessor

        +
        public F<A,Option<A>> predecessor()
        +
        Returns the potential predecessor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        predecessor

        +
        public Option<A> predecessor(A a)
        +
        Returns the potential predecessor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the predecessor of.
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<A> max()
        +
        Returns the maximum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The maximum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<A> min()
        +
        Returns the minimum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The minimum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,F<java.lang.Long,Option<A>>> plus()
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public F<java.lang.Long,Option<A>> plus(A a)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,Option<A>> plus(long l)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public Option<A> plus(A a,
+                      long l)
        +
        Moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A potential value after having moved the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        order

        +
        public Ord<A> order()
        +
        Returns the ordering for the enumerator.
        +
        +
        Returns:
        +
        The ordering for the enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Enumerator<B> xmap(F<A,B> f,
+                              F<B,A> g)
        +
        Invariant functor map over this enumerator.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        An enumerator after the given functions are applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream(A a)
        +
        Returns a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        Parameters:
        +
        a - A value at which to begin the stream.
        +
        Returns:
        +
        a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        • +
      + + + +
        +
      • +

        setMin

        +
        public Enumerator<A> setMin(Option<A> min)
        +
        Create a new enumerator with the given minimum value.
        +
        +
        Parameters:
        +
        min - A minimum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given minimum value.
        +
        +
        • +
      + + + +
        +
      • +

        setMax

        +
        public Enumerator<A> setMax(Option<A> max)
        +
        Create a new enumerator with the given maximum value.
        +
        +
        Parameters:
        +
        max - A maximum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given maximum value.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order,
+                                           F<A,F<java.lang.Long,Option<A>>> plus)
        +
        Construct an enumerator. `
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        plus - The function to move the enumeration a given number of times. This may be supplied for a performance + enhancement for certain types.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order)
        +
        Construct an enumerator. The plus function is derived from the successor and + predecessor.
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Eval.html b/javadoc/4.8.1/functionaljava/fj/data/Eval.html new file mode 100644 index 0000000..4aec493 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Eval.html @@ -0,0 +1,450 @@ + + + + + +Eval (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Eval<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Eval<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Eval<A>
+extends java.lang.Object
    +
    Eval is an abstraction over different models of evaluation. + The data constructors: +
      +
    • Now - the value is evaluated immediately.
      • +
    • Later - the value is evaluated only once when it's requested (lazy evaluation).
      • +
    • Always - the value is evaluated every time when it's requested.
      • +
    + + Both Later and Always are lazy computations, while Now is eager.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/HashMap.html b/javadoc/4.8.1/functionaljava/fj/data/HashMap.html new file mode 100644 index 0000000..1a0b147 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/HashMap.html @@ -0,0 +1,1116 @@ + + + + + +HashMap (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<K>
    +
    +
    +
    +
    public final class HashMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<K>
    +
    A mutable hash map providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashMap(Equal<K> e, + Hash<K> h) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity, + float loadFactor) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(java.util.Map<K,V> map) 
      HashMap(java.util.Map<K,V> map, + Equal<K> e, + Hash<K> h) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map,
+               Equal<K> e,
+               Hash<K> h)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<K> iterator()
        +
        Returns an iterator for this map's keys. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<K>
        +
        Returns:
        +
        A iterator for this map's keys.
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap()
        +
        Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        Returns:
        +
        A new hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap(Equal<K> e,
+                                         Hash<K> h)
        +
        Construct a hash map.
        +
        +
        Returns:
        +
        A new hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(K k1,
+                  K k2)
        +
        Compare two key values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        k1 - One key value to compare.
        +
        k2 - The other key value to compare.
        +
        Returns:
        +
        true if the two key values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(K k)
        +
        Compute the hash of the given key value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        k - The key value to computer the hash of.
        +
        Returns:
        +
        The hash of the given key value.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the hash map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all entries from this hash map.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this hash map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this hash map.
        +
        Returns:
        +
        true if this hash map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all key entries in this hash map.
        +
        +
        Returns:
        +
        All key entries in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this hash map.
        +
        +
        Returns:
        +
        All values in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash map has any entries.
        +
        +
        Returns:
        +
        true if this hash map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash map.
        +
        +
        Returns:
        +
        The number of entries in this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(K k,
+                V v)
        +
        Inserts the given key and value association into the hash map.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public void delete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        getDelete

        +
        public Option<V> getDelete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        Returns:
        +
        The value that was associated with the given key, if there was one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction,
+                              Equal<A> equal,
+                              Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction)
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<P2<K,V>,P2<A,B>> function)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> keyFunction,
+                                Equal<A> equal,
+                                Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> function)
        +
        • +
      + + + +
        +
      • +

        mapValues

        +
        public <B> HashMap<K,B> mapValues(F<V,B> function)
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<P2<K,V>> effect)
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public void foreach(F<P2<K,V>,Unit> function)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<P2<K,V>> toCollection()
        +
        Projects an immutable collection of this hash map.
        +
        +
        Returns:
        +
        An immutable collection of this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<P2<K,V>> toOption()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<P2<K,V>> toArray()
        +
        • +
      + + + +
        +
      • +

        toMap

        +
        public java.util.Map<K,V> toMap()
        +
        • +
      + + + +
        +
      • +

        from

        +
        @Deprecated
+public static <K,V> HashMap<K,V> from(java.lang.Iterable<P2<K,V>> entries)
        +
        Deprecated. As of release 4.5, use iterableHashMap(Iterable)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(Equal<K> eq,
+                                         Hash<K> h,
+                                         java.util.Map<K,V> map)
        +
        • +
      + + + + + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(Equal<K> equal,
+                                                           Hash<K> hash,
+                                                           P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/HashSet.html b/javadoc/4.8.1/functionaljava/fj/data/HashSet.html new file mode 100644 index 0000000..8dff5a8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/HashSet.html @@ -0,0 +1,805 @@ + + + + + +HashSet (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashSet<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashSet<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class HashSet<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashSet(Equal<A> e, + Hash<A> h) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity, + float loadFactor) +
      Construct a hash set with the given equality and hashing strategy.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> HashSet<A>arrayHashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>arrayHashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      voidclear() +
      Clear all elements from this hash set.
      +
      booleancontains(A a) +
      Determines if this hash set contains the given element.
      +
      booleandelete(A a) +
      Deletes the given element from this hash set.
      +
      static <A> HashSet<A>empty() +
      Creates an empty HashSet
      +
      static <A> HashSet<A>empty(Equal<A> e, + Hash<A> h) +
      Creates a new HashSet using the given Equal and Hash
      +
      booleaneq(A a1, + A a2) +
      Compare two values for equality using the underlying equality strategy.
      +
      static <A> HashSet<A>fromSet(java.util.Set<A> s) 
      inthash(A a) +
      Compute the hash of the given value using the underlying hashing strategy.
      +
      static <A> HashSet<A>hashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>hashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      booleanisEmpty() +
      Determines if this hash set contains any elements.
      +
      static <A> HashSet<A>iterableHashSet(Equal<A> e, + Hash<A> h, + java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      static <A> HashSet<A>iterableHashSet(java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this hash set.
      +
      static <A> HashSet<A>iteratorHashSet(Equal<A> e, + Hash<A> h, + java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      static <A> HashSet<A>iteratorHashSet(java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      voidset(A a) +
      Insert the given element into this hash set.
      +
      intsize() +
      Returns the number of entries in this hash set.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this hash set.
      +
      java.util.List<A>toJavaList() 
      java.util.Set<A>toJavaSet() 
      List<A>toList() +
      Returns a list projection of this hash set.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this hash set. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Compare two values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        a1 - One value to compare.
        +
        a2 - The other value to compare.
        +
        Returns:
        +
        true if the two values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        a - The value to computer the hash of.
        +
        Returns:
        +
        The hash of the given value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty(Equal<A> e,
+                                   Hash<A> h)
        +
        Creates a new HashSet using the given Equal and Hash
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty()
        +
        Creates an empty HashSet
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(Equal<A> e,
+                                                       Hash<A> h,
+                                                       A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(Equal<A> e,
+                                                  Hash<A> h,
+                                                  A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(A a)
        +
        Determines if this hash set contains the given element.
        +
        +
        Parameters:
        +
        a - The element to look for in this hash set.
        +
        Returns:
        +
        true if this hash set contains the given element, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(A a)
        +
        Insert the given element into this hash set.
        +
        +
        Parameters:
        +
        a - The element to insert.
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all elements from this hash set.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash set contains any elements.
        +
        +
        Returns:
        +
        true if this hash set contains no elements, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash set.
        +
        +
        Returns:
        +
        The number of entries in this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public boolean delete(A a)
        +
        Deletes the given element from this hash set.
        +
        +
        Parameters:
        +
        a - The element to delete from this hash set.
        +
        Returns:
        +
        true if this hash set contained the given element prior to deletion, false + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this hash set.
        +
        +
        Returns:
        +
        A list projection of this hash set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public java.util.Set<A> toJavaSet()
        +
        • +
      + + + +
        +
      • +

        fromSet

        +
        public static <A> HashSet<A> fromSet(java.util.Set<A> s)
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this hash set.
        +
        +
        Returns:
        +
        An immutable collection of this hash set.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/IO.html b/javadoc/4.8.1/functionaljava/fj/data/IO.html new file mode 100644 index 0000000..eb399e6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/IO.html @@ -0,0 +1,237 @@ + + + + + +IO (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface IO<A>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - the type of the result produced by the IO
    +
    +
    +
    All Known Subinterfaces:
    +
    SafeIO<A>
    +
    +
    +
    All Known Implementing Classes:
    +
    IOW
    +
    +
    +
    +
    public interface IO<A>
    +
    IO monad for processing files
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
+throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/IOFunctions.html b/javadoc/4.8.1/functionaljava/fj/data/IOFunctions.html new file mode 100644 index 0000000..7d57f84 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/IOFunctions.html @@ -0,0 +1,1011 @@ + + + + + +IOFunctions (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class IOFunctions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IOFunctions
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        closeReader

        +
        public static final F<java.io.Reader,IO<Unit>> closeReader
        +
        • +
      + + + +
        +
      • +

        ioUnit

        +
        public static final IO<Unit> ioUnit
        +
        • +
      + + + +
        +
      • +

        stdinBufferedReader

        +
        public static final java.io.BufferedReader stdinBufferedReader
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toTry

        +
        public static <A> Try0<A,java.io.IOException> toTry(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> P1<Validation<java.io.IOException,A>> p(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        fromF

        +
        public static <A> IO<A> fromF(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        fromTry

        +
        public static <A> IO<A> fromTry(Try0<A,? extends java.io.IOException> t)
        +
        • +
      + + + +
        +
      • +

        toSafe

        +
        public static <A> SafeIO<A> toSafe(IO<A> io)
        +
        Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        runSafe

        +
        public static <A> A runSafe(IO<A> io)
        +
        Run io, rethrowing any IOException wrapped in a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        closeReader

        +
        public static IO<Unit> closeReader(java.io.Reader r)
        +
        • +
      + + + + + + + +
        +
      • +

        enumFileCharChunks

        +
        public static <A> IO<Iteratee.IterV<char[],A>> enumFileCharChunks(java.io.File f,
+                                                                  Option<java.nio.charset.Charset> encoding,
+                                                                  Iteratee.IterV<char[],A> i)
        +
        An IO monad that reads char chunks from the given file and passes them to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with char chunks read from the file
        +
        +
        • +
      + + + +
        +
      • +

        enumFileChars

        +
        public static <A> IO<Iteratee.IterV<java.lang.Character,A>> enumFileChars(java.io.File f,
+                                                                          Option<java.nio.charset.Charset> encoding,
+                                                                          Iteratee.IterV<java.lang.Character,A> i)
        +
        An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with chars read from the file
        +
        +
        • +
      + + + +
        +
      • +

        bufferedReader

        +
        public static IO<java.io.BufferedReader> bufferedReader(java.io.File f,
+                                                        Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        fileReader

        +
        public static IO<java.io.Reader> fileReader(java.io.File f,
+                                            Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        bracket

        +
        public static <A,B,C> IO<C> bracket(IO<A> init,
+                                    F<A,IO<B>> fin,
+                                    F<A,IO<C>> body)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> IO<A> unit(A a)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F0<A> f)
        +
        • +
      + + + +
        +
      • +

        lineReader

        +
        public static <A> F<java.io.BufferedReader,F<Iteratee.IterV<java.lang.String,A>,IO<Iteratee.IterV<java.lang.String,A>>>> lineReader()
        +
        A function that feeds an iteratee with lines read from a BufferedReader.
        +
        • +
      + + + + + + + +
        +
      • +

        charChunkReader2

        +
        public static <A> F<java.io.Reader,F<Iteratee.IterV<java.lang.Character,A>,IO<Iteratee.IterV<java.lang.Character,A>>>> charChunkReader2()
        +
        A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size DEFAULT_BUFFER_SIZE).
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> IO<B> map(IO<A> io,
+                              F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        as

        +
        public static <A,B> IO<B> as(IO<A> io,
+                             B b)
        +
        • +
      + + + +
        +
      • +

        voided

        +
        public static <A> IO<Unit> voided(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> IO<B> bind(IO<A> io,
+                               F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        when

        +
        public static IO<Unit> when(java.lang.Boolean b,
+                            IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        unless

        +
        public static IO<Unit> unless(java.lang.Boolean b,
+                              IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<List<A>> sequence(List<IO<A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<Stream<A>> sequence(Stream<IO<A>> stream)
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> IO<A> join(IO<IO<A>> io1)
        +
        • +
      + + + +
        +
      • +

        toSafeValidation

        +
        public static <A> SafeIO<Validation<java.io.IOException,A>> toSafeValidation(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B> IO<B> append(IO<A> io1,
+                                 IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        left

        +
        public static <A,B> IO<A> left(IO<A> io1,
+                               IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> IO<B> flatMap(IO<A> io,
+                                  F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        interactWhile

        +
        public static IO<Unit> interactWhile(F<java.lang.String,java.lang.Boolean> condition,
+                                     F<java.lang.String,java.lang.String> transform)
        +
        Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
        +
        +
        Parameters:
        +
        condition - Read lines until a line does not satisfy condition
        +
        transform - Function to change line value
        +
        +
        • +
      + + + +
        +
      • +

        sequenceWhileEager

        +
        public static <A> IO<Stream<A>> sequenceWhileEager(Stream<IO<A>> stream,
+                                                   F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        sequenceWhile

        +
        public static <A> IO<Stream<A>> sequenceWhile(Stream<IO<A>> stream,
+                                              F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> IO<B> apply(IO<A> io,
+                                IO<F<A,B>> iof)
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> IO<C> liftM2(IO<A> ioa,
+                                   IO<B> iob,
+                                   F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        replicateM

        +
        public static <A> IO<List<A>> replicateM(IO<A> ioa,
+                                         int n)
        +
        • +
      + + + +
        +
      • +

        readerState

        +
        public static <A> IO<State<java.io.BufferedReader,Validation<java.io.IOException,java.lang.String>>> readerState()
        +
        • +
      + + + +
        +
      • +

        stdinReadLine

        +
        public static IO<java.lang.String> stdinReadLine()
        +
        • +
      + + + +
        +
      • +

        stdoutPrintln

        +
        public static IO<Unit> stdoutPrintln(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        stdoutPrint

        +
        public static IO<Unit> stdoutPrint(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public static IO<LazyString> getContents()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/IOW.html b/javadoc/4.8.1/functionaljava/fj/data/IOW.html new file mode 100644 index 0000000..1d2cc63 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/IOW.html @@ -0,0 +1,339 @@ + + + + + +IOW (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class IOW<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IOW<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IO<A>
    +
    +
    +
    +
    public final class IOW<A>
+extends java.lang.Object
+implements IO<A>
    +
    Created by MarkPerry on 9/06/2015.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lift

        +
        public static <A> IOW<A> lift(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        run

        +
        public A run()
+      throws java.io.IOException
        +
        +
        Specified by:
        +
        run in interface IO<A>
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        public <B> IOW<B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> IOW<B> bind(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        append

        +
        public <B> IOW<B> append(IO<B> iob)
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public static IOW<LazyString> getContents()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/IterableW.html b/javadoc/4.8.1/functionaljava/fj/data/IterableW.html new file mode 100644 index 0000000..081a7b5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/IterableW.html @@ -0,0 +1,851 @@ + + + + + +IterableW (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class IterableW<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IterableW<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class IterableW<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A wrapper for Iterable that equips it with some useful functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> IterableW<B>apply(java.lang.Iterable<F<A,B>> f) +
      Performs function application within an iterable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,IterableW<B>>>arrow() +
      Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
      +
      static <A,B,T extends java.lang.Iterable<B>>
      F<IterableW<A>,F<F<A,T>,IterableW<B>>>      		bind() +
      The first-class bind function over Iterable.
      +
      <B,T extends java.lang.Iterable<B>>
      IterableW<B>      		bind(F<A,T> f) +
      Binds the given function across the wrapped Iterable with a final join.
      +
      static <A,B,C> IterableW<C>bind(java.lang.Iterable<A> a, + java.lang.Iterable<B> b, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given iterables with a final join.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      The catamorphism for Iterables, implemented as a left fold.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) +
      The catamorphism for Iterables, implemented as a right fold.
      +
      static <A> IterableW<A>iterable(A a) +
      Returns an Iterable that completely preserves the argument.
      +
      static <A,B> F<A,IterableW<B>>iterable(F<A,B> f) +
      Wraps a given function's return value in a Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      F<java.lang.Iterable<T>,IterableW<A>>      		join() +
      Returns a function that joins an Iterable of Iterables into a single Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<A>      		join(java.lang.Iterable<T> as) +
      Joins an Iterable of Iterables into a single Iterable.
      +
      static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on iterables.
      +
      static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>>map() +
      Returns a function that promotes any function so that it operates on Iterables.
      +
      <B> IterableW<B>map(F<A,B> f) +
      Maps a given function across the wrapped Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<IterableW<A>>      		sequence(java.lang.Iterable<T> as) +
      Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
      +
      java.util.List<A>toStandardList() +
      Returns a java.util.List implementation for this iterable.
      +
      Option<Zipper<A>>toZipper() 
      static <A,T extends java.lang.Iterable<A>>
      F<T,IterableW<A>>      		wrap() +
      Provides a function that wraps the given iterable.
      +
      static <A> IterableW<A>wrap(java.lang.Iterable<A> a) +
      Wraps the given iterable.
      +
      <B> IterableW<B>zapp(java.lang.Iterable<F<A,B>> fs) +
      Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
      +
      <B> java.lang.Iterable<P2<A,B>>zip(java.lang.Iterable<B> bs) +
      Zips this iterable with the given iterable to produce a iterable of pairs.
      +
      java.lang.Iterable<P2<A,java.lang.Integer>>zipIndex() +
      Zips this iterable with the index of its element as a pair.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F2<A,B,C> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wrap

        +
        public static <A> IterableW<A> wrap(java.lang.Iterable<A> a)
        +
        Wraps the given iterable.
        +
        +
        Parameters:
        +
        a - The iterable to wrap.
        +
        Returns:
        +
        An iterable equipped with some useful functions.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A,T extends java.lang.Iterable<A>> F<T,IterableW<A>> wrap()
        +
        Provides a function that wraps the given iterable.
        +
        +
        Returns:
        +
        A function that returns the given iterable, wrapped.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterable

        +
        public static <A> IterableW<A> iterable(A a)
        +
        Returns an Iterable that completely preserves the argument. The unit function for Iterables.
        +
        +
        Parameters:
        +
        a - A value to preserve in an Iterable.
        +
        Returns:
        +
        An Iterable that yields the argument when iterated over.
        +
        +
        • +
      + + + +
        +
      • +

        iterable

        +
        public static <A,B> F<A,IterableW<B>> iterable(F<A,B> f)
        +
        Wraps a given function's return value in a Iterable. + The Kleisli arrow for Iterables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Iterable.
        +
        Returns:
        +
        The equivalent function whose return value is iterable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,IterableW<B>>> arrow()
        +
        Provides a transformation from a function to a Iterable-valued function that is equivalent to it. + The first-class Kleisli arrow for Iterables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Iterable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,T extends java.lang.Iterable<B>> IterableW<B> bind(F<A,T> f)
        +
        Binds the given function across the wrapped Iterable with a final join.
        +
        +
        Parameters:
        +
        f - A function to bind across the Iterable.
        +
        Returns:
        +
        an iterable result of binding the given function over the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> IterableW<B> apply(java.lang.Iterable<F<A,B>> f)
        +
        Performs function application within an iterable (applicative functor pattern).
        +
        +
        Parameters:
        +
        f - The iterable function to apply.
        +
        Returns:
        +
        A new iterable after applying the given iterable function to the wrapped iterable.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> IterableW<C> bind(java.lang.Iterable<A> a,
+                                        java.lang.Iterable<B> b,
+                                        F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given iterables with a final join.
        +
        +
        Parameters:
        +
        a - A given iterable to bind the given function with.
        +
        b - A given iterable to bind the given function with.
        +
        f - The function to apply to the values in the given iterables.
        +
        Returns:
        +
        A new iterable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on iterables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over iterables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<IterableW<A>> sequence(java.lang.Iterable<T> as)
        +
        Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable. + This implementation is strict and requires O(n) stack space.
        +
        +
        Parameters:
        +
        as - The iterable of iterables to transform.
        +
        Returns:
        +
        A iterable of iterables containing the results of the bind operations across all given iterables.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,T extends java.lang.Iterable<B>> F<IterableW<A>,F<F<A,T>,IterableW<B>>> bind()
        +
        The first-class bind function over Iterable. + Returns a function that binds a given function across a given iterable.
        +
        +
        Returns:
        +
        a function that binds a given function across a given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<A> join(java.lang.Iterable<T> as)
        +
        Joins an Iterable of Iterables into a single Iterable.
        +
        +
        Parameters:
        +
        as - An Iterable of Iterables to join.
        +
        Returns:
        +
        the joined Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> F<java.lang.Iterable<T>,IterableW<A>> join()
        +
        Returns a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        Returns:
        +
        a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> IterableW<B> map(F<A,B> f)
        +
        Maps a given function across the wrapped Iterable.
        +
        +
        Parameters:
        +
        f - A function to map across the wrapped Iterable.
        +
        Returns:
        +
        An Iterable of the results of mapping the given function across the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>> map()
        +
        Returns a function that promotes any function so that it operates on Iterables.
        +
        +
        Returns:
        +
        a function that promotes any function so that it operates on Iterables.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B z)
        +
        The catamorphism for Iterables, implemented as a left fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied first (leftmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        The catamorphism for Iterables, implemented as a right fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied last (rightmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this iterable.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public <B> IterableW<B> zapp(java.lang.Iterable<F<A,B>> fs)
        +
        Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable. The iteration is normalised + so that it ends when one of the iterators is exhausted.
        +
        +
        Parameters:
        +
        fs - The iterable of functions to apply to this iterable.
        +
        Returns:
        +
        A new iterable with the results of applying the functions to this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F2<A,B,C> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> java.lang.Iterable<P2<A,B>> zip(java.lang.Iterable<B> bs)
        +
        Zips this iterable with the given iterable to produce a iterable of pairs. If this iterable and the + given iterable have different lengths, then the longer iterable is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public java.lang.Iterable<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this iterable with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new iterable with the same length as this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        toStandardList

        +
        public java.util.List<A> toStandardList()
        +
        Returns a java.util.List implementation for this iterable. + The returned list cannot be modified.
        +
        +
        Returns:
        +
        An immutable implementation of java.util.List for this iterable.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Iteratee.Input.html b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.Input.html new file mode 100644 index 0000000..edd6047 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.Input.html @@ -0,0 +1,294 @@ + + + + + +Iteratee.Input (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.Input<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.Input<E>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.Input<E>
+extends java.lang.Object
    +
    The input to an iteratee.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public abstract <Z> Z apply(F0<Z> empty,
+                            F0<F<E,Z>> el,
+                            F0<Z> eof)
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <E> Iteratee.Input<E> empty()
        +
        Input that has no values available
        +
        • +
      + + + +
        +
      • +

        eof

        +
        public static <E> Iteratee.Input<E> eof()
        +
        Input that is exhausted
        +
        • +
      + + + + + +
        +
      • +

        el

        +
        public static <E> Iteratee.Input<E> el(E element)
        +
        Input that has a value available
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Iteratee.IterV.html b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.IterV.html new file mode 100644 index 0000000..e458202 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.IterV.html @@ -0,0 +1,389 @@ + + + + + +Iteratee.IterV (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.IterV<E,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.IterV<E,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.IterV<E,A>
+extends java.lang.Object
    +
    A pure iteratee computation which is either done or needs more input
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Iteratee.html b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.html new file mode 100644 index 0000000..d175e54 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Iteratee.html @@ -0,0 +1,222 @@ + + + + + +Iteratee (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Iteratee
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Iteratee.Input<E> +
      The input to an iteratee.
      +
      static class Iteratee.IterV<E,A> +
      A pure iteratee computation which is either done or needs more input
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Java.html b/javadoc/4.8.1/functionaljava/fj/data/Java.html new file mode 100644 index 0000000..40356f2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Java.html @@ -0,0 +1,3648 @@ + + + + + +Java (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Java

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java
+extends java.lang.Object
    +
    Functions that convert between types from the core Java API.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<Array<java.lang.Boolean>,java.util.BitSet>Array_BitSet +
      A function that converts arrays to bit sets.
      +
      static F<java.util.BitSet,List<java.lang.Boolean>>BitSet_List +
      A function that converts bit sets to lists.
      +
      static F<List<java.lang.Boolean>,java.util.BitSet>List_BitSet +
      A function that converts lists to bit sets.
      +
      static F<Option<java.lang.Boolean>,java.util.BitSet>Option_BitSet +
      A function that converts options to bit sets.
      +
      static F<Stream<java.lang.Boolean>,java.util.BitSet>Stream_BitSet +
      A function that converts streams to bit sets.
      +
      static F<java.lang.String,java.util.ArrayList<java.lang.Character>>String_ArrayList +
      A function that converts strings to array lists.
      +
      static F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>String_ConcurrentLinkedQueue +
      A function that converts strings to concurrent linked queues.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>String_CopyOnWriteArrayList +
      A function that converts strings to copy on write array lists.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>String_CopyOnWriteArraySet +
      A function that converts strings to copy on write array sets.
      +
      static F<java.lang.String,java.util.HashSet<java.lang.Character>>String_HashSet +
      A function that converts strings to hash sets.
      +
      static F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>String_LinkedBlockingQueue +
      A function that converts strings to linked blocking queues.
      +
      static F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>>String_LinkedHashSet +
      A function that converts strings to linked hash sets.
      +
      static F<java.lang.String,java.util.LinkedList<java.lang.Character>>String_LinkedList +
      A function that converts strings to linked lists.
      +
      static F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>String_PriorityBlockingQueue +
      A function that converts strings to priority blocking queues.
      +
      static F<java.lang.String,java.util.PriorityQueue<java.lang.Character>>String_PriorityQueue +
      A function that converts strings to priority queues.
      +
      static F<java.lang.String,java.util.Stack<java.lang.Character>>String_Stack +
      A function that converts strings to stacks.
      +
      static F<java.lang.String,java.util.TreeSet<java.lang.Character>>String_TreeSet +
      A function that converts strings to tree sets.
      +
      static F<java.lang.String,java.util.Vector<java.lang.Character>>String_Vector +
      A function that converts strings to vectors.
      +
      static F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>>StringBuffer_ArrayList +
      A function that converts string buffers to array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuffer_ConcurrentLinkedQueue +
      A function that converts string buffers to concurrent linked queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuffer_CopyOnWriteArrayList +
      A function that converts string buffers to copy on write array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuffer_CopyOnWriteArraySet +
      A function that converts string buffers to copy on write array sets.
      +
      static F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>>StringBuffer_HashSet +
      A function that converts string buffers to hash sets.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuffer_LinkedBlockingQueue +
      A function that converts string buffers to linked blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>>StringBuffer_LinkedHashSet +
      A function that converts string buffers to linked hash sets.
      +
      static F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>>StringBuffer_LinkedList +
      A function that converts string buffers to linked lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuffer_PriorityBlockingQueue +
      A function that converts string buffers to priority blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>>StringBuffer_PriorityQueue +
      A function that converts string buffers to priority queues.
      +
      static F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>>StringBuffer_Stack +
      A function that converts string buffers to stacks.
      +
      static F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>>StringBuffer_TreeSet +
      A function that converts string buffers to tree sets.
      +
      static F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>>StringBuffer_Vector +
      A function that converts string buffers to vectors.
      +
      static F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>>StringBuilder_ArrayList +
      A function that converts string builders to array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuilder_ConcurrentLinkedQueue +
      A function that converts string builders to concurrent linked queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuilder_CopyOnWriteArrayList +
      A function that converts string builders to copy on write array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuilder_CopyOnWriteArraySet +
      A function that converts string builders to copy on write array sets.
      +
      static F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>>StringBuilder_HashSet +
      A function that converts string builders to hash sets.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuilder_LinkedBlockingQueue +
      A function that converts string builders to linked blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>>StringBuilder_LinkedHashSet +
      A function that converts string builders to linked hash sets.
      +
      static F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>>StringBuilder_LinkedList +
      A function that converts string builders to linked lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuilder_PriorityBlockingQueue +
      A function that converts string builders to priority blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>>StringBuilder_PriorityQueue +
      A function that converts string builders to priority queues.
      +
      static F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>>StringBuilder_Stack +
      A function that converts string builders to stacks.
      +
      static F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>>StringBuilder_TreeSet +
      A function that converts string builders to tree sets.
      +
      static F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>>StringBuilder_Vector +
      A function that converts string builders to vectors.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>>Array_ArrayBlockingQueue(boolean fair) +
      A function that converts arrays to array blocking queues.
      +
      static <A> F<Array<A>,java.util.ArrayList<A>>Array_ArrayList() +
      A function that converts arrays to array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Array_ConcurrentLinkedQueue() +
      A function that converts arrays to concurrent linked queues.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Array_CopyOnWriteArrayList() +
      A function that converts arrays to copy on write array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Array_CopyOnWriteArraySet() +
      A function that converts arrays to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Array<A>,java.util.concurrent.DelayQueue<A>>      		Array_DelayQueue() +
      A function that converts arrays to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Array<A>,java.util.EnumSet<A>>      		Array_EnumSet() +
      A function that converts arrays to enum sets.
      +
      static <A> F<Array<A>,java.util.HashSet<A>>Array_HashSet() +
      A function that converts arrays to hash sets.
      +
      static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>>Array_LinkedBlockingQueue() +
      A function that converts arrays to linked blocking queues.
      +
      static <A> F<Array<A>,java.util.LinkedHashSet<A>>Array_LinkedHashSet() +
      A function that converts arrays to linked hash sets.
      +
      static <A> F<Array<A>,java.util.LinkedList<A>>Array_LinkedList() +
      A function that converts arrays to linked lists.
      +
      static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>>Array_PriorityBlockingQueue() +
      A function that converts arrays to priority blocking queues.
      +
      static <A> F<Array<A>,java.util.PriorityQueue<A>>Array_PriorityQueue() +
      A function that converts arrays to priority queues.
      +
      static <A> F<Array<A>,java.util.Stack<A>>Array_Stack() +
      A function that converts arrays to stacks.
      +
      static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>>Array_SynchronousQueue(boolean fair) +
      A function that converts arrays to synchronous queues.
      +
      static <A> F<Array<A>,java.util.TreeSet<A>>Array_TreeSet() +
      A function that converts arrays to tree sets.
      +
      static <A> F<Array<A>,java.util.Vector<A>>Array_Vector() +
      A function that converts arrays to vectors.
      +
      static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>>ArrayBlockingQueue_List() +
      A function that converts array blocking queues to lists.
      +
      static <A> F<java.util.ArrayList<A>,List<A>>ArrayList_List() +
      A function that converts array lists to lists.
      +
      static <A> F<java.util.Collection<A>,List<A>>Collection_List() 
      static <A> List<A>Collection_List(java.util.Collection<A> c) 
      static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>>ConcurrentLinkedQueue_List() +
      A function that converts concurrent linked queues to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>>CopyOnWriteArrayList_List() +
      A function that converts copy on write array lists to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>>CopyOnWriteArraySet_List() +
      A function that converts copy on write array sets to lists.
      +
      static <A extends java.util.concurrent.Delayed>
      F<java.util.concurrent.DelayQueue<A>,List<A>>      		DelayQueue_List() +
      A function that converts delay queues to lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>>Either_ArrayBlockingQueueA(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>>Either_ArrayBlockingQueueB(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<A>>Either_ArrayListA() +
      A function that converts eithers to array lists.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<B>>Either_ArrayListB() +
      A function that converts eithers to array lists.
      +
      static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet>Either_BitSetA() +
      A function that converts eithers to bit sets.
      +
      static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet>Either_BitSetB() +
      A function that converts eithers to bit sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>>Either_ConcurrentLinkedQueueA() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>>Either_ConcurrentLinkedQueueB() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>>Either_CopyOnWriteArrayListA() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>>Either_CopyOnWriteArrayListB() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>>Either_CopyOnWriteArraySetA() +
      A function that converts eithers to copy on write array sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>>Either_CopyOnWriteArraySetB() +
      A function that converts eithers to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed,B>
      F<Either<A,B>,java.util.concurrent.DelayQueue<A>>      		Either_DelayQueueA() +
      A function that converts eithers to delay queues.
      +
      static <A,B extends java.util.concurrent.Delayed>
      F<Either<A,B>,java.util.concurrent.DelayQueue<B>>      		Either_DelayQueueB() +
      A function that converts eithers to delay queues.
      +
      static <A extends java.lang.Enum<A>,B>
      F<Either<A,B>,java.util.EnumSet<A>>      		Either_EnumSetA() +
      A function that converts eithers to enum sets.
      +
      static <A,B extends java.lang.Enum<B>>
      F<Either<A,B>,java.util.EnumSet<B>>      		Either_EnumSetB() +
      A function that converts eithers to enum sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<A>>Either_HashSetA() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<B>>Either_HashSetB() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>>Either_LinkedBlockingQueueA() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>>Either_LinkedBlockingQueueB() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>>Either_LinkedHashSetA() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>>Either_LinkedHashSetB() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<A>>Either_LinkedListA() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<B>>Either_LinkedListB() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>>Either_PriorityBlockingQueueA() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>>Either_PriorityBlockingQueueB() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<A>>Either_StackA() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<B>>Either_StackB() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>>Either_SynchronousQueueA(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>>Either_SynchronousQueueB(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<A>>Either_TreeSetA() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<B>>Either_TreeSetB() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<A>>Either_VectorA() +
      A function that converts eithers to vectors.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<B>>Either_VectorB() +
      A function that converts eithers to vectors.
      +
      static <A extends java.lang.Enum<A>>
      F<java.util.EnumSet<A>,List<A>>      		EnumSet_List() +
      A function that converts enum sets to lists.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>>Future_P1() 
      static <A> F<java.util.HashSet<A>,List<A>>HashSet_List() +
      A function that converts hash sets to lists.
      +
      static <A> F<java.util.List<A>,List<A>>JavaList_List() 
      static <A> List<A>JavaList_List(java.util.List<A> list) 
      static <A> F<java.util.List<A>,List<A>>JUList_List() +
      Deprecated.  +
      As of 4.3, use JavaList_List()
      +
      +
      static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>>LinkedBlockingQueue_List() +
      A function that converts linked blocking queues to lists.
      +
      static <A> F<java.util.LinkedHashSet<A>,List<A>>LinkedHashSet_List() +
      A function that converts linked hash sets to lists.
      +
      static <A> F<java.util.LinkedList<A>,List<A>>LinkedList_List() +
      A function that converts linked lists to lists.
      +
      static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>>List_ArrayBlockingQueue(boolean fair) +
      A function that converts lists to array blocking queue.
      +
      static <A> F<List<A>,java.util.ArrayList<A>>List_ArrayList() +
      A function that converts lists to array lists.
      +
      static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>List_ConcurrentLinkedQueue() +
      A function that converts lists to concurrent linked queues.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>>List_CopyOnWriteArrayList() +
      A function that converts lists to copy on write array lists.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>>List_CopyOnWriteArraySet() +
      A function that converts lists to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<List<A>,java.util.concurrent.DelayQueue<A>>      		List_DelayQueue() +
      A function that converts lists to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<List<A>,java.util.EnumSet<A>>      		List_EnumSet() +
      A function that converts lists to array enum sets.
      +
      static <A> F<List<A>,java.util.HashSet<A>>List_HashSet() +
      A function that converts lists to hash sets.
      +
      static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>>List_LinkedBlockingQueue() +
      A function that converts lists to linked blocking queues.
      +
      static <A> F<List<A>,java.util.LinkedHashSet<A>>List_LinkedHashSet() +
      A function that converts lists to linked hash sets.
      +
      static <A> F<List<A>,java.util.LinkedList<A>>List_LinkedList() +
      A function that converts lists to linked lists.
      +
      static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>>List_PriorityBlockingQueue() +
      A function that converts lists to priority blocking queues.
      +
      static <A> F<List<A>,java.util.PriorityQueue<A>>List_PriorityQueue() +
      A function that converts lists to priority queues.
      +
      static <A> F<List<A>,java.util.Stack<A>>List_Stack() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>>List_SynchronousQueue(boolean fair) +
      A function that converts lists to synchronous queues.
      +
      static <A> F<List<A>,java.util.TreeSet<A>>List_TreeSet() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.Vector<A>>List_Vector() +
      A function that converts lists to vectors.
      +
      static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>>Option_ArrayBlockingQueue(boolean fair) +
      A function that converts options to array blocking queues.
      +
      static <A> F<Option<A>,java.util.ArrayList<A>>Option_ArrayList() +
      A function that converts options to array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Option_ConcurrentLinkedQueue() +
      A function that converts options to concurrent linked queues.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Option_CopyOnWriteArrayList() +
      A function that converts options to copy on write array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Option_CopyOnWriteArraySet() +
      A function that converts options to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Option<A>,java.util.concurrent.DelayQueue<A>>      		Option_DelayQueue() +
      A function that converts options to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Option<A>,java.util.EnumSet<A>>      		Option_EnumSet() +
      A function that converts options to enum sets.
      +
      static <A> F<Option<A>,java.util.HashSet<A>>Option_HashSet() +
      A function that converts options to hash sets.
      +
      static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>>Option_LinkedBlockingQueue() +
      A function that converts options to linked blocking queues.
      +
      static <A> F<Option<A>,java.util.LinkedHashSet<A>>Option_LinkedHashSet() +
      A function that converts options to linked hash sets.
      +
      static <A> F<Option<A>,java.util.LinkedList<A>>Option_LinkedList() +
      A function that converts options to linked lists.
      +
      static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>>Option_PriorityBlockingQueue() +
      A function that converts options to priority blocking queues.
      +
      static <A> F<Option<A>,java.util.PriorityQueue<A>>Option_PriorityQueue() +
      A function that converts options to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>>Option_PriorityQueueA() +
      A function that converts eithers to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>>Option_PriorityQueueB() +
      A function that converts eithers to priority queues.
      +
      static <A> F<Option<A>,java.util.Stack<A>>Option_Stack() +
      A function that converts options to stacks.
      +
      static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>>Option_SynchronousQueue(boolean fair) +
      A function that converts options to synchronous queues.
      +
      static <A> F<Option<A>,java.util.TreeSet<A>>Option_TreeSet() +
      A function that converts options to tree sets.
      +
      static <A> F<Option<A>,java.util.Vector<A>>Option_Vector() +
      A function that converts options to vectors.
      +
      static <A> F<P1<A>,java.util.concurrent.Callable<A>>P1_Callable() 
      static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>>PriorityBlockingQueue_List() +
      A function that converts priority blocking queues to lists.
      +
      static <A> F<java.util.PriorityQueue<A>,List<A>>PriorityQueue_List() +
      A function that converts priority queues to lists.
      +
      static <A> F<java.util.Stack<A>,List<A>>Stack_List() +
      A function that converts stacks to lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>>Stream_ArrayBlockingQueue(boolean fair) +
      A function that converts streams to array blocking queues.
      +
      static <A> F<Stream<A>,java.util.ArrayList<A>>Stream_ArrayList() +
      A function that converts streams to array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Stream_ConcurrentLinkedQueue() +
      A function that converts streams to concurrent linked queues.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Stream_CopyOnWriteArrayList() +
      A function that converts streams to copy on write array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Stream_CopyOnWriteArraySet() +
      A function that converts streams to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Stream<A>,java.util.concurrent.DelayQueue<A>>      		Stream_DelayQueue() +
      A function that converts streams to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Stream<A>,java.util.EnumSet<A>>      		Stream_EnumSet() +
      A function that converts streams to enum sets.
      +
      static <A> F<Stream<A>,java.util.HashSet<A>>Stream_HashSet() +
      A function that converts streams to hash sets.
      +
      static <A> F<Stream<A>,java.lang.Iterable<A>>Stream_Iterable() +
      A function that converts streams to iterable.
      +
      static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>>Stream_LinkedBlockingQueue() +
      A function that converts streams to linked blocking queues.
      +
      static <A> F<Stream<A>,java.util.LinkedHashSet<A>>Stream_LinkedHashSet() +
      A function that converts streams to linked hash sets.
      +
      static <A> F<Stream<A>,java.util.LinkedList<A>>Stream_LinkedList() +
      A function that converts streams to linked lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>>Stream_PriorityBlockingQueue() +
      A function that converts streams to priority blocking queues.
      +
      static <A> F<Stream<A>,java.util.PriorityQueue<A>>Stream_PriorityQueue() +
      A function that converts streams to priority queues.
      +
      static <A> F<Stream<A>,java.util.Stack<A>>Stream_Stack() +
      A function that converts streams to stacks.
      +
      static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>>Stream_SynchronousQueue(boolean fair) +
      A function that converts streams to synchronous queues.
      +
      static <A> F<Stream<A>,java.util.TreeSet<A>>Stream_TreeSet() +
      A function that converts streams to tree sets.
      +
      static <A> F<Stream<A>,java.util.Vector<A>>Stream_Vector() +
      A function that converts streams to vectors.
      +
      static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>String_ArrayBlockingQueue(boolean fair) +
      A function that converts strings to array blocking queues.
      +
      static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>>String_SynchronousQueue(boolean fair) +
      A function that converts strings to synchronous queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuffer_ArrayBlockingQueue(boolean fair) +
      A function that converts string buffers to array blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuffer_SynchronousQueue(boolean fair) +
      A function that converts string buffers to synchronous queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuilder_ArrayBlockingQueue(boolean fair) +
      A function that converts string builders to array blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuilder_SynchronousQueue(boolean fair) +
      A function that converts string builders to synchronous queues.
      +
      static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>>SynchronousQueue_List() +
      A function that converts synchronous queues to lists.
      +
      static <A> F<java.util.TreeSet<A>,List<A>>TreeSet_List() +
      A function that converts tree sets to lists.
      +
      static <A> F<java.util.Vector<A>,List<A>>Vector_List() +
      A function that converts vectors to lists.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        List_BitSet

        +
        public static final F<List<java.lang.Boolean>,java.util.BitSet> List_BitSet
        +
        A function that converts lists to bit sets.
        +
        • +
      + + + +
        +
      • +

        Array_BitSet

        +
        public static final F<Array<java.lang.Boolean>,java.util.BitSet> Array_BitSet
        +
        A function that converts arrays to bit sets.
        +
        • +
      + + + +
        +
      • +

        Stream_BitSet

        +
        public static final F<Stream<java.lang.Boolean>,java.util.BitSet> Stream_BitSet
        +
        A function that converts streams to bit sets.
        +
        • +
      + + + +
        +
      • +

        Option_BitSet

        +
        public static final F<Option<java.lang.Boolean>,java.util.BitSet> Option_BitSet
        +
        A function that converts options to bit sets.
        +
        • +
      + + + +
        +
      • +

        String_ArrayList

        +
        public static final F<java.lang.String,java.util.ArrayList<java.lang.Character>> String_ArrayList
        +
        A function that converts strings to array lists.
        +
        • +
      + + + +
        +
      • +

        String_HashSet

        +
        public static final F<java.lang.String,java.util.HashSet<java.lang.Character>> String_HashSet
        +
        A function that converts strings to hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedHashSet

        +
        public static final F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>> String_LinkedHashSet
        +
        A function that converts strings to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedList

        +
        public static final F<java.lang.String,java.util.LinkedList<java.lang.Character>> String_LinkedList
        +
        A function that converts strings to linked lists.
        +
        • +
      + + + +
        +
      • +

        String_PriorityQueue

        +
        public static final F<java.lang.String,java.util.PriorityQueue<java.lang.Character>> String_PriorityQueue
        +
        A function that converts strings to priority queues.
        +
        • +
      + + + +
        +
      • +

        String_Stack

        +
        public static final F<java.lang.String,java.util.Stack<java.lang.Character>> String_Stack
        +
        A function that converts strings to stacks.
        +
        • +
      + + + +
        +
      • +

        String_TreeSet

        +
        public static final F<java.lang.String,java.util.TreeSet<java.lang.Character>> String_TreeSet
        +
        A function that converts strings to tree sets.
        +
        • +
      + + + +
        +
      • +

        String_Vector

        +
        public static final F<java.lang.String,java.util.Vector<java.lang.Character>> String_Vector
        +
        A function that converts strings to vectors.
        +
        • +
      + + + +
        +
      • +

        String_ConcurrentLinkedQueue

        +
        public static final F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> String_ConcurrentLinkedQueue
        +
        A function that converts strings to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArrayList

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> String_CopyOnWriteArrayList
        +
        A function that converts strings to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArraySet

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> String_CopyOnWriteArraySet
        +
        A function that converts strings to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> String_LinkedBlockingQueue
        +
        A function that converts strings to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        String_PriorityBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> String_PriorityBlockingQueue
        +
        A function that converts strings to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>> StringBuffer_ArrayList
        +
        A function that converts string buffers to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_HashSet

        +
        public static final F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>> StringBuffer_HashSet
        +
        A function that converts string buffers to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedHashSet

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>> StringBuffer_LinkedHashSet
        +
        A function that converts string buffers to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedList

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>> StringBuffer_LinkedList
        +
        A function that converts string buffers to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityQueue

        +
        public static final F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>> StringBuffer_PriorityQueue
        +
        A function that converts string buffers to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stack

        +
        public static final F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>> StringBuffer_Stack
        +
        A function that converts string buffers to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_TreeSet

        +
        public static final F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>> StringBuffer_TreeSet
        +
        A function that converts string buffers to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Vector

        +
        public static final F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>> StringBuffer_Vector
        +
        A function that converts string buffers to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuffer_ConcurrentLinkedQueue
        +
        A function that converts string buffers to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuffer_CopyOnWriteArrayList
        +
        A function that converts string buffers to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuffer_CopyOnWriteArraySet
        +
        A function that converts string buffers to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuffer_LinkedBlockingQueue
        +
        A function that converts string buffers to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuffer_PriorityBlockingQueue
        +
        A function that converts string buffers to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>> StringBuilder_ArrayList
        +
        A function that converts string builders to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_HashSet

        +
        public static final F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>> StringBuilder_HashSet
        +
        A function that converts string builders to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedHashSet

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>> StringBuilder_LinkedHashSet
        +
        A function that converts string builders to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedList

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>> StringBuilder_LinkedList
        +
        A function that converts string builders to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityQueue

        +
        public static final F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>> StringBuilder_PriorityQueue
        +
        A function that converts string builders to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stack

        +
        public static final F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>> StringBuilder_Stack
        +
        A function that converts string builders to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_TreeSet

        +
        public static final F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>> StringBuilder_TreeSet
        +
        A function that converts string builders to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Vector

        +
        public static final F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>> StringBuilder_Vector
        +
        A function that converts string builders to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuilder_ConcurrentLinkedQueue
        +
        A function that converts string builders to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuilder_CopyOnWriteArrayList
        +
        A function that converts string builders to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuilder_CopyOnWriteArraySet
        +
        A function that converts string builders to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuilder_LinkedBlockingQueue
        +
        A function that converts string builders to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuilder_PriorityBlockingQueue
        +
        A function that converts string builders to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        BitSet_List

        +
        public static final F<java.util.BitSet,List<java.lang.Boolean>> BitSet_List
        +
        A function that converts bit sets to lists.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_ArrayList

        +
        public static <A> F<List<A>,java.util.ArrayList<A>> List_ArrayList()
        +
        A function that converts lists to array lists.
        +
        +
        Returns:
        +
        A function that converts lists to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<List<A>,java.util.EnumSet<A>> List_EnumSet()
        +
        A function that converts lists to array enum sets.
        +
        +
        Returns:
        +
        A function that converts lists to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_HashSet

        +
        public static <A> F<List<A>,java.util.HashSet<A>> List_HashSet()
        +
        A function that converts lists to hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedHashSet

        +
        public static <A> F<List<A>,java.util.LinkedHashSet<A>> List_LinkedHashSet()
        +
        A function that converts lists to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedList

        +
        public static <A> F<List<A>,java.util.LinkedList<A>> List_LinkedList()
        +
        A function that converts lists to linked lists.
        +
        +
        Returns:
        +
        A function that converts lists to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityQueue

        +
        public static <A> F<List<A>,java.util.PriorityQueue<A>> List_PriorityQueue()
        +
        A function that converts lists to priority queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stack

        +
        public static <A> F<List<A>,java.util.Stack<A>> List_Stack()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_TreeSet

        +
        public static <A> F<List<A>,java.util.TreeSet<A>> List_TreeSet()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_Vector

        +
        public static <A> F<List<A>,java.util.Vector<A>> List_Vector()
        +
        A function that converts lists to vectors.
        +
        +
        Returns:
        +
        A function that converts lists to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        List_ArrayBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>> List_ArrayBlockingQueue(boolean fair)
        +
        A function that converts lists to array blocking queue.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts lists to array blocking queue.
        +
        +
        • +
      + + + +
        +
      • +

        List_ConcurrentLinkedQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> List_ConcurrentLinkedQueue()
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArrayList

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>> List_CopyOnWriteArrayList()
        +
        A function that converts lists to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArraySet

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>> List_CopyOnWriteArraySet()
        +
        A function that converts lists to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<List<A>,java.util.concurrent.DelayQueue<A>> List_DelayQueue()
        +
        A function that converts lists to delay queues.
        +
        +
        Returns:
        +
        A function that converts lists to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>> List_LinkedBlockingQueue()
        +
        A function that converts lists to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>> List_PriorityBlockingQueue()
        +
        A function that converts lists to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_SynchronousQueue

        +
        public static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>> List_SynchronousQueue(boolean fair)
        +
        A function that converts lists to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts lists to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayList

        +
        public static <A> F<Array<A>,java.util.ArrayList<A>> Array_ArrayList()
        +
        A function that converts arrays to array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Array<A>,java.util.EnumSet<A>> Array_EnumSet()
        +
        A function that converts arrays to enum sets.
        +
        +
        Returns:
        +
        A function that converts arrays to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_HashSet

        +
        public static <A> F<Array<A>,java.util.HashSet<A>> Array_HashSet()
        +
        A function that converts arrays to hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedHashSet

        +
        public static <A> F<Array<A>,java.util.LinkedHashSet<A>> Array_LinkedHashSet()
        +
        A function that converts arrays to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedList

        +
        public static <A> F<Array<A>,java.util.LinkedList<A>> Array_LinkedList()
        +
        A function that converts arrays to linked lists.
        +
        +
        Returns:
        +
        A function that converts arrays to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityQueue

        +
        public static <A> F<Array<A>,java.util.PriorityQueue<A>> Array_PriorityQueue()
        +
        A function that converts arrays to priority queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stack

        +
        public static <A> F<Array<A>,java.util.Stack<A>> Array_Stack()
        +
        A function that converts arrays to stacks.
        +
        +
        Returns:
        +
        A function that converts arrays to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Array_TreeSet

        +
        public static <A> F<Array<A>,java.util.TreeSet<A>> Array_TreeSet()
        +
        A function that converts arrays to tree sets.
        +
        +
        Returns:
        +
        A function that converts arrays to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Vector

        +
        public static <A> F<Array<A>,java.util.Vector<A>> Array_Vector()
        +
        A function that converts arrays to vectors.
        +
        +
        Returns:
        +
        A function that converts arrays to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>> Array_ArrayBlockingQueue(boolean fair)
        +
        A function that converts arrays to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts arrays to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ConcurrentLinkedQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Array_ConcurrentLinkedQueue()
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArrayList

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Array_CopyOnWriteArrayList()
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArraySet

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Array_CopyOnWriteArraySet()
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Array<A>,java.util.concurrent.DelayQueue<A>> Array_DelayQueue()
        +
        A function that converts arrays to delay queues.
        +
        +
        Returns:
        +
        A function that converts arrays to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>> Array_LinkedBlockingQueue()
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>> Array_PriorityBlockingQueue()
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_SynchronousQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>> Array_SynchronousQueue(boolean fair)
        +
        A function that converts arrays to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts arrays to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Iterable

        +
        public static <A> F<Stream<A>,java.lang.Iterable<A>> Stream_Iterable()
        +
        A function that converts streams to iterable.
        +
        +
        Returns:
        +
        A function that converts streams to iterable.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayList

        +
        public static <A> F<Stream<A>,java.util.ArrayList<A>> Stream_ArrayList()
        +
        A function that converts streams to array lists.
        +
        +
        Returns:
        +
        A function that converts streams to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Stream<A>,java.util.EnumSet<A>> Stream_EnumSet()
        +
        A function that converts streams to enum sets.
        +
        +
        Returns:
        +
        A function that converts streams to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_HashSet

        +
        public static <A> F<Stream<A>,java.util.HashSet<A>> Stream_HashSet()
        +
        A function that converts streams to hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedHashSet

        +
        public static <A> F<Stream<A>,java.util.LinkedHashSet<A>> Stream_LinkedHashSet()
        +
        A function that converts streams to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedList

        +
        public static <A> F<Stream<A>,java.util.LinkedList<A>> Stream_LinkedList()
        +
        A function that converts streams to linked lists.
        +
        +
        Returns:
        +
        A function that converts streams to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityQueue

        +
        public static <A> F<Stream<A>,java.util.PriorityQueue<A>> Stream_PriorityQueue()
        +
        A function that converts streams to priority queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Stack

        +
        public static <A> F<Stream<A>,java.util.Stack<A>> Stream_Stack()
        +
        A function that converts streams to stacks.
        +
        +
        Returns:
        +
        A function that converts streams to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_TreeSet

        +
        public static <A> F<Stream<A>,java.util.TreeSet<A>> Stream_TreeSet()
        +
        A function that converts streams to tree sets.
        +
        +
        Returns:
        +
        A function that converts streams to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Vector

        +
        public static <A> F<Stream<A>,java.util.Vector<A>> Stream_Vector()
        +
        A function that converts streams to vectors.
        +
        +
        Returns:
        +
        A function that converts streams to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>> Stream_ArrayBlockingQueue(boolean fair)
        +
        A function that converts streams to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts streams to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ConcurrentLinkedQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Stream_ConcurrentLinkedQueue()
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArrayList

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Stream_CopyOnWriteArrayList()
        +
        A function that converts streams to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArraySet

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Stream_CopyOnWriteArraySet()
        +
        A function that converts streams to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Stream<A>,java.util.concurrent.DelayQueue<A>> Stream_DelayQueue()
        +
        A function that converts streams to delay queues.
        +
        +
        Returns:
        +
        A function that converts streams to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>> Stream_LinkedBlockingQueue()
        +
        A function that converts streams to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>> Stream_PriorityBlockingQueue()
        +
        A function that converts streams to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_SynchronousQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>> Stream_SynchronousQueue(boolean fair)
        +
        A function that converts streams to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts streams to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayList

        +
        public static <A> F<Option<A>,java.util.ArrayList<A>> Option_ArrayList()
        +
        A function that converts options to array lists.
        +
        +
        Returns:
        +
        A function that converts options to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Option<A>,java.util.EnumSet<A>> Option_EnumSet()
        +
        A function that converts options to enum sets.
        +
        +
        Returns:
        +
        A function that converts options to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_HashSet

        +
        public static <A> F<Option<A>,java.util.HashSet<A>> Option_HashSet()
        +
        A function that converts options to hash sets.
        +
        +
        Returns:
        +
        A function that converts options to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedHashSet

        +
        public static <A> F<Option<A>,java.util.LinkedHashSet<A>> Option_LinkedHashSet()
        +
        A function that converts options to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts options to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedList

        +
        public static <A> F<Option<A>,java.util.LinkedList<A>> Option_LinkedList()
        +
        A function that converts options to linked lists.
        +
        +
        Returns:
        +
        A function that converts options to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueue

        +
        public static <A> F<Option<A>,java.util.PriorityQueue<A>> Option_PriorityQueue()
        +
        A function that converts options to priority queues.
        +
        +
        Returns:
        +
        A function that converts options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stack

        +
        public static <A> F<Option<A>,java.util.Stack<A>> Option_Stack()
        +
        A function that converts options to stacks.
        +
        +
        Returns:
        +
        A function that converts options to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Option_TreeSet

        +
        public static <A> F<Option<A>,java.util.TreeSet<A>> Option_TreeSet()
        +
        A function that converts options to tree sets.
        +
        +
        Returns:
        +
        A function that converts options to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Vector

        +
        public static <A> F<Option<A>,java.util.Vector<A>> Option_Vector()
        +
        A function that converts options to vectors.
        +
        +
        Returns:
        +
        A function that converts options to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>> Option_ArrayBlockingQueue(boolean fair)
        +
        A function that converts options to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts options to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ConcurrentLinkedQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Option_ConcurrentLinkedQueue()
        +
        A function that converts options to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts options to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArrayList

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Option_CopyOnWriteArrayList()
        +
        A function that converts options to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArraySet

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Option_CopyOnWriteArraySet()
        +
        A function that converts options to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Option<A>,java.util.concurrent.DelayQueue<A>> Option_DelayQueue()
        +
        A function that converts options to delay queues.
        +
        +
        Returns:
        +
        A function that converts options to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>> Option_LinkedBlockingQueue()
        +
        A function that converts options to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>> Option_PriorityBlockingQueue()
        +
        A function that converts options to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_SynchronousQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>> Option_SynchronousQueue(boolean fair)
        +
        A function that converts options to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts options to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<A>> Either_ArrayListA()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<B>> Either_ArrayListB()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetA

        +
        public static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet> Either_BitSetA()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetB

        +
        public static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet> Either_BitSetB()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetA

        +
        public static <A extends java.lang.Enum<A>,B> F<Either<A,B>,java.util.EnumSet<A>> Either_EnumSetA()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetB

        +
        public static <A,B extends java.lang.Enum<B>> F<Either<A,B>,java.util.EnumSet<B>> Either_EnumSetB()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<A>> Either_HashSetA()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<B>> Either_HashSetB()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>> Either_LinkedHashSetA()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>> Either_LinkedHashSetB()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<A>> Either_LinkedListA()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>> Option_PriorityQueueA()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>> Option_PriorityQueueB()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<B>> Either_LinkedListB()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackA

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<A>> Either_StackA()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackB

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<B>> Either_StackB()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetA

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<A>> Either_TreeSetA()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetB

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<B>> Either_TreeSetB()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorA

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<A>> Either_VectorA()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorB

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<B>> Either_VectorB()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>> Either_ArrayBlockingQueueA(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>> Either_ArrayBlockingQueueB(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>> Either_ConcurrentLinkedQueueA()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>> Either_ConcurrentLinkedQueueB()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>> Either_CopyOnWriteArrayListA()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>> Either_CopyOnWriteArrayListB()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>> Either_CopyOnWriteArraySetA()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>> Either_CopyOnWriteArraySetB()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueA

        +
        public static <A extends java.util.concurrent.Delayed,B> F<Either<A,B>,java.util.concurrent.DelayQueue<A>> Either_DelayQueueA()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueB

        +
        public static <A,B extends java.util.concurrent.Delayed> F<Either<A,B>,java.util.concurrent.DelayQueue<B>> Either_DelayQueueB()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>> Either_LinkedBlockingQueueA()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>> Either_LinkedBlockingQueueB()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>> Either_PriorityBlockingQueueA()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>> Either_PriorityBlockingQueueB()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>> Either_SynchronousQueueA(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>> Either_SynchronousQueueB(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_ArrayBlockingQueue

        +
        public static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> String_ArrayBlockingQueue(boolean fair)
        +
        A function that converts strings to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts strings to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_SynchronousQueue

        +
        public static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>> String_SynchronousQueue(boolean fair)
        +
        A function that converts strings to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts strings to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuffer_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_SynchronousQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuffer_SynchronousQueue(boolean fair)
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuilder_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string builders to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string builders to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_SynchronousQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuilder_SynchronousQueue(boolean fair)
        +
        A function that converts string builders to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string builders to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayList_List

        +
        public static <A> F<java.util.ArrayList<A>,List<A>> ArrayList_List()
        +
        A function that converts array lists to lists.
        +
        +
        Returns:
        +
        A function that converts array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        JUList_List

        +
        @Deprecated
+public static <A> F<java.util.List<A>,List<A>> JUList_List()
        +
        Deprecated. As of 4.3, use JavaList_List()
        +
        A function that converts Java lists to lists.
        +
        +
        Returns:
        +
        A function that converts Java lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> F<java.util.List<A>,List<A>> JavaList_List()
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> List<A> JavaList_List(java.util.List<A> list)
        +
        • +
      + + + +
        +
      • +

        EnumSet_List

        +
        public static <A extends java.lang.Enum<A>> F<java.util.EnumSet<A>,List<A>> EnumSet_List()
        +
        A function that converts enum sets to lists.
        +
        +
        Returns:
        +
        A function that converts enum sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> List<A> Collection_List(java.util.Collection<A> c)
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> F<java.util.Collection<A>,List<A>> Collection_List()
        +
        • +
      + + + +
        +
      • +

        HashSet_List

        +
        public static <A> F<java.util.HashSet<A>,List<A>> HashSet_List()
        +
        A function that converts hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedHashSet_List

        +
        public static <A> F<java.util.LinkedHashSet<A>,List<A>> LinkedHashSet_List()
        +
        A function that converts linked hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts linked hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedList_List

        +
        public static <A> F<java.util.LinkedList<A>,List<A>> LinkedList_List()
        +
        A function that converts linked lists to lists.
        +
        +
        Returns:
        +
        A function that converts linked lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityQueue_List

        +
        public static <A> F<java.util.PriorityQueue<A>,List<A>> PriorityQueue_List()
        +
        A function that converts priority queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stack_List

        +
        public static <A> F<java.util.Stack<A>,List<A>> Stack_List()
        +
        A function that converts stacks to lists.
        +
        +
        Returns:
        +
        A function that converts stacks to lists.
        +
        +
        • +
      + + + +
        +
      • +

        TreeSet_List

        +
        public static <A> F<java.util.TreeSet<A>,List<A>> TreeSet_List()
        +
        A function that converts tree sets to lists.
        +
        +
        Returns:
        +
        A function that converts tree sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Vector_List

        +
        public static <A> F<java.util.Vector<A>,List<A>> Vector_List()
        +
        A function that converts vectors to lists.
        +
        +
        Returns:
        +
        A function that converts vectors to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>> ArrayBlockingQueue_List()
        +
        A function that converts array blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts array blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ConcurrentLinkedQueue_List

        +
        public static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>> ConcurrentLinkedQueue_List()
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        Returns:
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArrayList_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>> CopyOnWriteArrayList_List()
        +
        A function that converts copy on write array lists to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArraySet_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>> CopyOnWriteArraySet_List()
        +
        A function that converts copy on write array sets to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        DelayQueue_List

        +
        public static <A extends java.util.concurrent.Delayed> F<java.util.concurrent.DelayQueue<A>,List<A>> DelayQueue_List()
        +
        A function that converts delay queues to lists.
        +
        +
        Returns:
        +
        A function that converts delay queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>> LinkedBlockingQueue_List()
        +
        A function that converts linked blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts linked blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>> PriorityBlockingQueue_List()
        +
        A function that converts priority blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        SynchronousQueue_List

        +
        public static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>> SynchronousQueue_List()
        +
        A function that converts synchronous queues to lists.
        +
        +
        Returns:
        +
        A function that converts synchronous queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        P1_Callable

        +
        public static <A> F<P1<A>,java.util.concurrent.Callable<A>> P1_Callable()
        +
        • +
      + + + +
        +
      • +

        Future_P1

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>> Future_P1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/LazyString.html b/javadoc/4.8.1/functionaljava/fj/data/LazyString.html new file mode 100644 index 0000000..5a8395c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/LazyString.html @@ -0,0 +1,983 @@ + + + + + +LazyString (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class LazyString

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.LazyString
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.CharSequence
    +
    +
    +
    +
    public final class LazyString
+extends java.lang.Object
+implements java.lang.CharSequence
    +
    A lazy (non-evaluated) immutable character string.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static LazyStringempty +
      The empty string.
      +
      static F<Stream<java.lang.Character>,LazyString>fromStream +
      First-class conversion from character streams to lazy strings.
      +
      static F<LazyString,Stream<java.lang.Character>>toStream +
      First-class conversion from lazy strings to streams.
      +
      static F<LazyString,java.lang.String>toString +
      First-class conversion from lazy strings to String.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      LazyStringappend(LazyString cs) +
      Appends the given lazy string to the end of this lazy string.
      +
      LazyStringappend(java.lang.String s) +
      Appends the given String to the end of this lazy string.
      +
      LazyStringbind(F<java.lang.Character,LazyString> f) 
      charcharAt(int index) +
      Returns the caracter at the specified index.
      +
      booleancontains(LazyString cs) +
      Returns true if the given lazy string is a substring of this lazy string.
      +
      booleanendsWith(LazyString cs) +
      Returns true if the given lazy string is a suffix of this lazy string.
      +
      java.lang.Stringeval() 
      static LazyStringfromStream(Stream<java.lang.Character> s) +
      Constructs a lazy string from a stream of characters.
      +
      charhead() +
      Returns the first character of this string.
      +
      Option<java.lang.Integer>indexOf(char c) +
      Returns the first index of the given character in this lazy string, if present.
      +
      Option<java.lang.Integer>indexOf(LazyString cs) +
      Returns the first index of the given substring in this lazy string, if present.
      +
      booleanisEmpty() +
      Checks if this string is empty.
      +
      intlength() +
      The length of the lazy string.
      +
      static F<LazyString,Stream<LazyString>>lines_() 
      Stream<LazyString>lines() +
      Splits this lazy string into lines.
      +
      LazyStringmap(F<java.lang.Character,java.lang.Character> f) 
      booleanmatches(java.lang.String regex) +
      Regular expression pattern matching.
      +
      LazyStringreverse() +
      Returns the reverse of this string.
      +
      Stream<LazyString>split(char c) +
      Splits this lazy string by the given delimiter character.
      +
      Stream<LazyString>split(F<java.lang.Character,java.lang.Boolean> p) +
      Splits this lazy string by characters matching the given predicate.
      +
      static F<LazyString,F<LazyString,java.lang.Boolean>>startsWith() +
      First-class prefix check.
      +
      booleanstartsWith(LazyString cs) +
      Returns true if the given lazy string is a prefix of this lazy string.
      +
      static LazyStringstr(java.lang.String s) +
      Constructs a lazy string from a String.
      +
      java.lang.CharSequencesubSequence(int start, + int end) +
      Gets the specified subsequence of this lazy string.
      +
      LazyStringtail() +
      Returns all but the first character of this string.
      +
      Stream<java.lang.Character>toStream() +
      Gives a stream representation of this lazy string.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() +
      Returns the String representation of this lazy string.
      +
      java.lang.StringtoStringLazy() 
      static F<Stream<LazyString>,LazyString>unlines_() 
      static LazyStringunlines(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by newlines.
      +
      static LazyStringunwords(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by spaces.
      +
      Stream<LazyString>words() +
      Splits this lazy string into words by spaces.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.CharSequence

        +chars, codePoints
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        empty

        +
        public static final LazyString empty
        +
        The empty string.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static final F<LazyString,Stream<java.lang.Character>> toStream
        +
        First-class conversion from lazy strings to streams.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public static final F<LazyString,java.lang.String> toString
        +
        First-class conversion from lazy strings to String.
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static final F<Stream<java.lang.Character>,LazyString> fromStream
        +
        First-class conversion from character streams to lazy strings.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        str

        +
        public static LazyString str(java.lang.String s)
        +
        Constructs a lazy string from a String.
        +
        +
        Parameters:
        +
        s - A string from which to construct a lazy string.
        +
        Returns:
        +
        A lazy string with the characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static LazyString fromStream(Stream<java.lang.Character> s)
        +
        Constructs a lazy string from a stream of characters.
        +
        +
        Parameters:
        +
        s - A stream of characters.
        +
        Returns:
        +
        A lazy string with the characters from the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Character> toStream()
        +
        Gives a stream representation of this lazy string.
        +
        +
        Returns:
        +
        A stream representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of the lazy string. Note that this operation is O(n).
        +
        +
        Specified by:
        +
        length in interface java.lang.CharSequence
        +
        Returns:
        +
        The length of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        charAt

        +
        public char charAt(int index)
        +
        Returns the caracter at the specified index.
        +
        +
        Specified by:
        +
        charAt in interface java.lang.CharSequence
        +
        Parameters:
        +
        index - The index for the character to be returned.
        +
        Returns:
        +
        The character at the specified index.
        +
        +
        • +
      + + + +
        +
      • +

        subSequence

        +
        public java.lang.CharSequence subSequence(int start,
+                                          int end)
        +
        Gets the specified subsequence of this lazy string. + This operation does not fail for indexes that are out of bounds. If the start index is past the end + of this lazy string, then the resulting character sequence will be empty. If the end index is past the + end of this lazy string, then the resulting character sequence will be truncated.
        +
        +
        Specified by:
        +
        subSequence in interface java.lang.CharSequence
        +
        Parameters:
        +
        start - The character index of this lazy string at which to start the subsequence.
        +
        end - The character index of this lazy string at which to end the subsequence.
        +
        Returns:
        +
        A character sequence containing the specified character subsequence.
        +
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public java.lang.String toStringEager()
        +
        Returns the String representation of this lazy string.
        +
        +
        Returns:
        +
        The String representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Specified by:
        +
        toString in interface java.lang.CharSequence
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eval

        +
        public java.lang.String eval()
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(LazyString cs)
        +
        Appends the given lazy string to the end of this lazy string.
        +
        +
        Parameters:
        +
        cs - A lazy string to append to this one.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(java.lang.String s)
        +
        Appends the given String to the end of this lazy string.
        +
        +
        Parameters:
        +
        s - A String to append to this lazy string.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this lazy string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(LazyString cs)
        +
        Returns true if the given lazy string is a substring of this lazy string.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        True if the given string is a substring of this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        endsWith

        +
        public boolean endsWith(LazyString cs)
        +
        Returns true if the given lazy string is a suffix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the end of this lazy string.
        +
        Returns:
        +
        True if the given string is a suffix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public boolean startsWith(LazyString cs)
        +
        Returns true if the given lazy string is a prefix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the start of this lazy string.
        +
        Returns:
        +
        True if the given string is a prefix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public static F<LazyString,F<LazyString,java.lang.Boolean>> startsWith()
        +
        First-class prefix check.
        +
        +
        Returns:
        +
        A function that yields true if the first argument is a prefix of the second.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public char head()
        +
        Returns the first character of this string.
        +
        +
        Returns:
        +
        The first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public LazyString tail()
        +
        Returns all but the first character of this string.
        +
        +
        Returns:
        +
        All but the first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this string is empty.
        +
        +
        Returns:
        +
        True if there are no characters in this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public LazyString reverse()
        +
        Returns the reverse of this string.
        +
        +
        Returns:
        +
        the reverse of this string.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(char c)
        +
        Returns the first index of the given character in this lazy string, if present.
        +
        +
        Parameters:
        +
        c - A character to find in this lazy string.
        +
        Returns:
        +
        The first index of the given character in this lazy string, or None if the character is not present.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(LazyString cs)
        +
        Returns the first index of the given substring in this lazy string, if present.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        The first index of the given substring in this lazy string, or None if there is no such substring.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.String regex)
        +
        Regular expression pattern matching.
        +
        +
        Parameters:
        +
        regex - A regular expression to match this lazy string.
        +
        Returns:
        +
        True if this string mathches the given regular expression, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(F<java.lang.Character,java.lang.Boolean> p)
        +
        Splits this lazy string by characters matching the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate that matches characters to be considered delimiters.
        +
        Returns:
        +
        A stream of the substrings in this lazy string, when separated by the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public LazyString map(F<java.lang.Character,java.lang.Character> f)
        +
        • +
      + + + + + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(char c)
        +
        Splits this lazy string by the given delimiter character.
        +
        +
        Parameters:
        +
        c - A delimiter character at which to split.
        +
        Returns:
        +
        A stream of substrings of this lazy string, when separated by the given delimiter.
        +
        +
        • +
      + + + +
        +
      • +

        words

        +
        public Stream<LazyString> words()
        +
        Splits this lazy string into words by spaces.
        +
        +
        Returns:
        +
        A stream of the words in this lazy string, when split by spaces.
        +
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public Stream<LazyString> lines()
        +
        Splits this lazy string into lines.
        +
        +
        Returns:
        +
        A stream of the lines in this lazy string, when split by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unlines

        +
        public static LazyString unlines(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by newlines.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by newlines.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings separated by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unwords

        +
        public static LazyString unwords(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by spaces.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by spaces.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings with spaces in between.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/List.Buffer.html b/javadoc/4.8.1/functionaljava/fj/data/List.Buffer.html new file mode 100644 index 0000000..b9d22c6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/List.Buffer.html @@ -0,0 +1,483 @@ + + + + + +List.Buffer (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class List.Buffer<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Buffer<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Buffer<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable, singly linked list. This structure should be used very sparingly, in favour + of the immutable singly linked list structure.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Buffer() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      List.Buffer<A>append(List<A> as) +
      Appends the given list to this buffer.
      +
      static <A> List.Buffer<A>empty() +
      An empty buffer.
      +
      static <A> List.Buffer<A>fromList(List<A> as) +
      Constructs a buffer from the given list.
      +
      booleanisEmpty() +
      Returns true if this buffer is empty, false otherwise.
      +
      static <A> List.Buffer<A>iterableBuffer(java.lang.Iterable<A> i) +
      Takes the given iterable to a buffer.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this buffer.
      +
      List<A>prependToList(List<A> as) +
      Prepends the elements of this buffer to the given list.
      +
      List.Buffer<A>snoc(A a) +
      Appends (snoc) the given element to this buffer to produce a new buffer.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this buffer.
      +
      List<A>toList() +
      Returns an immutable list projection of this buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Buffer

        +
        public Buffer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this buffer. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this buffer.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public List.Buffer<A> snoc(A a)
        +
        Appends (snoc) the given element to this buffer to produce a new buffer.
        +
        +
        Parameters:
        +
        a - The element to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public List.Buffer<A> append(List<A> as)
        +
        Appends the given list to this buffer.
        +
        +
        Parameters:
        +
        as - The list to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        prependToList

        +
        public List<A> prependToList(List<A> as)
        +
        Prepends the elements of this buffer to the given list.
        +
        +
        Parameters:
        +
        as - the list to which elements are prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true if this buffer is empty, false otherwise.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns an immutable list projection of this buffer. Modifications to the underlying buffer + will not be reflected in returned lists.
        +
        +
        Returns:
        +
        An immutable list projection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this buffer.
        +
        +
        Returns:
        +
        An immutable collection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> List.Buffer<A> empty()
        +
        An empty buffer.
        +
        +
        Returns:
        +
        An empty buffer.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> List.Buffer<A> fromList(List<A> as)
        +
        Constructs a buffer from the given list.
        +
        +
        Parameters:
        +
        as - The list to construct a buffer with.
        +
        Returns:
        +
        A buffer from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableBuffer

        +
        public static <A> List.Buffer<A> iterableBuffer(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a buffer.
        +
        +
        Parameters:
        +
        i - The iterable to take to a buffer.
        +
        Returns:
        +
        A buffer from the given iterable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/List.Optic.html b/javadoc/4.8.1/functionaljava/fj/data/List.Optic.html new file mode 100644 index 0000000..5f530e4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/List.Optic.html @@ -0,0 +1,323 @@ + + + + + +List.Optic (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Optic
+extends java.lang.Object
    +
    Optic factory methods for a List
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pTraversal

        +
        public static <A,B> PTraversal<List<A>,List<B>,A,B> pTraversal()
        +
        Polymorphic traversal
        +
        • +
      + + + +
        +
      • +

        traversal

        +
        public static <A> Traversal<List<A>,A> traversal()
        +
        Monomorphic traversal
        +
        • +
      + + + +
        +
      • +

        head

        +
        public static <A> Optional<List<A>,A> head()
        +
        Optional targeted on Cons head.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public static <A> Optional<List<A>,List<A>> tail()
        +
        Optional targeted on Cons tail.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Prism<List<A>,Unit> nil()
        +
        Nil prism
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> Prism<List<A>,P2<A,List<A>>> cons()
        +
        Cons prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/List.Unsafe.html b/javadoc/4.8.1/functionaljava/fj/data/List.Unsafe.html new file mode 100644 index 0000000..a28df16 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/List.Unsafe.html @@ -0,0 +1,239 @@ + + + + + +List.Unsafe (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Unsafe

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Unsafe
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Unsafe
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Unsafe() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Unsafe

        +
        public Unsafe()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/List.html b/javadoc/4.8.1/functionaljava/fj/data/List.html new file mode 100644 index 0000000..cfb0bf8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/List.html @@ -0,0 +1,3771 @@ + + + + + +List (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class List<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class List.Buffer<A> +
      A mutable, singly linked list.
      +
      static class List.Optic +
      Optic factory methods for a List
      +
      static class List.Unsafe 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      booleanallEqual(Equal<A> eq) +
      Returns whether or not all elements in the list are equal according to the given equality test.
      +
      List<A>append(List<A> as) +
      Appends the given list to this list.
      +
      <B> List<B>apply(List<F<A,B>> lf) +
      Performs function application within a list (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this list.
      +
      static <A> List<A>arrayList(A... as) +
      Constructs a list from the given elements.
      +
      static F<List<java.lang.Character>,java.lang.String>asString() +
      A first-class asString.
      +
      static java.lang.StringasString(List<java.lang.Character> cs) +
      Returns a string from the given list of characters.
      +
      static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>>bind_() +
      Provides a first-class version of bind()
      +
      <B> List<B>bind(F<A,List<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      <B,C> List<C>bind(List<B> lb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C> List<C>bind(List<B> lb, + F2<A,B,C> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C,D> List<D>bind(List<B> lb, + List<C> lc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E> List<E>bind(List<B> lb, + List<C> lc, + List<D> ld, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$>
      List<F$>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G>
      List<G>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H>
      List<H>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      List<I>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + List<H> lh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      P2<List<A>,List<A>>breakk(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
      +
      static <A> F2<A,List<A>,List<A>>cons_() 
      static <A> F<List<A>,List<A>>cons_(A a) +
      Returns a function that prepends the given value to a list.
      +
      static <A> F<A,F<List<A>,List<A>>>cons() +
      Returns a function that prepends (cons) an element to a list to produce a new list.
      +
      List<A>cons(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      static <A> List<A>cons(A head, + List<A> tail) +
      Prepends the given head element to the given tail element to produce a new list.
      +
      static <A> F<A,List<A>>cons(List<A> tail) +
      Returns a function that prepends a value to the given list.
      +
      List<A>conss(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      List<A>delete(A a, + Equal<A> e) +
      Removes the first element that equals the given object.
      +
      List<A>drop(int i) +
      Drops the given number of elements from the head of this list if they are available.
      +
      List<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
      +
      Option<java.lang.Integer>elementIndex(Equal<A> e, + A a) +
      Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
      +
      List<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>>foldLeft() +
      Provides a first-class version of foldLeft.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> Trampoline<B>foldRightC(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list in O(1) stack space.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this list.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this list.
      +
      static <A> List<A>fromIterator(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static F<java.lang.String,List<java.lang.Character>>fromString() +
      A first-class fromString.
      +
      static List<java.lang.Character>fromString(java.lang.String s) +
      Returns a list of characters from the given string.
      +
      List<List<A>>group(Equal<A> e) +
      Groups elements according to the given equality implementation by longest + sequence of equal elements.
      +
      <B> TreeMap<B,List<A>>groupBy(F<A,B> keyFunction) +
      Deprecated.  +
      As of release 4.7, use groupBy(F, Ord)
      +
      +
      <B,C> TreeMap<B,List<C>>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction) +
      Deprecated.  +
      As of release 4.7, use groupBy(F, F, Ord)
      +
      +
      <B,C,D> TreeMap<B,D>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + D groupingIdentity, + F2<C,D,D> groupingAcc, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
      +
      <B,C> TreeMap<B,C>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Monoid<C> monoid, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B,C> TreeMap<B,List<C>>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B> TreeMap<B,List<A>>groupBy(F<A,B> keyFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap.
      +
      inthashCode() +
      Compute the hash code from this list as a function of the hash codes of its members.
      +
      static <A> F<List<A>,A>head_() +
      First-class head function.
      +
      abstract Ahead() +
      The first element of the linked list or fails for the empty list.
      +
      Option<A>headOption() +
      Returns the head of the list, if any.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      List<A>init() +
      Returns all but the last element of this list.
      +
      List<List<A>>inits() +
      Returns the list of initial segments of this list, shortest first.
      +
      List<A>insertBy(F<A,F<A,Ordering>> f, + A x) +
      Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
      +
      List<A>intercalate(List<List<A>> as) +
      Intersperses this list through the given list then joins the results.
      +
      List<A>intersperse(A a) +
      Intersperses the given argument between each element of this list.
      +
      static <A> F<List<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given list is empty.
      +
      booleanisEmpty() +
      Returns true if this list is empty, false otherwise.
      +
      static <A> F<List<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given list is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this list is empty, true otherwise.
      +
      booleanisPrefixOf(Equal<A> eq, + List<A> xs) 
      booleanisSingle() +
      True if and only if the list has one element.
      +
      booleanisSuffixOf(Equal<A> eq, + List<A> xs) 
      static <A> List<A>iterableList(java.lang.Iterable<A> i) +
      Takes the given iterable to a list.
      +
      static <A> List<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this list.
      +
      static <A> List<A>iteratorList(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static <A> F<List<List<A>>,List<A>>join() +
      A first-class version of join
      +
      static <A> List<A>join(List<List<A>> o) +
      Joins the given list of lists using a bind operation.
      +
      Alast() +
      Returns the last element of this list.
      +
      static <A> F<List<A>,java.lang.Integer>length_() +
      First-class length.
      +
      intlength() +
      The length of this list.
      +
      static <A,B,C> F<List<A>,F<List<B>,List<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes the given function of arity-2 to a function on lists.
      +
      static <A> List<A>list(A... as) +
      Constructs a list from the given elements.
      +
      <B> Blist(B nil, + F<A,F<List<A>,B>> cons) +
      Deprecated.  +
      As of release 4.5, use uncons(fj.F2<A, fj.data.List<A>, B>, B)
      +
      +
      static <A> List<A>list(java.lang.Iterable<A> i) +
      Deprecated.  +
      As of release 4.5, use iterableList(Iterable)
      +
      +
      static <A> List<A>list(java.util.Iterator<A> it) +
      Deprecated.  +
      As of release 4.5, use iteratorList(Iterator)
      +
      +
      static <A,B> F2<List<P2<A,B>>,A,Option<B>>lookup(Equal<A> e) +
      Returns a partially applied version of lookup(Equal, List, Object).
      +
      static <A,B> Option<B>lookup(Equal<A> e, + List<P2<A,B>> x, + A a) +
      Returns an associated value with the given key in the list of pairs.
      +
      static <A,B> F<F<A,B>,F<List<A>,List<B>>>map_() +
      Provides a first-class version of map()
      +
      <B> List<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B,C> F<B,List<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
      +
      <B> Option<List<B>>mapMOption(F<A,Option<B>> f) +
      Maps the given function across this list by binding through the Option monad.
      +
      <B> Trampoline<List<B>>mapMTrampoline(F<A,Trampoline<B>> f) +
      Maps the given function across this list by binding through the Trampoline monad.
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Option<A>maximumOption(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      Option<A>minimumOption(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      List<A>minus(Equal<A> eq, + List<A> xs) +
      Returns a new list of all the items in this list that do not appear in the given list.
      +
      Amode(Ord<A> o) +
      Returns the most common element in this list.
      +
      static <A> List<A>nil() +
      Returns an empty list.
      +
      List<A>nub() +
      Removes duplicates according to object equality.
      +
      List<A>nub(Equal<A> eq) +
      Removes duplicates according to the given equality.
      +
      List<A>nub(Ord<A> o) +
      Removes duplicates according to the given ordering.
      +
      AorHead(F0<A> a) +
      Returns the head of this list if there is one or the given argument if this list is empty.
      +
      List<A>orTail(F0<List<A>> as) +
      Returns the tail of this list if there is one or the given argument if this list is empty.
      +
      P2<List<A>,List<A>>partition(F<A,java.lang.Boolean> f) +
      Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
      +
      List<List<A>>partition(int n) +
      Splits this list into lists of the given size.
      +
      static List<java.lang.Integer>range(int from, + int to) +
      Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      List<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> List<A>replicate(int n, + A a) +
      Returns a list of the given value replicated the given number of times.
      +
      List<A>reverse() +
      Reverse this list in constant stack space.
      +
      static <A,B> F<B,List<A>>sequence_(List<F<B,A>> fs) +
      Turn a list of functions into a function returning a list.
      +
      <B> List<B>sequence(List<B> bs) +
      Performs a bind across each list element, but ignores the element value each time.
      +
      static <A> List<A>single(A a) +
      Returns a list of one element containing the given value.
      +
      List<A>snoc(A a) +
      Appends (snoc) the given element to this list to produce a new list.
      +
      List<A>sort(Ord<A> o) +
      Sorts this list using the given order over elements using a merge sort algorithm.
      +
      P2<List<A>,List<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
      +
      P2<List<A>,List<A>>splitAt(int i) +
      Splits this list into two lists at the given index.
      +
      static <A> F<List<A>,List<A>>tail_() +
      First-class tail function.
      +
      abstract List<A>tail() +
      The list without the first element or fails for the empty list.
      +
      Option<List<A>>tailOption() +
      Reutrns the tail of the list, if any.
      +
      List<List<A>>tails() +
      Returns the list of final segments of this list, longest first.
      +
      static <A> F<java.lang.Integer,F<List<A>,List<A>>>take() +
      Provides a first-class version of take.
      +
      List<A>take(int i) +
      Takes the given number of elements from the head of this list if they are available.
      +
      List<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this list that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this list.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this list.
      +
      java.lang.Object[]toArrayObject() 
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this list.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.List<A>toJavaList() 
      Option<A>toOption() +
      Deprecated.  +
      As of release 4.5, use headOption()
      +
      +
      Stream<A>toStream() +
      Returns a stream projection of this list.
      +
      java.lang.StringtoString() +
      Obtain a string representation of this list using the toString implementations of the members.
      +
      <B,E> Either<E,List<B>>traverseEither(F<A,Either<E,B>> f) +
      Traverse through the List with given function.
      +
      <C,B> F<C,List<B>>traverseF(F<A,F<C,B>> f) 
      <B> IO<List<B>>traverseIO(F<A,IO<B>> f) 
      <B> List<List<B>>traverseList(F<A,List<B>> f) 
      <B> Option<List<B>>traverseOption(F<A,Option<B>> f) +
      Traverses through the List with the given function
      +
      <B> P1<List<B>>traverseP1(F<A,P1<B>> f) 
      <B> Promise<List<B>>traversePromise(F<A,Promise<B>> f) 
      <B> Stream<List<B>>traverseStream(F<A,Stream<B>> f) 
      <B> Trampoline<List<B>>traverseTrampoline(F<A,Trampoline<B>> f) 
      <B> V2<List<B>>traverseV2(F<A,V2<B>> f) 
      <E,B> Validation<E,List<B>>traverseValidation(Semigroup<E> s, + F<A,Validation<E,B>> f) 
      <B> Buncons(F2<A,List<A>,B> cons, + B nil) 
      static <A,B> List<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a list.
      +
      static <A,B> P2<List<A>,List<B>>unzip(List<P2<A,B>> xs) +
      Transforms a list of pairs into a list of first components and a list of second components.
      +
      static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>>zip() +
      The first-class version of the zip function.
      +
      <B> List<P2<A,B>>zip(List<B> bs) +
      Zips this list with the given list to produce a list of pairs.
      +
      List<P2<A,java.lang.Integer>>zipIndex() +
      Zips this list with the index of its element as a pair.
      +
      static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>>zipWith() +
      Provides a first-class version of zipWith
      +
      <B,C> List<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      <B,C> List<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        Returns:
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract List<A> tail()
        +
        The list without the first element or fails for the empty list.
        +
        +
        Returns:
        +
        The list without the first element or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this list is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this list is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this list is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this list is empty, true otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        list

        +
        @Deprecated
+public final <B> B list(B nil,
+                                    F<A,F<List<A>,B>> cons)
        +
        Deprecated. As of release 4.5, use uncons(fj.F2<A, fj.data.List<A>, B>, B)
        +
        Performs a reduction on this list using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this list is empty.
        +
        cons - The function to apply to the head and tail of this list if it is not empty.
        +
        Returns:
        +
        A reduction on this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(F2<A,List<A>,B> cons,
+                          B nil)
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this list is empty.
        +
        Returns:
        +
        The head of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final List<A> orTail(F0<List<A>> as)
        +
        Returns the tail of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this list is empty.
        +
        Returns:
        +
        The tail of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        @Deprecated
+public final Option<A> toOption()
        +
        Deprecated. As of release 4.5, use headOption()
        +
        Returns an option projection of this list; None if empty, or the first element in + Some. Equivalent to headOption().
        +
        +
        Returns:
        +
        An option projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        Returns the head of the list, if any. Equivalent to toOption() .
        +
        +
        Returns:
        +
        The optional head of the list.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this list is empty.
        +
        Returns:
        +
        An either projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this list.
        +
        +
        Returns:
        +
        A stream projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this list.
        +
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArrayObject

        +
        public final java.lang.Object[] toArrayObject()
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public final A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final List<A> cons(A a)
        +
        Prepends (cons) the given element to this list to product a new list.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + + + +
        +
      • +

        conss

        +
        public final List<A> conss(A a)
        +
        Prepends (cons) the given element to this list to product a new list. This method is added to prevent conflict with + overloads.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> List<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final List<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final List<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final List<A> delete(A a,
+                            Equal<A> e)
        +
        Removes the first element that equals the given object. + To remove all matches, use removeAll(e.eq(a))
        +
        +
        Parameters:
        +
        a - The element to remove
        +
        e - An Equals instance for the element's type.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final List<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this list that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this list until it finds an element that does not + hold, or the list is exhausted.
        +
        Returns:
        +
        The first elements of the head of this list that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final List<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this list.
        +
        Returns:
        +
        The list whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<List<A>,List<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        breakk

        +
        public final P2<List<A>,List<A>> breakk(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate for an element to not satisfy by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        group

        +
        public final List<List<A>> group(Equal<A> e)
        +
        Groups elements according to the given equality implementation by longest + sequence of equal elements.
        +
        +
        Parameters:
        +
        e - The equality implementation for the elements.
        +
        Returns:
        +
        A list of grouped elements.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> List<B> bind(F<A,List<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F2<A,B,C> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<List<A>,F<List<B>,List<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on lists.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on lists.
        +
        Returns:
        +
        The given function, promoted to operate on lists.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> List<D> bind(List<B> lb,
+                                  List<C> lc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> List<E> bind(List<B> lb,
+                                    List<C> lc,
+                                    List<D> ld,
+                                    F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> List<F$> bind(List<B> lb,
+                                        List<C> lc,
+                                        List<D> ld,
+                                        List<E> le,
+                                        F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> List<G> bind(List<B> lb,
+                                         List<C> lc,
+                                         List<D> ld,
+                                         List<E> le,
+                                         List<F$> lf,
+                                         F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> List<H> bind(List<B> lb,
+                                           List<C> lc,
+                                           List<D> ld,
+                                           List<E> le,
+                                           List<F$> lf,
+                                           List<G> lg,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> List<I> bind(List<B> lb,
+                                             List<C> lc,
+                                             List<D> ld,
+                                             List<E> le,
+                                             List<F$> lf,
+                                             List<G> lg,
+                                             List<H> lh,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        lh - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> List<B> sequence(List<B> bs)
        +
        Performs a bind across each list element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The list to apply in the final join.
        +
        Returns:
        +
        A new list after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<List<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverses through the List with the given function
        +
        +
        Parameters:
        +
        f - The function that produces Option value
        +
        Returns:
        +
        none if applying f returns none to any element of the list or f mapped list in some .
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,E> Either<E,List<B>> traverseEither(F<A,Either<E,B>> f)
        +
        Traverse through the List with given function.
        +
        +
        Parameters:
        +
        f - The function that produces Either value.
        +
        Returns:
        +
        error in left or f mapped list in right.
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<List<B>> traverseStream(F<A,Stream<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<List<B>> traverseP1(F<A,P1<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<List<B>> traverseIO(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public final <C,B> F<C,List<B>> traverseF(F<A,F<C,B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        traverseList

        +
        public final <B> List<List<B>> traverseList(F<A,List<B>> f)
        +
        • +
      + + + + + + + +
        +
      • +

        traverseV2

        +
        public final <B> V2<List<B>> traverseV2(F<A,V2<B>> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> List<B> apply(List<F<A,B>> lf)
        +
        Performs function application within a list (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The list of functions to apply.
        +
        Returns:
        +
        A new list after applying the given list of functions through this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final List<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append to this one.
        +
        Returns:
        +
        A new list that has appended the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<B,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this list.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightC

        +
        public final <B> Trampoline<B> foldRightC(F2<A,B,B> f,
+                                          B b)
        +
        Performs a right-fold reduction across this list in O(1) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        A Trampoline containing the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final List<A> reverse()
        +
        Reverse this list in constant stack space.
        +
        +
        Returns:
        +
        A new list that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final List<A> take(int i)
        +
        Takes the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The maximum number of elements to take from this list.
        +
        Returns:
        +
        A new list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final List<A> drop(int i)
        +
        Drops the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this list.
        +
        Returns:
        +
        A list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        splitAt

        +
        public final P2<List<A>,List<A>> splitAt(int i)
        +
        Splits this list into two lists at the given index. If the index goes out of bounds, then it is + normalised so that this function never fails.
        +
        +
        Parameters:
        +
        i - The index at which to split this list in two parts.
        +
        Returns:
        +
        A pair of lists split at the given index of this list.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final List<List<A>> partition(int n)
        +
        Splits this list into lists of the given size. If the size of this list is not evenly divisible by + the given number, the last partition will contain the remainder.
        +
        +
        Parameters:
        +
        n - The size of the partitions into which to split this list.
        +
        Returns:
        +
        A list of sublists of this list, of at most the given size.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final P2<List<A>,List<A>> partition(F<A,java.lang.Boolean> f)
        +
        Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not. The relative order of the elements in the returned tuple + is the same as the original list.
        +
        +
        Parameters:
        +
        f - Predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final List<List<A>> inits()
        +
        Returns the list of initial segments of this list, shortest first.
        +
        +
        Returns:
        +
        The list of initial segments of this list, shortest first.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final List<List<A>> tails()
        +
        Returns the list of final segments of this list, longest first.
        +
        +
        Returns:
        +
        The list of final segments of this list, longest first.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final List<A> sort(Ord<A> o)
        +
        Sorts this list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this list.
        +
        Returns:
        +
        A sorted list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>> zipWith()
        +
        Provides a first-class version of zipWith
        +
        +
        Returns:
        +
        The first-class version of zipWith
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> List<P2<A,B>> zip(List<B> bs)
        +
        Zips this list with the given list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>> zip()
        +
        The first-class version of the zip function.
        +
        +
        Returns:
        +
        A function that zips the given lists to produce a list of pairs.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final List<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new list with the same length as this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final List<A> snoc(A a)
        +
        Appends (snoc) the given element to this list to produce a new list.
        +
        +
        Parameters:
        +
        a - The element to append to this list.
        +
        Returns:
        +
        A new list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on each element of this list.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this list, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this list.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + list.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this list.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final List<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this list.
        +
        Returns:
        +
        A list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        intercalate

        +
        public final List<A> intercalate(List<List<A>> as)
        +
        Intersperses this list through the given list then joins the results.
        +
        +
        Parameters:
        +
        as - The list to intersperse through.
        +
        Returns:
        +
        This list through the given list then joins the results.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub()
        +
        Removes duplicates according to object equality.
        +
        +
        Returns:
        +
        A list without duplicates according to object equality.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Equal<A> eq)
        +
        Removes duplicates according to the given equality. Warning: O(n^2).
        +
        +
        Parameters:
        +
        eq - Equality over the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Ord<A> o)
        +
        Removes duplicates according to the given ordering. This function is O(n).
        +
        +
        Parameters:
        +
        o - An ordering for the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        head_

        +
        public static <A> F<List<A>,A> head_()
        +
        First-class head function.
        +
        +
        Returns:
        +
        A function that gets the head of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        tailOption

        +
        public final Option<List<A>> tailOption()
        +
        Reutrns the tail of the list, if any.
        +
        +
        Returns:
        +
        The optional tail of the list.
        +
        +
        • +
      + + + +
        +
      • +

        tail_

        +
        public static <A> F<List<A>,List<A>> tail_()
        +
        First-class tail function.
        +
        +
        Returns:
        +
        A function that gets the tail of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final List<A> minus(Equal<A> eq,
+                           List<A> xs)
        +
        Returns a new list of all the items in this list that do not appear in the given list.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the lists.
        +
        xs - a list to subtract from this list.
        +
        Returns:
        +
        a list of all the items in this list that do not appear in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,List<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapMOption

        +
        public final <B> Option<List<B>> mapMOption(F<A,Option<B>> f)
        +
        Maps the given function across this list by binding through the Option monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A possible list of values after binding through the Option monad.
        +
        +
        • +
      + + + +
        +
      • +

        mapMTrampoline

        +
        public final <B> Trampoline<List<B>> mapMTrampoline(F<A,Trampoline<B>> f)
        +
        Maps the given function across this list by binding through the Trampoline monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A list of values in the Trampoline monad.
        +
        +
        • +
      + + + + + +
        +
      • +

        elementIndex

        +
        public final Option<java.lang.Integer> elementIndex(Equal<A> e,
+                                                    A a)
        +
        Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        Parameters:
        +
        e - An equality for this list's elements.
        +
        a - A query element.
        +
        Returns:
        +
        The index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Returns the last element of this list. Undefined for the empty list.
        +
        +
        Returns:
        +
        The last element of this list or throws an error if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public final List<A> init()
        +
        Returns all but the last element of this list. Undefiend for the empty list.
        +
        +
        Returns:
        +
        All but the last element of this list. Undefiend for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertBy

        +
        public final List<A> insertBy(F<A,F<A,Ordering>> f,
+                              A x)
        +
        Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
        +
        +
        Parameters:
        +
        f - An ordering function to compare elements.
        +
        x - The element to insert.
        +
        Returns:
        +
        A new list with the given element inserted before the first element that is greater than or equal to + it according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        mode

        +
        public final A mode(Ord<A> o)
        +
        Returns the most common element in this list.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The most common element in this list.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        @Deprecated
+public final <B> TreeMap<B,List<A>> groupBy(F<A,B> keyFunction)
        +
        Deprecated. As of release 4.7, use groupBy(F, Ord)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap. + The ordering of the keys is determined by Ord.hashOrd() (ie. Object#hasCode). + This is not safe and therefore this method is deprecated.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B> TreeMap<B,List<A>> groupBy(F<A,B> keyFunction,
+                                            Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        @Deprecated
+public final <B,C> TreeMap<B,List<C>> groupBy(F<A,B> keyFunction,
+                                                          F<A,C> valueFunction)
        +
        Deprecated. As of release 4.7, use groupBy(F, F, Ord)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + Ord.hashOrd() (ie. Object#hasCode). + This is not safe and therefore this method is deprecated.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,List<C>> groupBy(F<A,B> keyFunction,
+                                              F<A,C> valueFunction,
+                                              Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,C> groupBy(F<A,B> keyFunction,
+                                        F<A,C> valueFunction,
+                                        Monoid<C> monoid,
+                                        Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        monoid - A monoid, which defines the accumulator for the values and the zero value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        groupBy

        +
        public final <B,C,D> TreeMap<B,D> groupBy(F<A,B> keyFunction,
+                                          F<A,C> valueFunction,
+                                          D groupingIdentity,
+                                          F2<C,D,D> groupingAcc,
+                                          Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys.
        +
        valueFunction - The function to apply on each element.
        +
        groupingIdentity - The identity, or start value, for the grouping.
        +
        groupingAcc - The accumulator to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated result of matched and mapped + elements.
        +
        +
        • +
      + + + +
        +
      • +

        allEqual

        +
        public final boolean allEqual(Equal<A> eq)
        +
        Returns whether or not all elements in the list are equal according to the given equality test.
        +
        +
        Parameters:
        +
        eq - The equality test.
        +
        Returns:
        +
        Whether or not all elements in the list are equal according to the given equality test.
        +
        +
        • +
      + + + +
        +
      • +

        isPrefixOf

        +
        public final boolean isPrefixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        isSuffixOf

        +
        public final boolean isSuffixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        length_

        +
        public static <A> F<List<A>,java.lang.Integer> length_()
        +
        First-class length.
        +
        +
        Returns:
        +
        A function that gets the length of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximumOption

        +
        public final Option<A> maximumOption(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimumOption

        +
        public final Option<A> minimumOption(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this list.
        +
        +
        Returns:
        +
        An immutable collection of this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        list

        +
        @SafeVarargs
+public static <A> List<A> list(A... as)
        +
        Constructs a list from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct a list with.
        +
        Returns:
        +
        A list with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayList

        +
        @SafeVarargs
+public static <A> List<A> arrayList(A... as)
        +
        Constructs a list from the given elements.
        +
        • +
      + + + +
        +
      • +

        list

        +
        @Deprecated
+public static <A> List<A> list(java.lang.Iterable<A> i)
        +
        Deprecated. As of release 4.5, use iterableList(Iterable)
        +
        Constructs a list from the given Iterable.
        +
        • +
      + + + +
        +
      • +

        list

        +
        @Deprecated
+public static <A> List<A> list(java.util.Iterator<A> it)
        +
        Deprecated. As of release 4.5, use iteratorList(Iterator)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        fromIterator

        +
        public static <A> List<A> fromIterator(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> List<A> nil()
        +
        Returns an empty list.
        +
        +
        Returns:
        +
        An empty list.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<List<A>,List<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a list to produce a new list.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a list to produce a new list.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F2<A,List<A>,List<A>> cons_()
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,List<A>> cons(List<A> tail)
        +
        Returns a function that prepends a value to the given list.
        +
        +
        Parameters:
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        A function that prepends a value to the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons_

        +
        public static <A> F<List<A>,List<A>> cons_(A a)
        +
        Returns a function that prepends the given value to a list.
        +
        +
        Parameters:
        +
        a - The value to prepend to a list.
        +
        Returns:
        +
        A function that prepends the given value to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> List<A> cons(A head,
+                               List<A> tail)
        +
        Prepends the given head element to the given tail element to produce a new list.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        The list with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given list is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given list is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is not empty.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> List<A> join(List<List<A>> o)
        +
        Joins the given list of lists using a bind operation.
        +
        +
        Parameters:
        +
        o - The list of lists to join.
        +
        Returns:
        +
        A new list that is the join of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<List<List<A>>,List<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a list of lists using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> List<A> unfold(F<B,Option<P2<A,B>>> f,
+                                   B b)
        +
        Unfolds across the given function starting at the given value to produce a list.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new list that is a result of unfolding until the function does not produce a value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<List<A>,List<B>> unzip(List<P2<A,B>> xs)
        +
        Transforms a list of pairs into a list of first components and a list of second components.
        +
        +
        Parameters:
        +
        xs - The list of pairs to transform.sp
        +
        Returns:
        +
        A list of first components and a list of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        replicate

        +
        public static <A> List<A> replicate(int n,
+                                    A a)
        +
        Returns a list of the given value replicated the given number of times.
        +
        +
        Parameters:
        +
        n - The number of times to replicate the given value.
        +
        a - The value to replicate.
        +
        Returns:
        +
        A list of the given value replicated the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static List<java.lang.Integer> range(int from,
+                                            int to)
        +
        Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the list (inclusive).
        +
        to - The maximum value for the list (exclusive).
        +
        Returns:
        +
        A list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static List<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a list of characters from the given string. The inverse of this function is asString(List).
        +
        +
        Parameters:
        +
        s - The string to produce the list of characters from.
        +
        Returns:
        +
        A list of characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,List<java.lang.Character>> fromString()
        +
        A first-class fromString.
        +
        +
        Returns:
        +
        A first-class fromString.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(List<java.lang.Character> cs)
        +
        Returns a string from the given list of characters. The invers of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The list of characters to produce the string from.
        +
        Returns:
        +
        A string from the given list of characters.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static F<List<java.lang.Character>,java.lang.String> asString()
        +
        A first-class asString.
        +
        +
        Returns:
        +
        A first-class asString.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> List<A> single(A a)
        +
        Returns a list of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned list.
        +
        Returns:
        +
        A list of one element containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> List<A> iterateWhile(F<A,A> f,
+                                       F<A,java.lang.Boolean> p,
+                                       A a)
        +
        Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public static <A,B> Option<B> lookup(Equal<A> e,
+                                     List<P2<A,B>> x,
+                                     A a)
        +
        Returns an associated value with the given key in the list of pairs.
        +
        +
        Parameters:
        +
        e - The test for equality on keys.
        +
        x - The list of pairs to search.
        +
        a - The key value to find the associated value of.
        +
        Returns:
        +
        An associated value with the given key in the list of pairs.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>> bind_()
        +
        Provides a first-class version of bind()
        +
        +
        Returns:
        +
        The bind function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<List<A>,List<B>>> map_()
        +
        Provides a first-class version of map()
        +
        +
        Returns:
        +
        The map function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,List<A>> sequence_(List<F<B,A>> fs)
        +
        Turn a list of functions into a function returning a list.
        +
        +
        Parameters:
        +
        fs - The list of functions to sequence into a single function that returns a list.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given list to it + and returns a list of the results.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft

        +
        public static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>> foldLeft()
        +
        Provides a first-class version of foldLeft.
        +
        +
        Returns:
        +
        The left fold function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public static <A> F<java.lang.Integer,F<List<A>,List<A>>> take()
        +
        Provides a first-class version of take.
        +
        +
        Returns:
        +
        First-class version of take.
        +
        +
        • +
      + + + +
        +
      • +

        iterableList

        +
        public static <A> List<A> iterableList(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a list.
        +
        +
        Parameters:
        +
        i - The iterable to take to a list.
        +
        Returns:
        +
        A list from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorList

        +
        public static <A> List<A> iteratorList(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.listEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        Compute the hash code from this list as a function of the hash codes of its members. + Delegates to Hash.listHash, using the anyHash() rule, which uses the hash codes of the contents.
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        Returns:
        +
        the hash code for this list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        Obtain a string representation of this list using the toString implementations of the members. Uses Show.listShow with F2 argument and may + not be very performant.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        a String representation of the list
        +
        +
        • +
      + + + +
        +
      • +

        isSingle

        +
        public final boolean isSingle()
        +
        True if and only if the list has one element. Runs in constant time.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Natural.html b/javadoc/4.8.1/functionaljava/fj/data/Natural.html new file mode 100644 index 0000000..56ba1e8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Natural.html @@ -0,0 +1,930 @@ + + + + + +Natural (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Natural

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Number
      • +
    • +
        +
      • fj.data.Natural
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public final class Natural
+extends java.lang.Number
    +
    Represents a natural number (zero, one, two, etc.)
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fromBigInt

        +
        public static final F<java.math.BigInteger,Option<Natural>> fromBigInt
        +
        A function that returns the natural number equal to a given BigInteger
        +
        • +
      + + + +
        +
      • +

        ZERO

        +
        public static final Natural ZERO
        +
        The natural number zero
        +
        • +
      + + + +
        +
      • +

        ONE

        +
        public static final Natural ONE
        +
        The natural number one
        +
        • +
      + + + + + + + +
        +
      • +

        subtract

        +
        public static final F<Natural,F<Natural,Option<Natural>>> subtract
        +
        A function that subtracts its first argument from its second.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<Natural,F<Natural,Natural>> multiply
        +
        A function that multiplies a natural number by another.
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public static final F<Natural,F<Natural,Natural>> divide
        +
        A function that divides its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public static final F<Natural,F<Natural,Natural>> mod
        +
        A function that yields the remainder of division of its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public static final F<Natural,F<Natural,V2<Natural>>> divmod
        +
        A function that divides its second argument by its first, yielding both the quotient and the remainder.
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public static final F<Natural,java.math.BigInteger> bigIntegerValue
        +
        A function that returns the BigInteger value of a given Natural.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(java.math.BigInteger i)
        +
        Returns the natural number equal to the given BigInteger
        +
        +
        Parameters:
        +
        i - A given BigInteger
        +
        Returns:
        +
        An optional natural number, or none if the given BigInteger is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(long i)
        +
        Returns the natural number equal to the given long
        +
        +
        Parameters:
        +
        i - A given long
        +
        Returns:
        +
        An optional natural number, or none if the given long is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        succ

        +
        public Natural succ()
        +
        Return the successor of this natural number
        +
        +
        Returns:
        +
        the successor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        succ_

        +
        public static F<Natural,Natural> succ_()
        +
        First-class successor function.
        +
        +
        Returns:
        +
        A function that returns the successor of a given natural number.
        +
        +
        • +
      + + + +
        +
      • +

        pred

        +
        public Option<Natural> pred()
        +
        Return the predecessor of this natural number
        +
        +
        Returns:
        +
        the predecessor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        pred_

        +
        public static F<Natural,Option<Natural>> pred_()
        +
        First-class predecessor function.
        +
        +
        Returns:
        +
        A function that returns the predecessor of a given natural number, or None if it's zero.
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public Natural add(Natural n)
        +
        Add two natural numbers together.
        +
        +
        Parameters:
        +
        n - A natural number to add to this one.
        +
        Returns:
        +
        the sum of the two natural numbers.
        +
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public Option<Natural> subtract(Natural n)
        +
        Subtract a natural number from another.
        +
        +
        Parameters:
        +
        n - A natural number to subtract from this one.
        +
        Returns:
        +
        The difference between the two numbers, if this number is larger than the given one. Otherwise none.
        +
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public Natural multiply(Natural n)
        +
        Multiply a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to multiply by this one.
        +
        Returns:
        +
        The product of the two numbers.
        +
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public Natural divide(Natural n)
        +
        Divide a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient of this number and the highest number, less than or equal to the given number, + that divides this number.
        +
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public Natural mod(Natural n)
        +
        Take the remainder of a natural number division.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The remainder of division of this number by the given number.
        +
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public V2<Natural> divmod(Natural n)
        +
        Divide a natural number by another yielding both the quotient and the remainder.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient and the remainder, in that order.
        +
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public java.math.BigInteger bigIntegerValue()
        +
        Return the BigInteger value of this natural number.
        +
        +
        Returns:
        +
        the BigInteger value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        Return the long value of this natural number.
        +
        +
        Specified by:
        +
        longValue in class java.lang.Number
        +
        Returns:
        +
        the long value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        floatValue

        +
        public float floatValue()
        +
        Return the float value of this natural number.
        +
        +
        Specified by:
        +
        floatValue in class java.lang.Number
        +
        Returns:
        +
        the float value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        doubleValue

        +
        public double doubleValue()
        +
        Return the double value of this natural number.
        +
        +
        Specified by:
        +
        doubleValue in class java.lang.Number
        +
        Returns:
        +
        the double value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        intValue

        +
        public int intValue()
        +
        Return the int value of this natural number.
        +
        +
        Specified by:
        +
        intValue in class java.lang.Number
        +
        Returns:
        +
        the int value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(Stream<Natural> ns)
        +
        Sums a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(Stream<Natural> ns)
        +
        Takes the product of a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(List<Natural> ns)
        +
        Sums a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(List<Natural> ns)
        +
        Takes the product of a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object that)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/NonEmptyList.html b/javadoc/4.8.1/functionaljava/fj/data/NonEmptyList.html new file mode 100644 index 0000000..6e6e984 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/NonEmptyList.html @@ -0,0 +1,1041 @@ + + + + + +NonEmptyList (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class NonEmptyList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.NonEmptyList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class NonEmptyList<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list with total head and tail.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      NonEmptyList<A>append(List<A> as) +
      Appends the given list to this list.
      +
      NonEmptyList<A>append(NonEmptyList<A> as) +
      Appends the given list to this list.
      +
      <B> NonEmptyList<B>bind(F<A,NonEmptyList<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      NonEmptyList<A>cons(A a) +
      Prepend the given value to this list.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldRight1(F<A,F<A,A>> f) +
      Performs a right-fold reduction across this list.
      +
      AfoldRight1(F2<A,A,A> f) +
      Performs a right-fold reduction across this list.
      +
      static <A> Option<NonEmptyList<A>>fromList(List<A> as) +
      Returns a potential non-empty list from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this linked list.
      +
      NonEmptyList<A>intersperse(A a) +
      Intersperses the given argument between each element of this non empty list.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this non-empty list.
      +
      static <A> NonEmptyList<A>join(NonEmptyList<NonEmptyList<A>> o) +
      Concatenate (join) a non empty list of non empty lists.
      +
      intlength() +
      The length of this list.
      +
      <B> NonEmptyList<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B> NonEmptyList<B>mapTails(F<NonEmptyList<A>,B> f) +
      Maps the given function across the tails of this list (comonad pattern).
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this non empty list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this non empty list according to the given ordering.
      +
      static <A> F<A,NonEmptyList<A>>nel() +
      Returns a function that puts an element into a non-empty list.
      +
      static <A> NonEmptyList<A>nel(A head, + A... tail) +
      Constructs a non empty list from the given elements.
      +
      static <A> NonEmptyList<A>nel(A head, + List<A> tail) +
      Return a non-empty list with the given head and tail.
      +
      NonEmptyList<A>reverse() +
      Reverse this non empty list in constant stack space.
      +
      NonEmptyList<A>snoc(A a) +
      Appends (snoc) the given element to this non empty list to produce a new non empty list.
      +
      NonEmptyList<A>sort(Ord<A> o) +
      Sorts this non empty list using the given order over elements using a merge sort algorithm.
      +
      NonEmptyList<NonEmptyList<A>>sublists() +
      Returns a NonEmptyList of the sublists of this list.
      +
      List<A>tail() +
      This list without the first element.
      +
      NonEmptyList<NonEmptyList<A>>tails() +
      Returns a NonEmptyList of the tails of this list.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this non-empty list.
      +
      static <A> F<NonEmptyList<A>,List<A>>toList_() +
      Returns a function that takes a non-empty list to a list.
      +
      List<A>toList() +
      Returns a List projection of this list.
      +
      java.lang.StringtoString() 
      static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>>unzip(NonEmptyList<P2<A,B>> xs) +
      Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
      +
      <B> NonEmptyList<P2<A,B>>zip(NonEmptyList<B> bs) +
      Zips this non empty list with the given non empty list to produce a list of pairs.
      +
      NonEmptyList<P2<A,java.lang.Integer>>zipIndex() +
      Zips this non empty list with the index of its element as a pair.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this non-empty list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this linked list.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public List<A> tail()
        +
        This list without the first element.
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public NonEmptyList<A> cons(A a)
        +
        Prepend the given value to this list.
        +
        +
        Parameters:
        +
        a - The value to prepend.
        +
        Returns:
        +
        A non-empty list with an extra element.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public NonEmptyList<A> snoc(A a)
        +
        Appends (snoc) the given element to this non empty list to produce a new non empty list. O(n).
        +
        +
        Parameters:
        +
        a - The element to append to this non empty list.
        +
        Returns:
        +
        A new non empty list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(NonEmptyList<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F2<A,A,A> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> NonEmptyList<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> NonEmptyList<B> bind(F<A,NonEmptyList<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sublists

        +
        public NonEmptyList<NonEmptyList<A>> sublists()
        +
        Returns a NonEmptyList of the sublists of this list.
        +
        +
        Returns:
        +
        a NonEmptyList of the sublists of this list.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public NonEmptyList<NonEmptyList<A>> tails()
        +
        Returns a NonEmptyList of the tails of this list. A list is considered a tail of itself for the purpose of this + function (Comonad pattern).
        +
        +
        Returns:
        +
        A NonEmptyList of the tails of this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapTails

        +
        public <B> NonEmptyList<B> mapTails(F<NonEmptyList<A>,B> f)
        +
        Maps the given function across the tails of this list (comonad pattern).
        +
        +
        Parameters:
        +
        f - The function to map across the tails of this list.
        +
        Returns:
        +
        The results of applying the given function to the tails of this list, as a NonEmptyList.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public NonEmptyList<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this non empty list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this non empty list.
        +
        Returns:
        +
        A non empty list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public NonEmptyList<A> reverse()
        +
        Reverse this non empty list in constant stack space.
        +
        +
        Returns:
        +
        A new non empty list with the elements in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public NonEmptyList<A> sort(Ord<A> o)
        +
        Sorts this non empty list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this non empty list.
        +
        Returns:
        +
        A sorted non empty list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> NonEmptyList<P2<A,B>> zip(NonEmptyList<B> bs)
        +
        Zips this non empty list with the given non empty list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public NonEmptyList<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this non empty list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new non empty list with the same length as this list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>> unzip(NonEmptyList<P2<A,B>> xs)
        +
        Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
        +
        +
        Parameters:
        +
        xs - The non empty list of pairs to transform.
        +
        Returns:
        +
        A non empty list of first components and a non empty list of second components.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a List projection of this list.
        +
        +
        Returns:
        +
        A List projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this non-empty list.
        +
        +
        Returns:
        +
        An immutable collection of this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toList_

        +
        public static <A> F<NonEmptyList<A>,List<A>> toList_()
        +
        Returns a function that takes a non-empty list to a list.
        +
        +
        Returns:
        +
        A function that takes a non-empty list to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        public static <A> NonEmptyList<A> nel(A head,
+                                      List<A> tail)
        +
        Return a non-empty list with the given head and tail.
        +
        +
        Parameters:
        +
        head - The first element of the new list.
        +
        tail - The remaining elements of the new list.
        +
        Returns:
        +
        A non-empty list with the given head and tail.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        @SafeVarargs
+public static <A> NonEmptyList<A> nel(A head,
+                                                   A... tail)
        +
        Constructs a non empty list from the given elements.
        +
        +
        Parameters:
        +
        head - The first in the non-empty list.
        +
        tail - The elements to construct a list's tail with.
        +
        Returns:
        +
        A non-empty list with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        nel

        +
        public static <A> F<A,NonEmptyList<A>> nel()
        +
        Returns a function that puts an element into a non-empty list.
        +
        +
        Returns:
        +
        A function that puts an element into a non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> Option<NonEmptyList<A>> fromList(List<A> as)
        +
        Returns a potential non-empty list from the given list. A non-value is returned if the given list is empty.
        +
        +
        Parameters:
        +
        as - The list to construct a potential non-empty list with.
        +
        Returns:
        +
        A potential non-empty list from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> NonEmptyList<A> join(NonEmptyList<NonEmptyList<A>> o)
        +
        Concatenate (join) a non empty list of non empty lists.
        +
        +
        Parameters:
        +
        o - The non empty list of non empty lists to join.
        +
        Returns:
        +
        A new non empty list that is the concatenation of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.nonEmptyListEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Option.Optic.html b/javadoc/4.8.1/functionaljava/fj/data/Option.Optic.html new file mode 100644 index 0000000..284eb9c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Option.Optic.html @@ -0,0 +1,274 @@ + + + + + +Option.Optic (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Option.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Option<A>
    +
    +
    +
    +
    public static final class Option.Optic
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Prism<Option<A>,Unit>none() +
      None prism
      +
      static <A,B> PPrism<Option<A>,Option<B>,A,B>pSome() +
      Polymorphic Some prism
      +
      static <A> Prism<Option<A>,A>some() +
      Monomorphic Some prism
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        none

        +
        public static <A> Prism<Option<A>,Unit> none()
        +
        None prism
        +
        • +
      + + + +
        +
      • +

        pSome

        +
        public static <A,B> PPrism<Option<A>,Option<B>,A,B> pSome()
        +
        Polymorphic Some prism
        +
        • +
      + + + +
        +
      • +

        some

        +
        public static <A> Prism<Option<A>,A> some()
        +
        Monomorphic Some prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Option.html b/javadoc/4.8.1/functionaljava/fj/data/Option.html new file mode 100644 index 0000000..1612d62 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Option.html @@ -0,0 +1,2227 @@ + + + + + +Option (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Option<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Option<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    An optional value that may be none (no value) or some (a value). This type is a replacement for + the use of null with better type checks.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Option.Optic 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,Option<java.lang.Byte>>parseByte +
      A function that parses a string to a byte.
      +
      static F<java.lang.String,Option<java.lang.Double>>parseDouble +
      A function that parses a string to a double.
      +
      static F<java.lang.String,Option<java.lang.Float>>parseFloat +
      A function that parses a string to a float.
      +
      static F<java.lang.String,Option<java.lang.Integer>>parseInt +
      A function that parses a string to an integer.
      +
      static F<java.lang.String,Option<java.lang.Long>>parseLong +
      A function that parses a string to a long.
      +
      static F<java.lang.String,Option<java.lang.Short>>parseShort +
      A function that parses a string to a short.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Option<B>apply(Option<F<A,B>> of) +
      Performs function application within an optional value (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this optional value.
      +
      static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>>bind() +
      First-class bind function.
      +
      <B> Option<B>bind(F<A,Option<B>> f) +
      Binds the given function across the element of this optional value with a final join.
      +
      <B,C> Option<C>bind(Option<B> ob, + F<A,F<B,C>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D> Option<D>bind(Option<B> ob, + Option<C> oc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E> Option<E>bind(Option<B> ob, + Option<C> oc, + Option<D> od, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$>
      Option<F$>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G>
      Option<G>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H>
      Option<H>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H,I>
      Option<I>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B> Option<P2<A,B>>bindProduct(Option<B> ob) 
      <B,C> Option<P3<A,B,C>>bindProduct(Option<B> ob, + Option<C> oc) 
      <B,C,D> Option<P4<A,B,C,D>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od) 
      <B,C,D,E> Option<P5<A,B,C,D,E>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe) 
      <B,C,D,E,F$>
      Option<P6<A,B,C,D,E,F$>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of) 
      <B,C,D,E,F$,G>
      Option<P7<A,B,C,D,E,F$,G>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og) 
      <B,C,D,E,F$,G,H>
      Option<P8<A,B,C,D,E,F$,G,H>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
      +
      Option<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for the value of this optional value.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for the value of this optional value.
      +
      static <T> F<T,Option<T>>fromNull() +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <T> Option<T>fromNull(T t) +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <A> F<Option<A>,A>fromSome() +
      Returns a function that takes an optional value to a value or errors if there is no value.
      +
      static F<java.lang.String,Option<java.lang.String>>fromString() +
      Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
      +
      static Option<java.lang.String>fromString(java.lang.String s) +
      Returns an optional non-empty string, or no value if the given string is empty.
      +
      inthashCode() 
      static <A> F2<F<A,java.lang.Boolean>,A,Option<A>>iif() +
      First-class version of the iif function.
      +
      static <A> Option<A>iif(boolean p, + A a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(boolean p, + F0<A> a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(F<A,java.lang.Boolean> f, + A a) +
      Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
      +
      static <A> F<Option<A>,java.lang.Boolean>isNone_() +
      A first-class version of the isNone method.
      +
      booleanisNone() +
      Returns false if this optional value has a value, true otherwise.
      +
      static <A> F<Option<A>,java.lang.Boolean>isSome_() +
      A first-class version of the isSome method.
      +
      booleanisSome() +
      Returns true if this optional value has a value, false otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this optional value.
      +
      static <A> F<Option<Option<A>>,Option<A>>join() +
      First-class join function.
      +
      static <A> Option<A>join(Option<Option<A>> o) +
      Joins the given optional value of optional value using a bind operation.
      +
      intlength() +
      Returns the length of this optional value; 1 if there is a value, 0 otherwise.
      +
      static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 so that it operates over options.
      +
      <B,C> Option<C>liftM2(Option<B> ob, + F2<A,B,C> f) +
      Lift the function of arity-2 through options.
      +
      static <A,B> F<F<A,B>,F<Option<A>,Option<B>>>map() +
      A first-class map function.
      +
      <B> Option<B>map(F<A,B> f) +
      Maps the given function across this optional value.
      +
      static <T> F<T,Option<T>>none_() 
      static <T> Option<T>none() +
      Constructs an optional value that has no value.
      +
      static <A,B> F<Option<A>,B>option_(B none, + F<A,B> some) +
      First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
      +
      <B> Boption(B b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      <B> Boption(F0<B> b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      Option<A>orElse(F0<Option<A>> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      Option<A>orElse(Option<A> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      AorSome(A a) +
      Returns the value of this optional value or the given argument.
      +
      AorSome(F0<A> a) +
      Returns the value of this optional value or the given argument.
      +
      static <A> Option<List<A>>sequence(List<Option<A>> a) +
      Sequence through the option monad.
      +
      <B> Option<B>sequence(Option<B> o) +
      Performs a bind across the optional value, but ignores the element value in the function.
      +
      static <T> F<T,Option<T>>some_() 
      abstract Asome() +
      Returns the value from this optional value, or fails if there is no value.
      +
      static <T> Option<T>some(T t) +
      Constructs an optional value that has a value of the given argument.
      +
      static <A> List<A>somes(List<Option<A>> as) +
      Returns all the values in the given list.
      +
      static <A> Stream<A>somes(Stream<Option<A>> as) +
      Returns all the values in the given stream.
      +
      Array<A>toArray() +
      Returns an array projection of this optional value.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns an array projection of this optional value.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this optional value.
      +
      static <A,X> F<Option<A>,F<X,Either<X,A>>>toEither() +
      A first-class version of the toEither method.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      <X> Either<X,A>toEither(X x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      List<A>toList() +
      Returns a list projection of this optional value.
      +
      AtoNull() +
      Returns the value from this optional value, or if there is no value, returns null.
      +
      Stream<A>toStream() +
      Returns a stream projection of this optional value.
      +
      java.lang.StringtoString() 
      <X> Validation<X,A>toValidation(X x) 
      <L,B> Either<L,Option<B>>traverseEither(F<A,Either<L,B>> f) 
      <B> IO<Option<B>>traverseIO(F<A,IO<B>> f) 
      <B> List<Option<B>>traverseList(F<A,List<B>> f) 
      <B> Option<Option<B>>traverseOption(F<A,Option<B>> f) 
      <B> P1<Option<B>>traverseP1(F<A,P1<B>> f) 
      <B> Seq<Option<B>>traverseSeq(F<A,Seq<B>> f) 
      <B> F2<Ord<B>,F<A,Set<B>>,Set<Option<B>>>traverseSet() 
      <B> Set<Option<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) 
      <B> Stream<Option<B>>traverseStream(F<A,Stream<B>> f) 
      <E,B> Validation<E,Option<B>>traverseValidation(F<A,Validation<E,B>> f) 
      AvalueE(F0<java.lang.String> message) +
      Returns the value of this optional value or fails with the given message.
      +
      AvalueE(java.lang.String message) +
      Returns the value of this optional value or fails with the given message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Option<java.lang.Byte>> parseByte
        +
        A function that parses a string to a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Option<java.lang.Double>> parseDouble
        +
        A function that parses a string to a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Option<java.lang.Float>> parseFloat
        +
        A function that parses a string to a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Option<java.lang.Integer>> parseInt
        +
        A function that parses a string to an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Option<java.lang.Long>> parseLong
        +
        A function that parses a string to a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Option<java.lang.Short>> parseShort
        +
        A function that parses a string to a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this optional value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some

        +
        public abstract A some()
        +
        Returns the value from this optional value, or fails if there is no value.
        +
        +
        Returns:
        +
        The value from this optional value, or fails if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        isSome

        +
        public final boolean isSome()
        +
        Returns true if this optional value has a value, false otherwise.
        +
        +
        Returns:
        +
        true if this optional value has a value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNone

        +
        public final boolean isNone()
        +
        Returns false if this optional value has a value, true otherwise.
        +
        +
        Returns:
        +
        false if this optional value has a value, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSome_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isSome_()
        +
        A first-class version of the isSome method.
        +
        +
        Returns:
        +
        A function that returns true if a given optional value has a value, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isNone_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isNone_()
        +
        A first-class version of the isNone method.
        +
        +
        Returns:
        +
        A function that returns false if a given optional value has a value, otherwise true.
        +
        +
        • +
      + + + + + +
        +
      • +

        option

        +
        public final <B> B option(B b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public final <B> B option(F0<B> b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        Returns the length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        Returns:
        +
        The length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        orSome

        +
        public final A orSome(F0<A> a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSome

        +
        public final A orSome(A a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(F0<java.lang.String> message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(java.lang.String message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Option<B> map(F<A,B> f)
        +
        Maps the given function across this optional value.
        +
        +
        Parameters:
        +
        f - The function to map across this optional value.
        +
        Returns:
        +
        A new optional value after the given function has been applied to its element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Option<A>,Option<B>>> map()
        +
        A first-class map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Option<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new optional value whose value matches the given predicate if it has one.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Option<B> bind(F<A,Option<B>> f)
        +
        Binds the given function across the element of this optional value with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this optional value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Option<C> bind(Option<B> ob,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Option<D> bind(Option<B> ob,
+                                    Option<C> oc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Option<E> bind(Option<B> ob,
+                                      Option<C> oc,
+                                      Option<D> od,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Option<F$> bind(Option<B> ob,
+                                          Option<C> oc,
+                                          Option<D> od,
+                                          Option<E> oe,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Option<G> bind(Option<B> ob,
+                                           Option<C> oc,
+                                           Option<D> od,
+                                           Option<E> oe,
+                                           Option<F$> of,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Option<H> bind(Option<B> ob,
+                                             Option<C> oc,
+                                             Option<D> od,
+                                             Option<E> oe,
+                                             Option<F$> of,
+                                             Option<G> og,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Option<I> bind(Option<B> ob,
+                                               Option<C> oc,
+                                               Option<D> od,
+                                               Option<E> oe,
+                                               Option<F$> of,
+                                               Option<G> og,
+                                               Option<H> oh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        oh - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bindProduct

        +
        public final <B> Option<P2<A,B>> bindProduct(Option<B> ob)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequence

        +
        public final <B> Option<B> sequence(Option<B> o)
        +
        Performs a bind across the optional value, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        o - The optional value to apply in the final join.
        +
        Returns:
        +
        A new optional value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <L,B> Either<L,Option<B>> traverseEither(F<A,Either<L,B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<Option<B>> traverseIO(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<Option<B>> traverseList(F<A,List<B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<Option<B>> traverseP1(F<A,P1<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public final <B> Seq<Option<B>> traverseSeq(F<A,Seq<B>> f)
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public final <B> Set<Option<B>> traverseSet(Ord<B> ord,
+                                            F<A,Set<B>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        apply

        +
        public final <B> Option<B> apply(Option<F<A,B>> of)
        +
        Performs function application within an optional value (applicative functor pattern).
        +
        +
        Parameters:
        +
        of - The optional value of functions to apply.
        +
        Returns:
        +
        A new optional value after applying the given optional value of functions through this + optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(F0<Option<A>> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(Option<A> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(X x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toValidation

        +
        public final <X> Validation<X,A> toValidation(X x)
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public static <A,X> F<Option<A>,F<X,Either<X,A>>> toEither()
        +
        A first-class version of the toEither method.
        +
        +
        Returns:
        +
        A function that returns an either projection of a given optional value, given a value to + return in left.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this optional value.
        +
        +
        Returns:
        +
        A list projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this optional value.
        +
        +
        Returns:
        +
        A stream projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns an array projection of this optional value.
        +
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns an array projection of this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toNull

        +
        public final A toNull()
        +
        Returns the value from this optional value, or if there is no value, returns null. + This is intended for interfacing with APIs that expect a null for non-existence.
        +
        +
        Returns:
        +
        This optional value or null if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this optional value.
        +
        +
        Returns:
        +
        An immutable collection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some_

        +
        public static <T> F<T,Option<T>> some_()
        +
        • +
      + + + + + +
        +
      • +

        some

        +
        public static <T> Option<T> some(T t)
        +
        Constructs an optional value that has a value of the given argument.
        +
        +
        Parameters:
        +
        t - The value for the returned optional value.
        +
        Returns:
        +
        An optional value that has a value of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        none_

        +
        public static <T> F<T,Option<T>> none_()
        +
        • +
      + + + +
        +
      • +

        none

        +
        public static <T> Option<T> none()
        +
        Constructs an optional value that has no value.
        +
        +
        Returns:
        +
        An optional value that has no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromNull

        +
        public static <T> Option<T> fromNull(T t)
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Parameters:
        +
        t - The unsafe nullable value.
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + +
        +
      • +

        fromNull

        +
        public static <T> F<T,Option<T>> fromNull()
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + + + +
        +
      • +

        option_

        +
        public static final <A,B> F<Option<A>,B> option_(B none,
+                                                 F<A,B> some)
        +
        First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
        +
        +
        Parameters:
        +
        none - The value to return if this optional value has no value.
        +
        some - The function to apply to the value of this optional value.
        +
        Returns:
        +
        the reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Option<A> join(Option<Option<A>> o)
        +
        Joins the given optional value of optional value using a bind operation.
        +
        +
        Parameters:
        +
        o - The optional value of optional value to join.
        +
        Returns:
        +
        A new optional value that is the join of the given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Option<List<A>> sequence(List<Option<A>> a)
        +
        Sequence through the option monad.
        +
        +
        Parameters:
        +
        a - The list of option to sequence.
        +
        Returns:
        +
        The option of list after sequencing.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(F<A,java.lang.Boolean> f,
+                                A a)
        +
        Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        Parameters:
        +
        f - The predicate to test on the given argument.
        +
        a - The argument to test the predicate on and potentially use as the value of the returned + optional value.
        +
        Returns:
        +
        an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                F0<A> a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                A a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> F2<F<A,java.lang.Boolean>,A,Option<A>> iif()
        +
        First-class version of the iif function.
        +
        +
        Returns:
        +
        a function that returns an optional value that has a value of the given argument, if the given predicate + holds on that argument, or no value otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> List<A> somes(List<Option<A>> as)
        +
        Returns all the values in the given list.
        +
        +
        Parameters:
        +
        as - The list of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> Stream<A> somes(Stream<Option<A>> as)
        +
        Returns all the values in the given stream.
        +
        +
        Parameters:
        +
        as - The stream of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Option<java.lang.String> fromString(java.lang.String s)
        +
        Returns an optional non-empty string, or no value if the given string is empty.
        +
        +
        Parameters:
        +
        s - A string to turn into an optional non-empty string.
        +
        Returns:
        +
        an optional non-empty string, or no value if the given string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.String>> fromString()
        +
        Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        Returns:
        +
        a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        fromSome

        +
        public static <A> F<Option<A>,A> fromSome()
        +
        Returns a function that takes an optional value to a value or errors if there is no value.
        +
        +
        Returns:
        +
        A function that takes an optional value to a value or errors if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 so that it operates over options.
        +
        +
        Parameters:
        +
        f - A function to promote.
        +
        Returns:
        +
        The given function promoted to operate on options.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> Option<C> liftM2(Option<B> ob,
+                                    F2<A,B,C> f)
        +
        Lift the function of arity-2 through options.
        +
        +
        Parameters:
        +
        f - A function to lift.
        +
        Returns:
        +
        An optional result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>> bind()
        +
        First-class bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across an option with a final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Option<Option<A>>,Option<A>> join()
        +
        First-class join function.
        +
        +
        Returns:
        +
        A function that joins an Option of an Option to make a single Option.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/PriorityQueue.html b/javadoc/4.8.1/functionaljava/fj/data/PriorityQueue.html new file mode 100644 index 0000000..c9c4b03 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/PriorityQueue.html @@ -0,0 +1,646 @@ + + + + + +PriorityQueue (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class PriorityQueue<K,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.PriorityQueue<K,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PriorityQueue<K,A>
+extends java.lang.Object
    +
    A priority queue implementation backed by a + FingerTree. The finger tree nodes are + annotated with type K, are combined using a monoid of K and both the + key and value are stored in the leaf. Priorities of the same value + are returned FIFO (first in, first out). + + Created by MarkPerry on 31 May 16.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        priorityQueue

        +
        public static <K,A> PriorityQueue<K,A> priorityQueue(Equal<K> e,
+                                                     FingerTree<K,P2<K,A>> ft)
        +
        Creates a priority queue from a finger tree.
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <K,A> PriorityQueue<K,A> empty(Monoid<K> m,
+                                             Equal<K> e)
        +
        Creates an empty priority queue.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations.
        +
        e - A value to compare key equality.
        +
        +
        • +
      + + + +
        +
      • +

        emptyInt

        +
        public static <A> PriorityQueue<java.lang.Integer,A> emptyInt()
        +
        An empty priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> PriorityQueue<K,B> map(F<A,B> f)
        +
        Maps the values in each node with function f.
        +
        • +
      + + + +
        +
      • +

        filterValues

        +
        public PriorityQueue<K,A> filterValues(F<A,java.lang.Boolean> f)
        +
        Filters nodes based on the value inside each node.
        +
        • +
      + + + +
        +
      • +

        filterKeys

        +
        public PriorityQueue<K,A> filterKeys(F<K,java.lang.Boolean> f)
        +
        Filters the nodes based on the annotation of each node.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Is the tree empty?
        +
        • +
      + + + +
        +
      • +

        top

        +
        public Option<P2<K,A>> top()
        +
        If the tree is not empty, returns the node with highest priority otherwise returns nothing.
        +
        • +
      + + + +
        +
      • +

        topN

        +
        public List<P2<K,A>> topN()
        +
        Returns all the elements of the queue with the highest (same) priority.
        +
        • +
      + + + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(K k,
+                                  A a)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(List<P2<K,A>> list)
        +
        Adds nodes using the list of products with priority k and value a. This operation takes O(list.length()).
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Does the priority k exist already?
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(java.lang.Iterable<P2<K,A>> it)
        +
        Adds nodes using the iterable of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(P2<K,A> p)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue()
        +
        Removes the node with the highest priority.
        +
        • +
      + + + +
        +
      • +

        topDequeue

        +
        public P2<Option<P2<K,A>>,PriorityQueue<K,A>> topDequeue()
        +
        Returns a tuple of the node with the highest priority and the rest of the priority queue.
        +
        • +
      + + + + + +
        +
      • +

        unqueue

        +
        public <B> B unqueue(B empty,
+                     F2<P2<K,A>,PriorityQueue<K,A>,B> topDequeue)
        +
        Performs a reduction on this priority queue using the given arguments.
        +
        +
        Parameters:
        +
        empty - The value to return if this queue is empty.
        +
        topDequeue - The function to apply to the top priority element and the tail of the queue (without its top element).
        +
        Returns:
        +
        A reduction on this queue.
        +
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue(int n)
        +
        Removes the top n elements with the highest priority.
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(Ord<K> ok,
+                          K k)
        +
        Does the top of the queue have lower priority than k?
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(Ord<K> ok,
+                             K k)
        +
        • +
      + + + + + +
        +
      • +

        isEqual

        +
        public boolean isEqual(Ord<K> ok,
+                       K k)
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,A>> toStream()
        +
        Returns a stream of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,A>> toList()
        +
        Returns a list of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Reader.html b/javadoc/4.8.1/functionaljava/fj/data/Reader.html new file mode 100644 index 0000000..5881545 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Reader.html @@ -0,0 +1,366 @@ + + + + + +Reader (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Reader<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Reader<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Reader<A,B>
+extends java.lang.Object
    +
    The Reader monad (also called the function monad, so equivalent to the idea of F). + Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Reader

        +
        public Reader(F<A,B> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFunction

        +
        public final F<A,B> getFunction()
        +
        • +
      + + + +
        +
      • +

        unit

        +
        public static <A,B> Reader<A,B> unit(F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> Reader<A,B> constant(B b)
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        public final B f(A a)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <C> Reader<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> Reader<A,C> andThen(F<B,C> f)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/SafeIO.html b/javadoc/4.8.1/functionaljava/fj/data/SafeIO.html new file mode 100644 index 0000000..946c792 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/SafeIO.html @@ -0,0 +1,229 @@ + + + + + +SafeIO (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface SafeIO<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IO<A>
    +
    +
    +
    +
    public interface SafeIO<A>
+extends IO<A>
    +
    Created by MarkPerry on 3/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
        +
        +
        Specified by:
        +
        run in interface IO<A>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Seq.html b/javadoc/4.8.1/functionaljava/fj/data/Seq.html new file mode 100644 index 0000000..4aa8bf7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Seq.html @@ -0,0 +1,1011 @@ + + + + + +Seq (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Seq<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Seq<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Seq<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an immutable finite sequence, implemented as a finger tree. This structure gives O(1) access to + the head and tail, as well as O(log n) random access and concatenation of sequences.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Seq<A>append(Seq<A> as) +
      Appends the given sequence to this sequence.
      +
      static <A> Seq<A>arraySeq(A... as) +
      Constructs a sequence from the array.
      +
      Seq<A>cons(A a) +
      Inserts the given element at the front of this sequence.
      +
      Seq<A>delete(int i) +
      Delete the element at the given index.
      +
      Seq<A>drop(int n) +
      Drops the given number of elements from the head of this sequence if they are available.
      +
      static <A> Seq<A>empty() +
      The empty sequence.
      +
      booleanequals(java.lang.Object other) 
      Seq<A>filter(F<A,java.lang.Boolean> f) 
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      static <A> Seq<A>fromJavaList(java.util.List<A> list) +
      Constructs a sequence from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this sequence.
      +
      Option<A>headOption() 
      Aindex(int i) +
      Returns the element at the given index.
      +
      Seq<A>init() +
      The sequence without the last element.
      +
      Seq<A>insert(int index, + A a) +
      Inserts the element at the given index.
      +
      booleanisEmpty() +
      Checks if this is the empty sequence.
      +
      booleanisNotEmpty() +
      Checks if this sequence is not empty.
      +
      static <A> Seq<A>iterableSeq(java.lang.Iterable<A> i) +
      Constructs a sequence from the iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this seq.
      +
      static <A> Seq<A>iteratorSeq(java.util.Iterator<A> i) +
      Constructs a sequence from the iterator.
      +
      Alast() +
      The last element of this sequence.
      +
      intlength() +
      Returns the number of elements in this sequence.
      +
      static <A> Seq<A>listSeq(List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSeq(java.lang.Iterable<A>)
      +
      +
      <B> Seq<B>map(F<A,B> f) 
      static <A> Seq<A>seq(A... as) +
      Constructs a sequence from the given elements.
      +
      static <A> Seq<A>seq(List<A> list) +
      Deprecated.  +
      As of release 4.5, use listSeq(List)
      +
      +
      static <A> Seq<A>single(A a) +
      A singleton sequence.
      +
      Seq<A>snoc(A a) +
      Inserts the given element at the end of this sequence.
      +
      P2<Seq<A>,Seq<A>>split(int i) +
      Splits this sequence into a pair of sequences at the given position.
      +
      Seq<A>tail() +
      The sequence without the first element.
      +
      Seq<A>take(int n) +
      Takes the given number of elements from the head of this sequence if they are available.
      +
      java.util.List<A>toJavaList() +
      Converts the sequence to a java.util.List
      +
      List<A>toList() +
      Converts this sequence to a List
      +
      Stream<A>toStream() +
      Converts this sequence to a Stream
      +
      java.lang.StringtoString() 
      Seq<A>update(int i, + A a) +
      Replace the element at the given index with the supplied value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <A> Seq<A> empty()
        +
        The empty sequence.
        +
        +
        Returns:
        +
        A sequence with no elements.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Seq<A> single(A a)
        +
        A singleton sequence.
        +
        +
        Parameters:
        +
        a - The single element in the sequence.
        +
        Returns:
        +
        A new sequence with the given element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        seq

        +
        @SafeVarargs
+public static <A> Seq<A> seq(A... as)
        +
        Constructs a sequence from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to create the sequence from.
        +
        Returns:
        +
        A sequence with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        seq

        +
        @Deprecated
+public static <A> Seq<A> seq(List<A> list)
        +
        Deprecated. As of release 4.5, use listSeq(List)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the given elements in the list.
        +
        +
        • +
      + + + +
        +
      • +

        listSeq

        +
        @Deprecated
+public static <A> Seq<A> listSeq(List<A> list)
        +
        Deprecated. As of release 4.5, use iterableSeq(java.lang.Iterable<A>)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSeq

        +
        public static <A> Seq<A> iterableSeq(java.lang.Iterable<A> i)
        +
        Constructs a sequence from the iterable.
        +
        +
        Parameters:
        +
        i - The iterable to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSeq

        +
        public static <A> Seq<A> iteratorSeq(java.util.Iterator<A> i)
        +
        Constructs a sequence from the iterator.
        +
        +
        Parameters:
        +
        i - The iterator to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySeq

        +
        @SafeVarargs
+public static <A> Seq<A> arraySeq(A... as)
        +
        Constructs a sequence from the array.
        +
        • +
      + + + +
        +
      • +

        fromJavaList

        +
        public static <A> Seq<A> fromJavaList(java.util.List<A> list)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public Seq<A> cons(A a)
        +
        Inserts the given element at the front of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the front of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public Seq<A> snoc(A a)
        +
        Inserts the given element at the end of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the end of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public Option<A> headOption()
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        The last element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public Seq<A> tail()
        +
        The sequence without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public Seq<A> init()
        +
        The sequence without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Converts this sequence to a Stream
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Converts this sequence to a List
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the sequence to a java.util.List
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this seq. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this seq.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Seq<A> append(Seq<A> as)
        +
        Appends the given sequence to this sequence.
        +
        +
        Parameters:
        +
        as - A sequence to append to this one.
        +
        Returns:
        +
        A new sequence with the given sequence appended to this one.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this is the empty sequence.
        +
        +
        Returns:
        +
        True if this sequence is empty, otherwise false.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public Seq<A> insert(int index,
+                     A a)
        +
        Inserts the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        index - The index of the element to return.
        +
        Returns:
        +
        The sequence with the element inserted at the given index, + or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Checks if this sequence is not empty.
        +
        +
        Returns:
        +
        True if this sequence is not empty, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in this sequence.
        +
        +
        Returns:
        +
        the number of elements in this sequence.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public P2<Seq<A>,Seq<A>> split(int i)
        +
        Splits this sequence into a pair of sequences at the given position. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subsequence containing elements with indices less than i + and the subsequence containing elements with indices greater than or equal to i.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public A index(int i)
        +
        Returns the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to return.
        +
        Returns:
        +
        The element at the given index, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public Seq<A> update(int i,
+                     A a)
        +
        Replace the element at the given index with the supplied value. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        a - The new value.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Seq<A> delete(int i)
        +
        Delete the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public Seq<A> take(int n)
        +
        Takes the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The maximum number of elements to take from this sequence.
        +
        Returns:
        +
        A sequence consisting only of the first n elements of this sequence, or else the whole sequence, + if it has less than n elements.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public Seq<A> drop(int n)
        +
        Drops the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The number of elements to drop from this sequence.
        +
        Returns:
        +
        A sequence consisting of all elements of this sequence except the first n ones, or else the empty sequence, + if this sequence has less than n elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B z)
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Seq<A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Seq<B> map(F<A,B> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Set.html b/javadoc/4.8.1/functionaljava/fj/data/Set.html new file mode 100644 index 0000000..3ec91d9 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Set.html @@ -0,0 +1,1370 @@ + + + + + +Set (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Set<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Set<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Set<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable set, implemented as a red/black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <A> Set<A>arraySet(Ord<A> o, + A... as) +
      Return the elements of the given iterator as a set.
      +
      <B> Set<B>bind(Ord<B> o, + F<A,Set<B>> f) +
      Binds the given function across this set.
      +
      F<A,F<Set<A>,Set<A>>>delete() +
      First-class deletion function.
      +
      Set<A>delete(A a) +
      Deletes the given element from this set.
      +
      static <A> Set<A>empty(Ord<A> ord) +
      The empty set.
      +
      booleanequals(java.lang.Object other) 
      Set<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this Set using the given monoid.
      +
      <B> BfoldMapRight(F<A,B> f, + Monoid<B> m) +
      Folds this Set from the right using the given monoid.
      +
      static <A> Set<A>fromList(Ord<A> o, + List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
      +
      +
      inthashCode() 
      static <A> F<A,F<Set<A>,Set<A>>>insert() +
      First-class insertion function.
      +
      Set<A>insert(A x) +
      Inserts the given element into this set.
      +
      static <A> F<Set<A>,F<Set<A>,Set<A>>>intersect() +
      A first class function for intersect(Set).
      +
      Set<A>intersect(Set<A> s) +
      Remove all elements from this set that do not occur in the given set.
      +
      booleanisEmpty() 
      static <A> Set<A>iterableSet(Ord<A> o, + java.lang.Iterable<A> as) +
      Return the elements of the given iterable as a set.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator over this set.
      +
      static <A> Set<A>iteratorSet(Ord<A> o, + java.util.Iterator<A> as) +
      Return the elements of the given iterator as a set.
      +
      static <A> Set<A>join(Ord<A> o, + Set<Set<A>> s) +
      Join a set of sets into a single set.
      +
      Option<A>lookup(A a) +
      Find element equal to the given one.
      +
      Option<A>lookupGE(A a) +
      Find smallest element greater or equal to the given one.
      +
      Option<A>lookupGT(A a) +
      Find smallest element greater than the given one.
      +
      Option<A>lookupLE(A a) +
      Find largest element smaller or equal to the given one.
      +
      Option<A>lookupLT(A a) +
      Find largest element smaller than the given one.
      +
      <B> Set<B>map(Ord<B> o, + F<A,B> f) +
      Maps the given function across this set.
      +
      Option<A>max() 
      static <A> F<Set<A>,F<A,java.lang.Boolean>>member() +
      First-class membership check.
      +
      booleanmember(A x) +
      Checks if the given element is a member of this set.
      +
      Option<A>min() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>minus() +
      A first class function for minus(Set).
      +
      Set<A>minus(Set<A> s) +
      Remove all elements from this set that occur in the given set.
      +
      Ord<A>ord() +
      Returns the order of this Set.
      +
      static <A> Set<A>set(Ord<A> o, + A... as) +
      Constructs a set from the given elements.
      +
      static <A> Set<A>set(Ord<A> o, + List<A> list) +
      Deprecated.  +
      As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
      +
      +
      static <A> Set<A>single(Ord<A> o, + A a) +
      Returns a set with a single element.
      +
      intsize() +
      Returns the size of this set.
      +
      P3<Set<A>,Option<A>,Set<A>>split(A a) +
      Splits this set at the given element.
      +
      booleansubsetOf(Set<A> s) +
      Returns true if this set is a subset of the given set.
      +
      java.util.HashSet<A>toJavaHashSet() +
      Returns a java.util.HashSet representation of this set.
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List representation of this set.
      +
      java.util.Set<A>toJavaSet() +
      Returns a java.util.Set representation of this set.
      +
      java.util.TreeSet<A>toJavaTreeSet() +
      Returns a java.util.TreeSet representation of this set.
      +
      List<A>toList() +
      Returns a list representation of this set.
      +
      List<A>toListReverse() +
      Returns a list representation of this set in reverse order.
      +
      Stream<A>toStream() +
      Returns a stream representation of this set.
      +
      Stream<A>toStreamReverse() +
      Returns a stream representation of this set in reverse order.
      +
      java.lang.StringtoString() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>union() +
      A first class function for union(Set).
      +
      Set<A>union(Set<A> s) +
      Add all the elements of the given set to this set.
      +
      P2<java.lang.Boolean,Set<A>>update(A a, + F<A,A> f) +
      Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public final Ord<A> ord()
        +
        Returns the order of this Set.
        +
        +
        Returns:
        +
        the order of this Set.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public final P2<java.lang.Boolean,Set<A>> update(A a,
+                                                 F<A,A> f)
        +
        Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
        +
        +
        Parameters:
        +
        a - An element to replace.
        +
        f - A function to transforms the found element.
        +
        Returns:
        +
        A pair of: (1) True if an element was found that matches the given element, otherwise false. + (2) A new set with the given function applied to the first set element + that was equal to the given element.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Set<A> empty(Ord<A> ord)
        +
        The empty set.
        +
        +
        Parameters:
        +
        ord - An order for the type of elements.
        +
        Returns:
        +
        the empty set.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        member

        +
        public final boolean member(A x)
        +
        Checks if the given element is a member of this set.
        +
        +
        Parameters:
        +
        x - An element to check for membership in this set.
        +
        Returns:
        +
        true if the given element is a member of this set.
        +
        +
        • +
      + + + +
        +
      • +

        member

        +
        public static <A> F<Set<A>,F<A,java.lang.Boolean>> member()
        +
        First-class membership check.
        +
        +
        Returns:
        +
        A function that returns true if the given element if a member of the given set.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public final Set<A> insert(A x)
        +
        Inserts the given element into this set.
        +
        +
        Parameters:
        +
        x - An element to insert into this set.
        +
        Returns:
        +
        A new set with the given element inserted.
        +
        +
        • +
      + + + +
        +
      • +

        insert

        +
        public static <A> F<A,F<Set<A>,Set<A>>> insert()
        +
        First-class insertion function.
        +
        +
        Returns:
        +
        A function that inserts a given element into a given set.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator over this set.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator over this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Set<A> single(Ord<A> o,
+                                A a)
        +
        Returns a set with a single element.
        +
        +
        Parameters:
        +
        o - An order for the type of element.
        +
        a - An element to put in a set.
        +
        Returns:
        +
        A new set with the given element in it.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Set<B> map(Ord<B> o,
+                            F<A,B> f)
        +
        Maps the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        f - A function to map across this set.
        +
        Returns:
        +
        The set of the results of applying the given function to the elements of this set.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public final <B> B foldMap(F<A,B> f,
+                           Monoid<B> m)
        +
        Folds this Set using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapRight

        +
        public final <B> B foldMapRight(F<A,B> f,
+                                Monoid<B> m)
        +
        Folds this Set from the right using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set from the right with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list representation of this set.
        +
        +
        Returns:
        +
        a list representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public final java.util.Set<A> toJavaSet()
        +
        Returns a java.util.Set representation of this set.
        +
        +
        Returns:
        +
        a java.util.Set representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaHashSet

        +
        public final java.util.HashSet<A> toJavaHashSet()
        +
        Returns a java.util.HashSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.HashSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaTreeSet

        +
        public final java.util.TreeSet<A> toJavaTreeSet()
        +
        Returns a java.util.TreeSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.TreeSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List representation of this set.
        +
        +
        Returns:
        +
        a java.util.List representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public final List<A> toListReverse()
        +
        Returns a list representation of this set in reverse order.
        +
        +
        Returns:
        +
        a list representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream representation of this set.
        +
        +
        Returns:
        +
        a stream representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public final Stream<A> toStreamReverse()
        +
        Returns a stream representation of this set in reverse order.
        +
        +
        Returns:
        +
        a stream representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Set<B> bind(Ord<B> o,
+                             F<A,Set<B>> f)
        +
        Binds the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the target set.
        +
        f - A function to bind across this set.
        +
        Returns:
        +
        A new set after applying the given function and joining the resulting sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public final Set<A> union(Set<A> s)
        +
        Add all the elements of the given set to this set.
        +
        +
        Parameters:
        +
        s - A set to add to this set.
        +
        Returns:
        +
        A new set containing all elements of both sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> union()
        +
        A first class function for union(Set).
        +
        +
        Returns:
        +
        A function that adds all the elements of one set to another set.
        +
        See Also:
        +
        union(Set)
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Set<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new set whose elements all match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final Set<A> delete(A a)
        +
        Deletes the given element from this set.
        +
        +
        Parameters:
        +
        a - an element to remove.
        +
        Returns:
        +
        A new set containing all the elements of this set, except the given element.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public final F<A,F<Set<A>,Set<A>>> delete()
        +
        First-class deletion function.
        +
        +
        Returns:
        +
        A function that deletes a given element from a given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public final Set<A> intersect(Set<A> s)
        +
        Remove all elements from this set that do not occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to retain.
        +
        Returns:
        +
        A new set which is the intersection of this set and the given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> intersect()
        +
        A first class function for intersect(Set).
        +
        +
        Returns:
        +
        A function that intersects two given sets.
        +
        See Also:
        +
        intersect(Set)
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Set<A> minus(Set<A> s)
        +
        Remove all elements from this set that occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to delete.
        +
        Returns:
        +
        A new set which contains only the elements of this set that do not occur in the given set.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> minus()
        +
        A first class function for minus(Set).
        +
        +
        Returns:
        +
        A function that removes all elements of one set from another set.
        +
        See Also:
        +
        minus(Set)
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final Option<A> min()
        +
        • +
      + + + +
        +
      • +

        max

        +
        public final Option<A> max()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public final int size()
        +
        Returns the size of this set.
        +
        +
        Returns:
        +
        The number of elements in this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public final P3<Set<A>,Option<A>,Set<A>> split(A a)
        +
        Splits this set at the given element. Returns a product-3 of: +
          +
        • A set containing all the elements of this set which are less than the given value.
          • +
        • An option of a value equal to the given value, if one was found in this set, otherwise None. +
        • A set containing all the elements of this set which are greater than the given value.
          • +
        +
        +
        Parameters:
        +
        a - A value at which to split this set.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are less than the given value + and all the elements in the second set are greater than the given value, and the optional value is the + given value if found, otherwise None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public final Option<A> lookup(A a)
        +
        Find element equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some element in this set equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLT

        +
        public final Option<A> lookupLT(A a)
        +
        Find largest element smaller than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGT

        +
        public final Option<A> lookupGT(A a)
        +
        Find smallest element greater than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLE

        +
        public final Option<A> lookupLE(A a)
        +
        Find largest element smaller or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller or equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGE

        +
        public final Option<A> lookupGE(A a)
        +
        Find smallest element greater or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater or equal to the given one, or None.
        +
        +
        • +
      + + + +
        +
      • +

        subsetOf

        +
        public final boolean subsetOf(Set<A> s)
        +
        Returns true if this set is a subset of the given set.
        +
        +
        Parameters:
        +
        s - A set which is a superset of this set if this method returns true.
        +
        Returns:
        +
        true if this set is a subset of the given set.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Set<A> join(Ord<A> o,
+                              Set<Set<A>> s)
        +
        Join a set of sets into a single set.
        +
        +
        Parameters:
        +
        s - A set of sets.
        +
        o - An order for the elements of the new set.
        +
        Returns:
        +
        A new set which is the join of the given set of sets.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSet

        +
        public static <A> Set<A> iterableSet(Ord<A> o,
+                                     java.lang.Iterable<A> as)
        +
        Return the elements of the given iterable as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterable of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSet

        +
        public static <A> Set<A> iteratorSet(Ord<A> o,
+                                     java.util.Iterator<A> as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySet

        +
        @SafeVarargs
+public static <A> Set<A> arraySet(Ord<A> o,
+                                               A... as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        @SafeVarargs
+public static <A> Set<A> set(Ord<A> o,
+                                          A... as)
        +
        Constructs a set from the given elements.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - The elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        @Deprecated
+public static <A> Set<A> set(Ord<A> o,
+                                         List<A> list)
        +
        Deprecated. As of release 4.5, use iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
        +
        Constructs a set from the list.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        list - The elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given list.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/State.html b/javadoc/4.8.1/functionaljava/fj/data/State.html new file mode 100644 index 0000000..d50e949 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/State.html @@ -0,0 +1,479 @@ + + + + + +State (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class State<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.State<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class State<S,A>
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static <S,A> State<S,A> unit(F<S,P2<S,A>> runF)
        +
        • +
      + + + +
        +
      • +

        init

        +
        public static <S> State<S,S> init()
        +
        • +
      + + + +
        +
      • +

        units

        +
        public static <S> State<S,S> units(F<S,S> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <S,A> State<S,A> constant(A a)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public static <S,A> State<S,A> gets(F<S,A> f)
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public static <S> State<S,Unit> put(S s)
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public static <S> State<S,Unit> modify(F<S,S> f)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <S,A,B> State<S,B> flatMap(State<S,A> ts,
+                                         F<A,State<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <S,A> State<S,List<A>> sequence(List<State<S,A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        traverse

        +
        public static <S,A,B> State<S,List<B>> traverse(List<A> list,
+                                                F<A,State<S,B>> f)
        +
        Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
        +
        • +
      + + + + + +
        +
      • +

        run

        +
        public P2<S,A> run(S s)
        +
        • +
      + + + + + +
        +
      • +

        eval

        +
        public A eval(S s)
        +
        • +
      + + + + + +
        +
      • +

        exec

        +
        public S exec(S s)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public State<S,S> gets()
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> State<S,B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        mapState

        +
        public <B> State<S,B> mapState(F<P2<S,A>,P2<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        withs

        +
        public State<S,A> withs(F<S,S> f)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Stream.html b/javadoc/4.8.1/functionaljava/fj/data/Stream.html new file mode 100644 index 0000000..eb9401b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Stream.html @@ -0,0 +1,3302 @@ + + + + + +Stream (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Stream<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Stream<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Stream<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A lazy (not yet evaluated), immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      Stream<A>append(F0<Stream<A>> as) +
      Appends the given stream to this stream.
      +
      Stream<A>append(Stream<A> as) +
      Appends the given stream to this stream.
      +
      <B> Stream<B>apply(Stream<F<A,B>> sf) +
      Performs function application within a stream (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this stream.
      +
      static <A> Stream<A>arrayStream(A... as) 
      static java.lang.StringasString(Stream<java.lang.Character> cs) +
      Returns a string from the given stream of characters.
      +
      static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>>bind_() +
      A first-class version of the bind function.
      +
      <B> Stream<B>bind(F<A,Stream<B>> f) +
      Binds the given function across each element of this stream with a final join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C,D> Stream<D>bind(Stream<B> sb, + Stream<C> sc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E> Stream<E>bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$>
      Stream<F$>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G>
      Stream<G>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H>
      Stream<H>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      Stream<I>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + Stream<H> sh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B> Stream<B>cobind(F<Stream<A>,B> k) +
      Binds the given function across the stream of substreams of this stream.
      +
      static <A> F<A,F<Stream<A>,Stream<A>>>cons_() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      static <A> F<A,F<P1<Stream<A>>,Stream<A>>>cons() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      Stream<A>cons(A a) +
      Prepends (cons) the given element to this stream to product a new stream.
      +
      static <A> Stream<A>cons(A head, + F0<Stream<A>> tail) +
      Prepends the given head element to the given tail element to produce a new stream.
      +
      static <A> Stream<A>cycle(Stream<A> as) +
      Returns an infinite-length stream of the given elements cycling.
      +
      Stream<A>drop(int i) +
      Drops the given number of elements from the head of this stream if they are available.
      +
      Stream<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
      +
      static <A> Stream<A>enumerationStream(java.util.Enumeration<A> e) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
      +
      static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>>filter() +
      Returns a first-class version of the filter function.
      +
      Stream<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>>foldRight() +
      A first-class version of the foldRight function.
      +
      <B> BfoldRight(F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight(F2<A,P1<B>,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this stream.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this stream.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from, + long step) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
      +
      static <A,B> Stream<A>fromFunction(Enumerator<B> e, + F<B,A> f, + B i) +
      Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
      +
      static <A> Stream<A>fromFunction(F<Natural,A> f) +
      Converts a function of natural numbers to a stream.
      +
      static Stream<java.lang.Character>fromString(java.lang.String s) +
      Returns a stream of characters from the given string.
      +
      inthashCode() 
      abstract Ahead() +
      The first element of the stream or fails for the empty stream.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      Option<java.lang.Integer>indexOf(F<A,java.lang.Boolean> p) +
      Returns the position of the first element matching the given predicate, if any.
      +
      Stream<Stream<A>>inits() +
      Returns a stream of all prefixes of this stream.
      +
      Stream<A>interleave(Stream<A> as) +
      Interleaves the given stream with this stream to produce a new stream.
      +
      Stream<A>intersperse(A a) +
      Intersperses the given value between each two elements of the stream.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given stream is empty.
      +
      booleanisEmpty() +
      Returns true if this stream is empty, false otherwise.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given stream is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this stream is empty, true otherwise.
      +
      static <A> Stream<A>iterableStream(java.lang.Iterable<A> i) +
      Takes the given iterable to a stream.
      +
      static <A> F<F<A,A>,F<A,Stream<A>>>iterate() +
      A first-class version of the iterate function.
      +
      static <A> Stream<A>iterate(F<A,A> f, + A a) +
      Returns a stream constructed by applying the given iteration function starting at the given value.
      +
      static <A> Stream<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this stream.
      +
      static <A> Stream<A>iteratorStream(java.util.Iterator<A> it) +
      Constructs a stream with the given elements in the Iterator.
      +
      static <A> F<Stream<Stream<A>>,Stream<A>>join() +
      A first-class version of join
      +
      static <A> Stream<A>join(Stream<Stream<A>> o) +
      Joins the given stream of streams by concatenation.
      +
      Alast() +
      Get the last element of this stream.
      +
      intlength() +
      The length of this stream.
      +
      static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>>map_() +
      Provides a first-class version of the map function.
      +
      <B> Stream<B>map(F<A,B> f) +
      Maps the given function across this stream.
      +
      <B,C> F<B,Stream<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
      +
      Stream<A>minus(Equal<A> eq, + Stream<A> xs) +
      Returns a new stream of all the items in this stream that do not appear in the given stream.
      +
      static <A> P1<Stream<A>>nil_() +
      Returns an empty stream.
      +
      static <A> Stream<A>nil() +
      Returns an empty stream.
      +
      AorHead(F0<A> a) +
      Returns the head of this stream if there is one or the given argument if this stream is empty.
      +
      P1<Stream<A>>orTail(F0<Stream<A>> as) +
      Returns the tail of this stream if there is one or the given argument if this stream is empty.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to, + long step) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
      +
      static Stream<java.lang.Integer>range(int from) +
      Returns an infinite stream of integers from the given from value (inclusive).
      +
      static Stream<java.lang.Integer>range(int from, + long to) +
      Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Stream<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> Stream<A>repeat(A a) +
      Returns an infinite-length stream of the given element.
      +
      Stream<A>replace(F<A,java.lang.Boolean> p, + A a) +
      Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
      +
      Stream<A>reverse() +
      Reverse this stream in constant stack space.
      +
      static <A,B> F<B,Stream<A>>sequence_(Stream<F<B,A>> fs) +
      Turn a stream of functions into a function returning a stream.
      +
      static <A> Stream<P1<A>>sequence(F0<Stream<A>> p) +
      Sequence through the Stream monad.
      +
      static <A> Stream<IO<A>>sequence(IO<Stream<A>> io) +
      Sequence through the Stream monad.
      +
      static <A> Stream<Option<A>>sequence(Option<Stream<A>> o) +
      Sequence through the Stream monad.
      +
      <B> Stream<B>sequence(Stream<B> bs) +
      Performs a bind across each stream element, but ignores the element value each time.
      +
      <B> Stream<B>sequenceW(Stream<F<Stream<A>,B>> fs) +
      Applies a stream of comonadic functions to this stream, returning a stream of values.
      +
      static <A> F<A,Stream<A>>single() +
      Returns a function that yields a stream containing its argument.
      +
      static <A> Stream<A>single(A a) +
      Returns a stream of one element containing the given value.
      +
      Stream<A>snoc(A a) +
      Append the given element to this stream to product a new stream.
      +
      Stream<A>snoc(F0<A> a) +
      Append the given element to this stream to produce a new stream.
      +
      Stream<A>sort(Ord<A> o) +
      Sort this stream according to the given ordering.
      +
      Stream<A>sort(Ord<A> o, + Strategy<Unit> s) +
      Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
      +
      P2<Stream<A>,Stream<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
      +
      P2<Stream<A>,Stream<A>>split(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
      +
      static <A> Stream<A>stream(A... as) +
      Constructs a stream with the given elements.
      +
      <B> Bstream(B nil, + F<A,F<P1<Stream<A>>,B>> cons) +
      Deprecated.  +
      As of release 4.5, use uncons(B, fj.F<A, fj.F<fj.P1<fj.data.Stream<A>>, B>>)
      +
      +
      static <A> Stream<A>stream(java.lang.Iterable<A> it) +
      Deprecated.  +
      As of release 4.5, use iterableStream(Iterable)
      +
      +
      static <A> Stream<A>stream(java.util.Iterator<A> it) +
      Deprecated.  +
      As of release 4.5, use iteratorStream(Iterator)
      +
      +
      Stream<Stream<A>>substreams() +
      Returns a stream of all infixes of this stream.
      +
      abstract P1<Stream<A>>tail() +
      The stream without the first element or fails for the empty stream.
      +
      Stream<Stream<A>>tails() +
      Returns a stream of the suffixes of this stream.
      +
      Stream<A>take(int n) +
      Returns the first n elements from the head of this stream.
      +
      Stream<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this stream that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this stream.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this stream.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this stream.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
      +
      F<java.lang.Integer,A>toFunction() +
      Converts this stream to a function of natural numbers.
      +
      A[]toJavaArray() +
      Deprecated.  +
      As of release 4.6, use array(Class).
      +
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List projection of this stream.
      +
      List<A>toList() +
      Returns a list projection of this stream.
      +
      Option<A>toOption() +
      Returns an option projection of this stream; None if empty, or the first element + in Some.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() 
      java.lang.StringtoStringLazy() 
      <B> IO<Stream<B>>traverseIO(F<A,IO<B>> f) +
      Traversable instance of Stream for IO.
      +
      <B> Option<Stream<B>>traverseOption(F<A,Option<B>> f) +
      Traversable instance of Stream for Option.
      +
      <B> Buncons(B nil, + F<A,F<P1<Stream<A>>,B>> cons) +
      Performs a reduction on this stream using the given arguments.
      +
      static <A,B> Stream<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a stream.
      +
      static <A,B> P2<Stream<A>,Stream<B>>unzip(Stream<P2<A,B>> xs) +
      Transforms a stream of pairs into a stream of first components and a stream of second components.
      +
      <B> Stream<B>zapp(Stream<F<A,B>> fs) +
      Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
      +
      <B> Stream<P2<A,B>>zip(Stream<B> bs) +
      Zips this stream with the given stream to produce a stream of pairs.
      +
      Stream<P2<A,java.lang.Integer>>zipIndex() +
      Zips this stream with the index of its element as a pair.
      +
      static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>>zipWith() +
      A first-class version of the zipWith function.
      +
      <B,C> F<Stream<B>,Stream<C>>zipWith(F<A,F<B,C>> f) +
      Partially-applied version of zipWith.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F<A,F<B,C>> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F2<A,B,C> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this stream. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this stream.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        Returns:
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract P1<Stream<A>> tail()
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        Returns:
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this stream is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this stream is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this stream is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this stream is empty, true otherwise.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F<A,F<P1<Stream<A>>,B>> cons)
        +
        Performs a reduction on this stream using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this stream is empty.
        +
        cons - The function to apply to the head and tail of this stream if it is not empty.
        +
        Returns:
        +
        A reduction on this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<P1<B>,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,P1<B>,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this stream is empty.
        +
        Returns:
        +
        The head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final P1<Stream<A>> orTail(F0<Stream<A>> as)
        +
        Returns the tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this stream is empty.
        +
        Returns:
        +
        The tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final Stream<A> intersperse(A a)
        +
        Intersperses the given value between each two elements of the stream.
        +
        +
        Parameters:
        +
        a - The value to intersperse between values of the stream.
        +
        Returns:
        +
        A new stream with the given value between each two elements of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Stream<B> map(F<A,B> f)
        +
        Maps the given function across this stream.
        +
        +
        Parameters:
        +
        f - The function to map across this stream.
        +
        Returns:
        +
        A new stream after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>> map_()
        +
        Provides a first-class version of the map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given stream.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Stream<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(Stream<A> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(F0<Stream<A>> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Stream<A> minus(Equal<A> eq,
+                             Stream<A> xs)
        +
        Returns a new stream of all the items in this stream that do not appear in the given stream.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the streams.
        +
        xs - a list to subtract from this stream.
        +
        Returns:
        +
        a stream of all the items in this stream that do not appear in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final Stream<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,Stream<A>> sequence_(Stream<F<B,A>> fs)
        +
        Turn a stream of functions into a function returning a stream.
        +
        +
        Parameters:
        +
        fs - The stream of functions to sequence into a single function that returns a stream.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given stream to it + and returns a stream of the results.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,Stream<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Stream<B> bind(F<A,Stream<B>> f)
        +
        Binds the given function across each element of this stream with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F2<A,B,C> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Stream<D> bind(Stream<B> sb,
+                                    Stream<C> sc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Stream<E> bind(Stream<B> sb,
+                                      Stream<C> sc,
+                                      Stream<D> sd,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Stream<F$> bind(Stream<B> sb,
+                                          Stream<C> sc,
+                                          Stream<D> sd,
+                                          Stream<E> se,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Stream<G> bind(Stream<B> sb,
+                                           Stream<C> sc,
+                                           Stream<D> sd,
+                                           Stream<E> se,
+                                           Stream<F$> sf,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Stream<H> bind(Stream<B> sb,
+                                             Stream<C> sc,
+                                             Stream<D> sd,
+                                             Stream<E> se,
+                                             Stream<F$> sf,
+                                             Stream<G> sg,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Stream<I> bind(Stream<B> sb,
+                                               Stream<C> sc,
+                                               Stream<D> sd,
+                                               Stream<E> se,
+                                               Stream<F$> sf,
+                                               Stream<G> sg,
+                                               Stream<H> sh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        sh - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> Stream<B> sequence(Stream<B> bs)
        +
        Performs a bind across each stream element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The stream to apply in the final join.
        +
        Returns:
        +
        A new stream after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<IO<A>> sequence(IO<Stream<A>> io)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        io - The IO stream to sequence.
        +
        Returns:
        +
        The stream of IOs after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<P1<A>> sequence(F0<Stream<A>> p)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        p - The lazy stream to sequence.
        +
        Returns:
        +
        The stream of (pre-calculated) lazy values after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<Option<A>> sequence(Option<Stream<A>> o)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        o - The optional stream to sequence.
        +
        Returns:
        +
        The stream of options after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Stream<B> apply(Stream<F<A,B>> sf)
        +
        Performs function application within a stream (applicative functor pattern).
        +
        +
        Parameters:
        +
        sf - The stream of functions to apply.
        +
        Returns:
        +
        A new stream after applying the given stream of functions through this stream.
        +
        +
        • +
      + + + +
        +
      • +

        interleave

        +
        public final Stream<A> interleave(Stream<A> as)
        +
        Interleaves the given stream with this stream to produce a new stream.
        +
        +
        Parameters:
        +
        as - The stream to interleave this stream with.
        +
        Returns:
        +
        A new stream with elements interleaved from this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        enumerationStream

        +
        public static <A> Stream<A> enumerationStream(java.util.Enumeration<A> e)
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o)
        +
        Sort this stream according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o,
+                            Strategy<Unit> s)
        +
        Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        s - A strategy for parallelising the algorithm.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this stream.
        +
        +
        Returns:
        +
        An immutable collection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from,
+                                              long to)
        +
        Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        to - The maximum value for the stream (exclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + + + +
        +
      • +

        stream

        +
        @SafeVarargs
+public static <A> Stream<A> stream(A... as)
        +
        Constructs a stream with the given elements.
        +
        +
        Parameters:
        +
        as - The elements which which to construct a stream.
        +
        Returns:
        +
        a new stream with the given elements.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        iteratorStream

        +
        public static <A> Stream<A> iteratorStream(java.util.Iterator<A> it)
        +
        Constructs a stream with the given elements in the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from,
+                                    long step)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to,
+                                  long step)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from)
        +
        Returns an infinite stream of integers from the given from value (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>> filter()
        +
        Returns a first-class version of the filter function.
        +
        +
        Returns:
        +
        a function that filters a given stream using a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public final <B> Stream<B> zapp(Stream<F<A,B>> fs)
        +
        Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream. If this stream and the given stream + have different lengths, then the longer stream is normalised so this function never fails.
        +
        +
        Parameters:
        +
        fs - The stream of functions to apply to this stream.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> F<Stream<B>,Stream<C>> zipWith(F<A,F<B,C>> f)
        +
        Partially-applied version of zipWith. + Returns a function that zips a given stream with this stream using the given function.
        +
        +
        Parameters:
        +
        f - The function to zip this stream and a given stream with.
        +
        Returns:
        +
        A function that zips a given stream with this stream using the given function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> Stream<P2<A,B>> zip(Stream<B> bs)
        +
        Zips this stream with the given stream to produce a stream of pairs. If this stream and the + given stream have different lengths, then the longer stream is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final Stream<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this stream with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new stream with the same length as this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this stream is empty.
        +
        Returns:
        +
        An either projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<A> toOption()
        +
        Returns an option projection of this stream; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaArray

        +
        @Deprecated
+public final A[] toJavaArray()
        +
        Deprecated. As of release 4.6, use array(Class).
        +
        To be removed in future release: + affectation of the result of this method to a non generic array + will result in runtime error (ClassCastException).
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this stream.
        +
        +
        Returns:
        +
        A list projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List projection of this stream.
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this stream.
        +
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final Stream<A> cons(A a)
        +
        Prepends (cons) the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new stream with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(Stream<java.lang.Character> cs)
        +
        Returns a string from the given stream of characters. The inverse of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The stream of characters to produce the string from.
        +
        Returns:
        +
        A string from the given stream of characters.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Stream<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a stream of characters from the given string. The inverse of this function is asString(Stream).
        +
        +
        Parameters:
        +
        s - The string to produce the stream of characters from.
        +
        Returns:
        +
        A stream of characters from the given string.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(A a)
        +
        Append the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(F0<A> a)
        +
        Append the given element to this stream to produce a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final Stream<A> take(int n)
        +
        Returns the first n elements from the head of this stream.
        +
        +
        Parameters:
        +
        n - The number of elements to take from this stream.
        +
        Returns:
        +
        The first n elements from the head of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final Stream<A> drop(int i)
        +
        Drops the given number of elements from the head of this stream if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this stream.
        +
        Returns:
        +
        A stream with a length the same, or less than, this stream.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final Stream<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this stream that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this stream until it finds an element that does not + hold, or the stream is exhausted.
        +
        Returns:
        +
        The first elements of the head of this stream that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<Stream<B>> traverseIO(F<A,IO<B>> f)
        +
        Traversable instance of Stream for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<Stream<B>> traverseOption(F<A,Option<B>> f)
        +
        Traversable instance of Stream for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final Stream<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this stream.
        +
        Returns:
        +
        The stream whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<Stream<A>,Stream<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public final Stream<A> replace(F<A,java.lang.Boolean> p,
+                               A a)
        +
        Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        Parameters:
        +
        p - The predicate to match replaced elements.
        +
        a - The element with which to replace elements.
        +
        Returns:
        +
        A new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<Stream<A>,Stream<A>> split(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate not to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Stream<A> reverse()
        +
        Reverse this stream in constant stack space.
        +
        +
        Returns:
        +
        A new stream that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Get the last element of this stream. Undefined for infinite streams.
        +
        +
        Returns:
        +
        The last element in this stream, if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this stream. This function will not terminate for an infinite stream.
        +
        +
        Returns:
        +
        The length of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this stream.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this stream, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public final java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public final java.lang.String toStringEager()
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this stream.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + stream.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this stream.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <B> Stream<B> cobind(F<Stream<A>,B> k)
        +
        Binds the given function across the stream of substreams of this stream.
        +
        +
        Parameters:
        +
        k - A function to bind across this stream and its substreams.
        +
        Returns:
        +
        a new stream of the results of applying the given function to this stream and its substreams.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final Stream<Stream<A>> tails()
        +
        Returns a stream of the suffixes of this stream. A stream is considered to be a suffix of itself in this context.
        +
        +
        Returns:
        +
        a stream of the suffixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final Stream<Stream<A>> inits()
        +
        Returns a stream of all prefixes of this stream. A stream is considered a prefix of itself in tnis context.
        +
        +
        Returns:
        +
        a stream of the prefixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        substreams

        +
        public final Stream<Stream<A>> substreams()
        +
        Returns a stream of all infixes of this stream. A stream is considered to contain itself.
        +
        +
        Returns:
        +
        a stream of the infixes of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public final Option<java.lang.Integer> indexOf(F<A,java.lang.Boolean> p)
        +
        Returns the position of the first element matching the given predicate, if any.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        the position of the first element matching the given predicate, if any.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <B> Stream<B> sequenceW(Stream<F<Stream<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this stream, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of comonadic functions to apply to this stream.
        +
        Returns:
        +
        A new stream of the results of applying the stream of functions to this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toFunction

        +
        public final F<java.lang.Integer,A> toFunction()
        +
        Converts this stream to a function of natural numbers.
        +
        +
        Returns:
        +
        A function from natural numbers to values with the corresponding position in this stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromFunction

        +
        public static <A> Stream<A> fromFunction(F<Natural,A> f)
        +
        Converts a function of natural numbers to a stream.
        +
        +
        Parameters:
        +
        f - The function to convert to a stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the natural numbers, starting at 0.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromFunction

        +
        public static <A,B> Stream<A> fromFunction(Enumerator<B> e,
+                                           F<B,A> f,
+                                           B i)
        +
        Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
        +
        +
        Parameters:
        +
        e - An enumerator for the domain of the function.
        +
        f - The function to convert to a stream.
        +
        i - The index into the function at which to begin the stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the values of the given enumerator, + starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Stream<A>,Stream<B>> unzip(Stream<P2<A,B>> xs)
        +
        Transforms a stream of pairs into a stream of first components and a stream of second components.
        +
        +
        Parameters:
        +
        xs - The stream of pairs to transform.
        +
        Returns:
        +
        A stream of first components and a stream of second components.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>> zipWith()
        +
        A first-class version of the zipWith function.
        +
        +
        Returns:
        +
        a function that zips two given streams with a given function.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<P1<Stream<A>>,Stream<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F<A,F<Stream<A>,Stream<A>>> cons_()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Stream<A> nil()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil_

        +
        public static <A> P1<Stream<A>> nil_()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given stream is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given stream is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is not empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Stream<A> single(A a)
        +
        Returns a stream of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned stream.
        +
        Returns:
        +
        A stream of one element containing the given value.
        +
        +
        • +
      + + + +
        +
      • +

        single

        +
        public static <A> F<A,Stream<A>> single()
        +
        Returns a function that yields a stream containing its argument.
        +
        +
        Returns:
        +
        a function that yields a stream containing its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> Stream<A> cons(A head,
+                                 F0<Stream<A>> tail)
        +
        Prepends the given head element to the given tail element to produce a new stream.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The stream to prepend to.
        +
        Returns:
        +
        The stream with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Stream<A> join(Stream<Stream<A>> o)
        +
        Joins the given stream of streams by concatenation.
        +
        +
        Parameters:
        +
        o - The stream of streams to join.
        +
        Returns:
        +
        A new stream that is the join of the given streams.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Stream<Stream<A>>,Stream<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a stream of streams using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> Stream<A> unfold(F<B,Option<P2<A,B>>> f,
+                                     B b)
        +
        Unfolds across the given function starting at the given value to produce a stream.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new stream that is a result of unfolding until the function does not produce a + value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> Stream<A> iterateWhile(F<A,A> f,
+                                         F<A,java.lang.Boolean> p,
+                                         A a)
        +
        Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + +
        +
      • +

        iterableStream

        +
        public static <A> Stream<A> iterableStream(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a stream.
        +
        +
        Parameters:
        +
        i - The iterable to take to a stream.
        +
        Returns:
        +
        A stream from the given iterable.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayStream

        +
        @SafeVarargs
+public static <A> Stream<A> arrayStream(A... as)
        +
        • +
      + + + + + +
        +
      • +

        repeat

        +
        public static <A> Stream<A> repeat(A a)
        +
        Returns an infinite-length stream of the given element.
        +
        +
        Parameters:
        +
        a - The element to repeat infinitely.
        +
        Returns:
        +
        An infinite-length stream of the given element.
        +
        +
        • +
      + + + +
        +
      • +

        cycle

        +
        public static <A> Stream<A> cycle(Stream<A> as)
        +
        Returns an infinite-length stream of the given elements cycling. Fails on the empty stream.
        +
        +
        Parameters:
        +
        as - The elements to cycle infinitely. This must not be empty.
        +
        Returns:
        +
        An infinite-length stream of the given elements cycling.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterate

        +
        public static <A> Stream<A> iterate(F<A,A> f,
+                                    A a)
        +
        Returns a stream constructed by applying the given iteration function starting at the given value.
        +
        +
        Parameters:
        +
        f - The iteration function.
        +
        a - The value to begin iterating from.
        +
        Returns:
        +
        A stream constructed by applying the given iteration function starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        iterate

        +
        public static <A> F<F<A,A>,F<A,Stream<A>>> iterate()
        +
        A first-class version of the iterate function.
        +
        +
        Returns:
        +
        A function that returns a stream constructed by applying a given iteration function + starting at a given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>> bind_()
        +
        A first-class version of the bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across a given stream, joining the resulting streams.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>> foldRight()
        +
        A first-class version of the foldRight function.
        +
        +
        Returns:
        +
        A function that folds a given stream with a given function.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Tree.html b/javadoc/4.8.1/functionaljava/fj/data/Tree.html new file mode 100644 index 0000000..3ba1725 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Tree.html @@ -0,0 +1,909 @@ + + + + + +Tree (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Tree<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Tree<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Tree<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Tree<B>bottomUp(Tree<A> t, + F<P2<A,Stream<B>>,B> f) +
      Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
      +
      <B> Tree<B>cobind(F<Tree<A>,B> f) +
      Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
      +
      Tree<Tree<A>>cojoin() +
      Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
      +
      java.lang.Stringdraw(Show<A> s) +
      Draws a 2-dimensional representation of a tree.
      +
      booleanequals(java.lang.Object other) 
      static <A> F<Tree<A>,Stream<A>>flatten_() +
      + flatten :: Tree a -> [a] + flatten t = squish t [] +
      +
      Stream<A>flatten() +
      Puts the elements of the tree into a Stream, in pre-order.
      +
      static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>>fmap_() +
      Provides a transformation to lift any function so that it maps over Trees.
      +
      <B> Tree<B>fmap(F<A,B> f) +
      Maps the given function over this tree.
      +
      static <A,B> F<Tree<A>,B>foldMap_(F<A,B> f, + Monoid<B> m) +
      Provides a function that folds a tree with the given monoid.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this tree using the given monoid.
      +
      inthashCode() 
      booleanisLeaf() 
      java.util.Iterator<A>iterator() +
      Returns an iterator for this tree.
      +
      static <A> Tree<A>leaf(A root) +
      Creates a nullary tree.
      +
      intlength() 
      Stream<Stream<A>>levels() +
      Provides a stream of the elements of the tree at each level, in level order.
      +
      static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>>node() +
      First-class constructor of trees.
      +
      static <A> Tree<A>node(A root, + List<Tree<A>> forest) +
      Creates a new n-ary given a root and a subforest of length n.
      +
      static <A> Tree<A>node(A root, + P1<Stream<Tree<A>>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> Tree<A>node(A root, + Stream<Tree<A>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> F<Tree<A>,A>root_() +
      Provides a transformation from a tree to its root.
      +
      Aroot() +
      Returns the root element of the tree.
      +
      static <A> Show<Tree<A>>show2D(Show<A> s) +
      Provides a show instance that draws a 2-dimensional representation of a tree.
      +
      static <A> F<Tree<A>,P1<Stream<Tree<A>>>>subForest_() +
      Provides a transformation from a tree to its subforest.
      +
      P1<Stream<Tree<A>>>subForest() +
      Returns a stream of the tree's subtrees.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this tree.
      +
      java.lang.StringtoString() 
      static <A,B> F<B,Tree<A>>unfoldTree(F<B,P2<A,P1<Stream<B>>>> f) +
      Builds a tree from a seed value.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F<A,F<B,C>> f) +
      Zips this tree with another, using the given function.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F2<A,B,C> f) +
      Zips this tree with another, using the given function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this tree. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        leaf

        +
        public static <A> Tree<A> leaf(A root)
        +
        Creates a nullary tree.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        Returns:
        +
        A nullary tree with the root element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               P1<Stream<Tree<A>>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               Stream<Tree<A>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               List<Tree<A>> forest)
        +
        Creates a new n-ary given a root and a subforest of length n.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A list of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + +
        +
      • +

        node

        +
        public static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>> node()
        +
        First-class constructor of trees.
        +
        +
        Returns:
        +
        A function that constructs an n-ary tree given a root and a subforest or length n.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public A root()
        +
        Returns the root element of the tree.
        +
        +
        Returns:
        +
        The root element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        subForest

        +
        public P1<Stream<Tree<A>>> subForest()
        +
        Returns a stream of the tree's subtrees.
        +
        +
        Returns:
        +
        A stream of the tree's subtrees.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<Tree<A>,A> root_()
        +
        Provides a transformation from a tree to its root.
        +
        +
        Returns:
        +
        A transformation from a tree to its root.
        +
        +
        • +
      + + + +
        +
      • +

        subForest_

        +
        public static <A> F<Tree<A>,P1<Stream<Tree<A>>>> subForest_()
        +
        Provides a transformation from a tree to its subforest.
        +
        +
        Returns:
        +
        A transformation from a tree to its subforest.
        +
        +
        • +
      + + + +
        +
      • +

        flatten

        +
        public Stream<A> flatten()
        +
        Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        flatten_

        +
        public static <A> F<Tree<A>,Stream<A>> flatten_()
        +
        
+ flatten :: Tree a -> [a]
+ flatten t = squish t []
+
        + where squish (Node x ts) xs = x:Prelude.foldr squish xs ts + Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        levels

        +
        public Stream<Stream<A>> levels()
        +
        Provides a stream of the elements of the tree at each level, in level order.
        +
        +
        Returns:
        +
        The elements of the tree at each level.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Tree<B> fmap(F<A,B> f)
        +
        Maps the given function over this tree.
        +
        +
        Parameters:
        +
        f - The function to map over this tree.
        +
        Returns:
        +
        The new Tree after the function has been applied to each element in this Tree.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>> fmap_()
        +
        Provides a transformation to lift any function so that it maps over Trees.
        +
        +
        Returns:
        +
        A transformation to lift any function so that it maps over Trees.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public <B> B foldMap(F<A,B> f,
+                     Monoid<B> m)
        +
        Folds this tree using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this tree's elements, to the monoid.
        +
        m - The monoid to fold this tree with.
        +
        Returns:
        +
        The result of folding the tree with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this tree.
        +
        +
        Returns:
        +
        An immutable collection of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap_

        +
        public static <A,B> F<Tree<A>,B> foldMap_(F<A,B> f,
+                                          Monoid<B> m)
        +
        Provides a function that folds a tree with the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from a tree's elements to the monoid.
        +
        m - A monoid to fold the tree with.
        +
        Returns:
        +
        A function that, given a tree, folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        unfoldTree

        +
        public static <A,B> F<B,Tree<A>> unfoldTree(F<B,P2<A,P1<Stream<B>>>> f)
        +
        Builds a tree from a seed value.
        +
        +
        Parameters:
        +
        f - A function with which to build the tree.
        +
        Returns:
        +
        A function which, given a seed value, yields a tree.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Tree<B> cobind(F<Tree<A>,B> f)
        +
        Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to bind across all the subtrees of this tree.
        +
        Returns:
        +
        A new tree, with the results of applying the given function to each subtree of this tree. The result + of applying the function to the entire tree is the root label, and the results of applying to the + root's children are labels of the root's subforest, etc.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Tree<Tree<A>> cojoin()
        +
        Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
        +
        +
        Returns:
        +
        A tree of trees, with this tree as its root label, and subtrees of this tree as the labels of + its child nodes.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        draw

        +
        public java.lang.String draw(Show<A> s)
        +
        Draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a String showing this tree in two dimensions.
        +
        +
        • +
      + + + +
        +
      • +

        show2D

        +
        public static <A> Show<Tree<A>> show2D(Show<A> s)
        +
        Provides a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F2<A,B,C> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F<A,F<B,C>> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/TreeMap.html b/javadoc/4.8.1/functionaljava/fj/data/TreeMap.html new file mode 100644 index 0000000..5698974 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/TreeMap.html @@ -0,0 +1,1018 @@ + + + + + +TreeMap (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<P2<K,V>>
    +
    +
    +
    +
    public final class TreeMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<P2<K,V>>
    +
    An immutable, in-memory map, backed by a red-black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static <K,V> TreeMap<K,V>arrayTreeMap(Ord<K> keyOrd, + P2<K,V>... ps) +
      Constructs a tree map from the given elements.
      +
      booleancontains(K k) +
      Determines if the given key value exists in this tree map.
      +
      TreeMap<K,V>delete(K k) +
      Deletes the entry in the tree map that corresponds to the given key.
      +
      static <K,V> TreeMap<K,V>empty(Ord<K> keyOrd) +
      Constructs an empty tree map.
      +
      booleanequals(java.lang.Object other) 
      static <K,V> TreeMap<K,V>fromMutableMap(Ord<K> ord, + java.util.Map<K,V> m) +
      An immutable projection of the given mutable map.
      +
      F<K,Option<V>>get() +
      Returns a first-class version of the get method for this TreeMap.
      +
      Option<V>get(K k) +
      Returns a potential value that the given key maps to.
      +
      inthashCode() 
      booleanisEmpty() +
      Determines if this tree map has any entries.
      +
      static <K,V> TreeMap<K,V>iterableTreeMap(Ord<K> keyOrd, + java.lang.Iterable<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      java.util.Iterator<P2<K,V>>iterator() +
      Returns an iterator for this map's key-value pairs.
      +
      static <K,V> TreeMap<K,V>iteratorTreeMap(Ord<K> keyOrd, + java.util.Iterator<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      List<K>keys() +
      Returns all keys in this tree map.
      +
      <W> TreeMap<K,W>map(F<V,W> f) +
      Maps the given function across the values of this TreeMap.
      +
      Option<P2<K,V>>max() +
      Returns the maximum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>maxKey() +
      Returns the maximum key in the tree if the tree is not empty.
      +
      Option<P2<K,V>>min() +
      Returns the minimum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>minKey() +
      Returns the minimum key in the tree if the tree is not empty.
      +
      TreeMap<K,V>set(K k, + V v) +
      Inserts the given key and value association into the tree map.
      +
      intsize() +
      Returns the number of entries in this tree map.
      +
      P3<Set<V>,Option<V>,Set<V>>split(Ord<V> ord, + K k) +
      Splits this TreeMap at the given key.
      +
      P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>>splitLookup(K k) +
      Splits this TreeMap at the given key.
      +
      List<P2<K,V>>toList() 
      List<P2<K,V>>toListReverse() 
      java.util.Map<K,V>toMutableMap() +
      A mutable map projection of this tree map.
      +
      Stream<P2<K,V>>toStream() 
      Stream<P2<K,V>>toStreamReverse() 
      java.lang.StringtoString() 
      static <K,V> TreeMap<K,V>treeMap(Ord<K> keyOrd, + List<P2<K,V>> list) +
      Deprecated.  +
      As of release 4.5, use iterableTreeMap(Ord, Iterable)
      +
      +
      static <K,V> TreeMap<K,V>treeMap(Ord<K> keyOrd, + P2<K,V>... p2s) +
      Constructs a tree map from the given elements.
      +
      TreeMap<K,V>union(java.lang.Iterable<P2<K,V>> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      TreeMap<K,V>union(TreeMap<K,V> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      P2<java.lang.Boolean,TreeMap<K,V>>update(K k, + F<V,V> f) +
      Modifies the value for the given key, if present, by applying the given function to it.
      +
      TreeMap<K,V>update(K k, + F<V,V> f, + V v) +
      Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
      +
      List<V>values() +
      Returns all values in this tree map.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <K,V> TreeMap<K,V> empty(Ord<K> keyOrd)
        +
        Constructs an empty tree map.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        an empty TreeMap with the given key order.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> treeMap(Ord<K> keyOrd,
+                                                      P2<K,V>... p2s)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        p2s - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        treeMap

        +
        @Deprecated
+public static <K,V> TreeMap<K,V> treeMap(Ord<K> keyOrd,
+                                                     List<P2<K,V>> list)
        +
        Deprecated. As of release 4.5, use iterableTreeMap(Ord, Iterable)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        list - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iterableTreeMap

        +
        public static <K,V> TreeMap<K,V> iterableTreeMap(Ord<K> keyOrd,
+                                                 java.lang.Iterable<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorTreeMap

        +
        public static <K,V> TreeMap<K,V> iteratorTreeMap(Ord<K> keyOrd,
+                                                 java.util.Iterator<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        arrayTreeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> arrayTreeMap(Ord<K> keyOrd,
+                                                           P2<K,V>... ps)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        ps - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the tree map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public TreeMap<K,V> set(K k,
+                        V v)
        +
        Inserts the given key and value association into the tree map. + If the given key is already mapped to a value, the old value is replaced with the given one.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        Returns:
        +
        A new tree map with the given value mapped to the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public TreeMap<K,V> delete(K k)
        +
        Deletes the entry in the tree map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this tree map.
        +
        Returns:
        +
        A new tree map with the entry corresponding to the given key removed.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this tree map.
        +
        +
        Returns:
        +
        The number of entries in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this tree map has any entries.
        +
        +
        Returns:
        +
        true if this tree map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this tree map.
        +
        +
        Returns:
        +
        All values in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all keys in this tree map.
        +
        +
        Returns:
        +
        All keys in this tree map.
        +
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this tree map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this tree map.
        +
        Returns:
        +
        true if this tree map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<P2<K,V>> iterator()
        +
        Returns an iterator for this map's key-value pairs. + This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<P2<K,V>>
        +
        Returns:
        +
        A iterator for this map's key-value pairs.
        +
        +
        • +
      + + + +
        +
      • +

        toMutableMap

        +
        public java.util.Map<K,V> toMutableMap()
        +
        A mutable map projection of this tree map.
        +
        +
        Returns:
        +
        A new mutable map isomorphic to this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public Stream<P2<K,V>> toStreamReverse()
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public List<P2<K,V>> toListReverse()
        +
        • +
      + + + +
        +
      • +

        fromMutableMap

        +
        public static <K,V> TreeMap<K,V> fromMutableMap(Ord<K> ord,
+                                                java.util.Map<K,V> m)
        +
        An immutable projection of the given mutable map.
        +
        +
        Parameters:
        +
        ord - An order for the map's keys.
        +
        m - A mutable map to project to an immutable one.
        +
        Returns:
        +
        A new immutable tree map isomorphic to the given mutable map.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public F<K,Option<V>> get()
        +
        Returns a first-class version of the get method for this TreeMap.
        +
        +
        Returns:
        +
        a functional representation of this TreeMap.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public P2<java.lang.Boolean,TreeMap<K,V>> update(K k,
+                                                 F<V,V> f)
        +
        Modifies the value for the given key, if present, by applying the given function to it.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function, + paired with True if the map was modified, otherwise False.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public TreeMap<K,V> update(K k,
+                           F<V,V> f,
+                           V v)
        +
        Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        v - A value to associate with the given key if the key is not already present.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public P3<Set<V>,Option<V>,Set<V>> split(Ord<V> ord,
+                                         K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A set containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A set containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are mapped to keys less than the given + key in this map, all the elements in the second set are mapped to keys greater than the given key, + and the optional value is the value associated with the given key if present, otherwise None.
        +
        +
        • +
      + + + + + +
        +
      • +

        splitLookup

        +
        public P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>> splitLookup(K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A tree map containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A tree map containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two tree maps and an optional value, where all keys in the first tree map are mapped + to keys less than the given key in this map, all the keys in the second tree map are mapped + to keys greater than the given key, and the optional value is the value associated with the + given key if present, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <W> TreeMap<K,W> map(F<V,W> f)
        +
        Maps the given function across the values of this TreeMap.
        +
        +
        Parameters:
        +
        f - A function to apply to the values of this TreeMap.
        +
        Returns:
        +
        A new TreeMap with the values transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<P2<K,V>> min()
        +
        Returns the minimum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        minKey

        +
        public Option<K> minKey()
        +
        Returns the minimum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<P2<K,V>> max()
        +
        Returns the maximum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        maxKey

        +
        public Option<K> maxKey()
        +
        Returns the maximum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(TreeMap<K,V> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other tree we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(java.lang.Iterable<P2<K,V>> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other list/set of pairs we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/TreeZipper.html b/javadoc/4.8.1/functionaljava/fj/data/TreeZipper.html new file mode 100644 index 0000000..cd7ad9a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/TreeZipper.html @@ -0,0 +1,1368 @@ + + + + + +TreeZipper (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeZipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeZipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<TreeZipper<A>>
    +
    +
    +
    +
    public final class TreeZipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<TreeZipper<A>>
    +
    Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree. + Provides navigation, insertion, deletion, and memorization of visited locations within a tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<TreeZipper<A>> iterator()
        +
        Returns an iterator of all the positions of this TreeZipper. Exists for use with the foreach syntax.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<TreeZipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> TreeZipper<A> treeZipper(Tree<A> tree,
+                                           Stream<Tree<A>> lefts,
+                                           Stream<Tree<A>> rights,
+                                           Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents)
        +
        Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
        +
        +
        Parameters:
        +
        tree - The currently selected tree.
        +
        lefts - The selected tree's left siblings, closest first.
        +
        rights - The selected tree's right siblings, closest first.
        +
        parents - The parent of the selected tree, and the parent's siblings.
        +
        Returns:
        +
        A new zipper with the given tree selected, and the given forests on the left and right.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> F<Tree<A>,F<Stream<Tree<A>>,F<Stream<Tree<A>>,F<Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>>,TreeZipper<A>>>>> treeZipper()
        +
        First-class constructor for tree zippers.
        +
        +
        Returns:
        +
        A function that returns a new tree zipper, given a selected tree, left and right siblings, + and a parent context.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        eq

        +
        public static <A> Equal<TreeZipper<A>> eq(Equal<A> e)
        +
        An Equal instance for tree zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for tree elements.
        +
        Returns:
        +
        An Equal instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<TreeZipper<A>> show(Show<A> s)
        +
        A Show instance for tree zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for tree elements.
        +
        Returns:
        +
        A Show instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        parent

        +
        public Option<TreeZipper<A>> parent()
        +
        Navigates to the parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the parent node of the current node, + or none if the current node is the root node.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public TreeZipper<A> root()
        +
        Navigates to the top-most parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the top-most parent of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<TreeZipper<A>,TreeZipper<A>> root_()
        +
        A first-class version of the root function.
        +
        +
        Returns:
        +
        A function that returns a new tree-zipper focused on the root of the given tree zipper's tree.
        +
        +
        • +
      + + + +
        +
      • +

        left

        +
        public Option<TreeZipper<A>> left()
        +
        Navigates to the left sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the left sibling of the current node, + or none if there are no siblings on the left.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public Option<TreeZipper<A>> right()
        +
        Navigates to the right sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the right sibling of the current node, + or none if there are no siblings on the right.
        +
        +
        • +
      + + + +
        +
      • +

        firstChild

        +
        public Option<TreeZipper<A>> firstChild()
        +
        Navigtes to the first child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the first child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        lastChild

        +
        public Option<TreeZipper<A>> lastChild()
        +
        Navigtes to the last child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the last child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        getChild

        +
        public Option<TreeZipper<A>> getChild(int n)
        +
        Navigates to the given child of the current location, starting at index 0.
        +
        +
        Parameters:
        +
        n - The index of the child to which to navigate.
        +
        Returns:
        +
        An optional tree zipper focused on the child node at the given index, or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public Option<TreeZipper<A>> findChild(F<Tree<A>,java.lang.Boolean> p)
        +
        Navigates to the first child of the current location, that satisfies the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by the child node.
        +
        Returns:
        +
        An optional tree zipper focused on the first child node that satisfies the given predicate, + or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> TreeZipper<A> fromTree(Tree<A> t)
        +
        Creates a new tree zipper focused on the root of the given tree.
        +
        +
        Parameters:
        +
        t - A tree over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the root of the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        fromForest

        +
        public static <A> Option<TreeZipper<A>> fromForest(Stream<Tree<A>> ts)
        +
        Creates a new tree zipper focused on the first element of the given forest.
        +
        +
        Parameters:
        +
        ts - A forest over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the first element of the given forest.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public Tree<A> toTree()
        +
        Returns the tree containing this location.
        +
        +
        Returns:
        +
        the tree containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        toForest

        +
        public Stream<Tree<A>> toForest()
        +
        Returns the forest containing this location.
        +
        +
        Returns:
        +
        the forest containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public Tree<A> focus()
        +
        Returns the tree at the currently focused node.
        +
        +
        Returns:
        +
        the tree at the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<Tree<A>> lefts()
        +
        Returns the left siblings of the currently focused node.
        +
        +
        Returns:
        +
        the left siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<Tree<A>> rights()
        +
        Returns the right siblings of the currently focused node.
        +
        +
        Returns:
        +
        the right siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        parents

        +
        public Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents()
        +
        Returns the parents of the currently focused node.
        +
        +
        Returns:
        +
        the parents of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        isRoot

        +
        public boolean isRoot()
        +
        Indicates whether the current node is at the top of the tree.
        +
        +
        Returns:
        +
        true if the current node is the root of the tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isFirst

        +
        public boolean isFirst()
        +
        Indicates whether the current node is the leftmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no left siblings, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLast

        +
        public boolean isLast()
        +
        Indicates whether the current node is the rightmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no siblings on its right, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        Indicates whether the current node is at the bottom of the tree.
        +
        +
        Returns:
        +
        true if the current node has no child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isChild

        +
        public boolean isChild()
        +
        Indicates whether the current node is a child node of another node.
        +
        +
        Returns:
        +
        true if the current node has a parent node, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        hasChildren

        +
        public boolean hasChildren()
        +
        Indicates whether the current node has any child nodes.
        +
        +
        Returns:
        +
        true if the current node has child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        setTree

        +
        public TreeZipper<A> setTree(Tree<A> t)
        +
        Replaces the current node with the given tree.
        +
        +
        Parameters:
        +
        t - A tree with which to replace the current node.
        +
        Returns:
        +
        A new tree zipper in which the focused node is replaced with the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        modifyTree

        +
        public TreeZipper<A> modifyTree(F<Tree<A>,Tree<A>> f)
        +
        Modifies the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to modify the current tree.
        +
        Returns:
        +
        A new tree zipper in which the focused node has been transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        modifyLabel

        +
        public TreeZipper<A> modifyLabel(F<A,A> f)
        +
        Modifies the label at the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to transform the current node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        setLabel

        +
        public TreeZipper<A> setLabel(A v)
        +
        Replaces the label of the current node with the given value.
        +
        +
        Parameters:
        +
        v - The new value for the node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label replaced by the given value.
        +
        +
        • +
      + + + +
        +
      • +

        getLabel

        +
        public A getLabel()
        +
        Returns the label at the current node.
        +
        +
        Returns:
        +
        the label at the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertLeft

        +
        public TreeZipper<A> insertLeft(Tree<A> t)
        +
        Inserts a tree to the left of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the left of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the right.
        +
        +
        • +
      + + + +
        +
      • +

        insertRight

        +
        public TreeZipper<A> insertRight(Tree<A> t)
        +
        Inserts a tree to the right of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the right of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the left.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownFirst

        +
        public TreeZipper<A> insertDownFirst(Tree<A> t)
        +
        Inserts a tree as the first child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the first child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownLast

        +
        public TreeZipper<A> insertDownLast(Tree<A> t)
        +
        Inserts a tree as the last child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the last child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownAt

        +
        public Option<TreeZipper<A>> insertDownAt(int n,
+                                          Tree<A> t)
        +
        Inserts a tree at the specified location in the current node's stream of children. The inserted tree + becomes the current node.
        +
        +
        Parameters:
        +
        n - The index at which to insert the given tree, starting at 0.
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, at the specified index in the current node's stream + of children, or None if the current node has fewer than n children.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Option<TreeZipper<A>> delete()
        +
        Removes the current node from the tree. The new position becomes the right sibling, or the left sibling + if the current node has no right siblings, or the parent node if the current node has no siblings.
        +
        +
        Returns:
        +
        A new tree zipper with the current node removed.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public TreeZipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the nodes in this zipper with a boolean that indicates whether that node has focus. + All of the booleans will be false, except for the focused node.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each node of this zipper paired with a boolean that is true if that + node has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> TreeZipper<B> map(F<A,B> f)
        +
        Maps the given function across this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to the label of every node.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> F<Tree<A>,TreeZipper<A>> fromTree()
        +
        First-class conversion of a Tree to the corresponding tree zipper.
        +
        +
        Returns:
        +
        A function that takes a tree to its tree zipper representation.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> left_()
        +
        A first-class version of the left() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its left sibling.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> right_()
        +
        A first-class version of the right() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its right sibling.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public TreeZipper<TreeZipper<A>> positions()
        +
        Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern). + This tree zipper becomes the focused node of the new zipper.
        +
        +
        Returns:
        +
        A tree zipper over the tree of all possible permutations of this tree zipper.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> TreeZipper<B> cobind(F<TreeZipper<A>,B> f)
        +
        Maps the given function over the tree of all positions for this zipper (comonad pattern). Returns a zipper + over the tree of results of the function application.
        +
        +
        Parameters:
        +
        f - A function to map over the tree of all positions for this zipper.
        +
        Returns:
        +
        A zipper over the tree of results of the function application.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public static <A> F2<F<Tree<A>,java.lang.Boolean>,TreeZipper<A>,Option<TreeZipper<A>>> findChild()
        +
        A first-class version of the findChild function.
        +
        +
        Returns:
        +
        a function that finds the first child, of a given tree zipper, that matches a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Validation.FailProjection.html b/javadoc/4.8.1/functionaljava/fj/data/Validation.FailProjection.html new file mode 100644 index 0000000..ad36667 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Validation.FailProjection.html @@ -0,0 +1,678 @@ + + + + + +Validation.FailProjection (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Validation.FailProjection<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation.FailProjection<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>
    +
    +
    +
    Enclosing class:
    +
    Validation<E,T>
    +
    +
    +
    +
    public static final class Validation.FailProjection<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<E>
    +
    A failing projection of a validation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> Validation<A,T>apply(Validation<F<E,A>,T> v) +
      Function application on the failing value.
      +
      <A> Validation<A,T>bind(F<E,Validation<A,T>> f) +
      Binds the given function across this validation's failing value if it has one.
      +
      booleanexists(F<E,java.lang.Boolean> f) +
      Returns false if this is a success or returns the result of the application of the given + function to the failing value.
      +
      EfailE(F0<java.lang.String> err) +
      Returns the failing value or fails with the given error message.
      +
      EfailE(java.lang.String err) +
      Returns the failing value or fails with the given error message.
      +
      <A> Option<Validation<E,A>>filter(F<E,java.lang.Boolean> f) +
      Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
      +
      booleanforall(F<E,java.lang.Boolean> f) +
      Returns true if this is a success or returns the result of the application of the given + function to the failing value.
      +
      Unitforeach(F<E,Unit> f) +
      Executes a side-effect on the failing value if there is one.
      +
      voidforeachDoEffect(Effect1<E> f) +
      Executes a side-effect on the failing value if there is one.
      +
      java.util.Iterator<E>iterator() +
      Returns an iterator for this projection.
      +
      <A> Validation<A,T>map(F<E,A> f) +
      Maps the given function across the failing side of this validation.
      +
      Eon(F<T,E> f) +
      The failing value or the application of the given function to the success value.
      +
      EorFail(E e) +
      Returns the failing value or the given value.
      +
      EorFail(F0<E> e) +
      Returns the failing value or the given value.
      +
      <A> Validation<A,T>sequence(Validation<A,T> v) +
      Performs a bind across the validation, but ignores the element value in the function.
      +
      Array<E>toArray() +
      Returns a single element array if this is a failing value, otherwise an empty list.
      +
      List<E>toList() +
      Returns a single element list if this is a failing value, otherwise an empty list.
      +
      Option<E>toOption() +
      Returns the failing value in Some if there is one, otherwise None.
      +
      Stream<E>toStream() +
      Returns a single element stream if this is a failing value, otherwise an empty list.
      +
      Validation<E,T>validation() +
      Returns the underlying validation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validation

        +
        public Validation<E,T> validation()
        +
        Returns the underlying validation.
        +
        +
        Returns:
        +
        The underlying validation.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(F0<java.lang.String> err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(java.lang.String err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        orFail

        +
        public E orFail(F0<E> e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orFail

        +
        public E orFail(E e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public E on(F<T,E> f)
        +
        The failing value or the application of the given function to the success value.
        +
        +
        Parameters:
        +
        f - The function to execute on the success value.
        +
        Returns:
        +
        The failing value or the application of the given function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<E,Unit> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<E> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A> Validation<A,T> map(F<E,A> f)
        +
        Maps the given function across the failing side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <A> Validation<A,T> bind(F<E,Validation<A,T>> f)
        +
        Binds the given function across this validation's failing value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Validation<A,T> sequence(Validation<A,T> v)
        +
        Performs a bind across the validation, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        v - The validation value to apply in the final join.
        +
        Returns:
        +
        A new validation value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <A> Option<Validation<E,A>> filter(F<E,java.lang.Boolean> f)
        +
        Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <A> Validation<A,T> apply(Validation<F<E,A>,T> v)
        +
        Function application on the failing value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the failing value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<E,java.lang.Boolean> f)
        +
        Returns true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<E,java.lang.Boolean> f)
        +
        Returns false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<E> toList()
        +
        Returns a single element list if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<E> toOption()
        +
        Returns the failing value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The failing value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<E> toArray()
        +
        Returns a single element array if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<E> toStream()
        +
        Returns a single element stream if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Validation.html b/javadoc/4.8.1/functionaljava/fj/data/Validation.html new file mode 100644 index 0000000..7fb9b80 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Validation.html @@ -0,0 +1,2499 @@ + + + + + +Validation (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Validation<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<T>
    +
    +
    +
    +
    public class Validation<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<T>
    +
    Isomorphic to Either but has renamed functions and represents failure on the left and success on the right. + This type also has accumulating functions that accept a Semigroup for binding computation while keeping error + values
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Byte>> parseByte
        +
        A function that parses a string into a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Double>> parseDouble
        +
        A function that parses a string into a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Float>> parseFloat
        +
        A function that parses a string into a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Integer>> parseInt
        +
        A function that parses a string into an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Long>> parseLong
        +
        A function that parses a string into a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Short>> parseShort
        +
        A function that parses a string into a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Validation

        +
        protected Validation(Either<E,T> e)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isFail

        +
        public final boolean isFail()
        +
        Returns true if this is a failure, false otherwise.
        +
        +
        Returns:
        +
        true if this is a failure, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSuccess

        +
        public final boolean isSuccess()
        +
        Returns true if this is a success, false otherwise.
        +
        +
        Returns:
        +
        true if this is a success, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public final E fail()
        +
        Returns the failing value, or throws an error if there is no failing value.
        +
        +
        Returns:
        +
        the failing value, or throws an error if there is no failing value.
        +
        +
        • +
      + + + +
        +
      • +

        success

        +
        public final T success()
        +
        Returns the success value, or throws an error if there is no success value.
        +
        +
        Returns:
        +
        the success value, or throws an error if there is no success value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public final <X> X validation(F<E,X> fail,
+                              F<T,X> success)
        +
        The catamorphism for validation. Folds over this validation breaking into left or right.
        +
        +
        Parameters:
        +
        fail - The function to call if this failed.
        +
        success - The function to call if this succeeded.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public final Validation.FailProjection<E,T> f()
        +
        Returns a failing projection of this validation.
        +
        +
        Returns:
        +
        a failing projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final Either<E,T> toEither()
        +
        Returns an either projection of this validation.
        +
        +
        Returns:
        +
        An either projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(F0<java.lang.String> err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(java.lang.String err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(F0<T> t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(T t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final T on(F<E,T> f)
        +
        The success value or the application of the given function to the failing value.
        +
        +
        Parameters:
        +
        f - The function to execute on the failing value.
        +
        Returns:
        +
        The success value or the application of the given function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<T,Unit> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<T> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <A> Validation<E,A> map(F<T,A> f)
        +
        Maps the given function across the success side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <A> Validation<E,A> bind(F<T,Validation<E,A>> f)
        +
        Binds the given function across this validation's success value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <A> Validation<E,A> sequence(Validation<E,A> v)
        +
        Anonymous bind through this validation.
        +
        +
        Parameters:
        +
        v - The value to bind with.
        +
        Returns:
        +
        A validation after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <E,A> Validation<E,List<A>> sequence(Semigroup<E> s,
+                                                   List<Validation<E,A>> list)
        +
        If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <A> Option<Validation<A,T>> filter(F<T,java.lang.Boolean> f)
        +
        Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <A> Validation<E,A> apply(Validation<E,F<T,A>> v)
        +
        Function application on the success value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the success value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<T,java.lang.Boolean> f)
        +
        Returns true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<T,java.lang.Boolean> f)
        +
        Returns false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<T> toList()
        +
        Returns a single element list if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<T> toOption()
        +
        Returns the success value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The success value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<T> toArray()
        +
        Returns a single element array if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<T> toStream()
        +
        Returns a single element stream if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        accumapply

        +
        public final <A> Validation<E,A> accumapply(Semigroup<E> s,
+                                            Validation<E,F<T,A>> v)
        +
        Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if
        +
        v - The validating function to apply.
        +
        Returns:
        +
        A failing validation if this or the given validation failed (with errors accumulated if both) or a + succeeding validation if both succeeded.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F<T,F<A,B>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F2<T,A,B> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A> Option<E> accumulate(Semigroup<E> s,
+                                      Validation<E,A> va)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F<T,F<A,F<B,C>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F3<T,A,B,C> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Option<E> accumulate(Semigroup<E> s,
+                                        Validation<E,A> va,
+                                        Validation<E,B> vb)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F<T,F<A,F<B,F<C,D>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F4<T,A,B,C,D> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Option<E> accumulate(Semigroup<E> s,
+                                          Validation<E,A> va,
+                                          Validation<E,B> vb,
+                                          Validation<E,C> vc)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F<T,F<A,F<B,F<C,F<D,E$>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F5<T,A,B,C,D,E$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Option<E> accumulate(Semigroup<E> s,
+                                            Validation<E,A> va,
+                                            Validation<E,B> vb,
+                                            Validation<E,C> vc,
+                                            Validation<E,D> vd)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F<T,F<A,F<B,F<C,F<D,F<E$,F$>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F6<T,A,B,C,D,E$,F$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Option<E> accumulate(Semigroup<E> s,
+                                               Validation<E,A> va,
+                                               Validation<E,B> vb,
+                                               Validation<E,C> vc,
+                                               Validation<E,D> vd,
+                                               Validation<E,E$> ve)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F7<T,A,B,C,D,E$,F$,G> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Option<E> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  Validation<E,D> vd,
+                                                  Validation<E,E$> ve,
+                                                  Validation<E,F$> vf)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F8<T,A,B,C,D,E$,F$,G,H> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Option<E> accumulate(Semigroup<E> s,
+                                                    Validation<E,A> va,
+                                                    Validation<E,B> vb,
+                                                    Validation<E,C> vc,
+                                                    Validation<E,D> vd,
+                                                    Validation<E,E$> ve,
+                                                    Validation<E,F$> vf,
+                                                    Validation<E,G> vg)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<T> iterator()
        +
        Returns an iterator for this validation. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<T>
        +
        Returns:
        +
        A iterator for this validation.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequenceNonCumulative

        +
        public static <A,E> Validation<List<E>,List<A>> sequenceNonCumulative(List<Validation<E,A>> list)
        +
        If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values. Does not accumulate the failures into a + single failure using a semigroup.
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<Validation<E,C>> traverseIO(F<T,IO<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <C> P1<Validation<E,C>> traverseP1(F<T,P1<C>> f)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        nel

        +
        public final Validation<NonEmptyList<E>,T> nel()
        +
        Puts this validation's failing value in a non-empty list if there is one.
        +
        +
        Returns:
        +
        A validation with its failing value in a non-empty list if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> Validation<E,T> validation(Either<E,T> e)
        +
        Construct a validation using the given either value.
        +
        +
        Parameters:
        +
        e - The either value to construct a validation with.
        +
        Returns:
        +
        A validation using the given either value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> F<Either<E,T>,Validation<E,T>> validation()
        +
        Returns a function that constructs a validation with an either.
        +
        +
        Returns:
        +
        A function that constructs a validation with an either.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <E,T> F<Validation<E,T>,Either<E,T>> either()
        +
        Returns a function that constructs an either with a validation.
        +
        +
        Returns:
        +
        A function that constructs an either with a validation.
        +
        +
        • +
      + + + + + +
        +
      • +

        success

        +
        public static <E,T> Validation<E,T> success(T t)
        +
        Returns a succeeding validation containing the given value.
        +
        +
        Parameters:
        +
        t - The value to use in the succeeding validation.
        +
        Returns:
        +
        A succeeding validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <E,T> Validation<E,T> fail(E e)
        +
        Returns a failing validation containing the given value.
        +
        +
        Parameters:
        +
        e - The value to use in the failing validation.
        +
        Returns:
        +
        A failing validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        failNEL

        +
        public static <E,T> Validation<NonEmptyList<E>,T> failNEL(E e)
        +
        Returns a failing validation containing a non-empty list that contains the given value.
        +
        +
        Parameters:
        +
        e - The value to use in a non-empty list for the failing validation.
        +
        Returns:
        +
        A failing validation containing a non-empty list that contains the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        condition

        +
        public static <E,T> Validation<E,T> condition(boolean c,
+                                              E e,
+                                              T t)
        +
        Returns a validation based on a boolean condition. If the condition is true, the validation succeeds, + otherwise it fails.
        +
        +
        Parameters:
        +
        c - The condition to base the returned validation on.
        +
        e - The failing value to use if the condition is false.
        +
        t - The succeeding value to use if the condition is true.
        +
        Returns:
        +
        A validation based on a boolean condition.
        +
        +
        • +
      + + + +
        +
      • +

        parseByte

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Byte> parseByte(java.lang.String s)
        +
        Parses the given string into a byte.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse byte or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Double> parseDouble(java.lang.String s)
        +
        Parses the given string into a double.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse double or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Float> parseFloat(java.lang.String s)
        +
        Parses the given string into a float.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse float or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Integer> parseInt(java.lang.String s)
        +
        Parses the given string into a integer.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse integer or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Long> parseLong(java.lang.String s)
        +
        Parses the given string into a long.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse long or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Short> parseShort(java.lang.String s)
        +
        Parses the given string into a short.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse short or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public static <A,B> P2<List<A>,List<B>> partition(List<Validation<A,B>> list)
        +
        Partitions the list into the list of fails and the list of successes
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Writer.html b/javadoc/4.8.1/functionaljava/fj/data/Writer.html new file mode 100644 index 0000000..312003a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Writer.html @@ -0,0 +1,380 @@ + + + + + +Writer (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Writer<W,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Writer<W,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Writer<W,A>
+extends java.lang.Object
    +
    Created by MarkPerry on 7/07/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public P2<W,A> run()
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        • +
      + + + +
        +
      • +

        log

        +
        public W log()
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<W> monoid()
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     W w,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        tell

        +
        public Writer<W,A> tell(W w)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Writer<W,B> map(F<A,B> f)
        +
        • +
      + + + + + + + + + +
        +
      • +

        unit

        +
        public static <B> Writer<java.lang.String,B> unit(B b)
        +
        • +
      + + + +
        +
      • +

        stringLogger

        +
        public static <A> F<A,Writer<java.lang.String,A>> stringLogger()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/Zipper.html b/javadoc/4.8.1/functionaljava/fj/data/Zipper.html new file mode 100644 index 0000000..89ae0df --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/Zipper.html @@ -0,0 +1,1286 @@ + + + + + +Zipper (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Zipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Zipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<Zipper<A>>
    +
    +
    +
    +
    public final class Zipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<Zipper<A>>
    +
    Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream. Focus can be moved forward and backwards through the stream, elements can be inserted + before or after the focused position, and the focused item can be deleted. +

    + Based on the pointedlist library by Jeff Wheeler.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanatEnd() +
      Returns whether the focus is on the last element.
      +
      booleanatStart() +
      Returns whether the focus is on the first element.
      +
      <B> Zipper<B>cobind(F<Zipper<A>,B> f) +
      Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
      +
      Zipper<A>cycleNext() +
      Move the focus to the next element.
      +
      Zipper<A>cyclePrevious() +
      Move the focus to the previous element.
      +
      Option<Zipper<A>>deleteLeft() +
      Possibly deletes the element at the focus, then moves the element on the left into focus.
      +
      Option<Zipper<A>>deleteLeftCycle() +
      Possibly deletes the element at the focus, then move the element on the left into focus.
      +
      Zipper<A>deleteOthers() +
      Deletes all elements in the zipper except the focus.
      +
      Option<Zipper<A>>deleteRight() +
      Possibly deletes the element at the focus, then moves the element on the right into focus.
      +
      Option<Zipper<A>>deleteRightCycle() +
      Possibly deletes the element at the focus, then move the element on the right into focus.
      +
      static <A> Equal<Zipper<A>>eq(Equal<A> e) +
      An Equal instance for Zippers.
      +
      booleanequals(java.lang.Object other) 
      Option<Zipper<A>>find(F<A,java.lang.Boolean> p) +
      Moves the focus to the element matching the given predicate, if present.
      +
      Afocus() +
      Returns the focus element of this zipper.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Performs a right-fold reduction across this zipper.
      +
      static <A> Option<Zipper<A>>fromStream(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      static <A> Option<Zipper<A>>fromStreamEnd(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      inthashCode() 
      intindex() +
      Returns the index of the focus.
      +
      Zipper<A>insertLeft(A a) +
      Inserts an element to the left of the focus, then moves the focus to the new element.
      +
      Zipper<A>insertRight(A a) +
      Inserts an element to the right of the focus, then moves the focus to the new element.
      +
      java.util.Iterator<Zipper<A>>iterator() +
      Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
      +
      Stream<A>lefts() +
      Returns a Stream of the elements to the left of focus.
      +
      intlength() +
      Returns the length of this zipper.
      +
      <B> Zipper<B>map(F<A,B> f) +
      Maps the given function across the elements of this zipper (covariant functor pattern).
      +
      static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>>move() +
      A first-class version of the move function.
      +
      Option<Zipper<A>>move(int n) +
      Move the focus to the specified index.
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>next_() +
      First-class version of the next() function.
      +
      Option<Zipper<A>>next() +
      Possibly moves the focus to the next element in the list.
      +
      static <A> Ord<Zipper<A>>ord(Ord<A> o) +
      An Ord instance for Zippers.
      +
      static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>>p_() +
      A first-class function that yields the product-3 representation of a given Zipper.
      +
      P3<Stream<A>,A,Stream<A>>p() +
      Returns the product-3 representation of this Zipper.
      +
      Zipper<Zipper<A>>positions() +
      Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>previous_() +
      First-class version of the previous() function.
      +
      Option<Zipper<A>>previous() +
      Possibly moves the focus to the previous element in the list.
      +
      Zipper<A>replace(A a) +
      Replaces the element in focus with the given element.
      +
      Stream<A>rights() +
      Returns a Stream of the elements to the right of focus.
      +
      static <A> Show<Zipper<A>>show(Show<A> s) +
      A Show instance for Zippers.
      +
      static <A> Zipper<A>single(A a) +
      Creates a new zipper with a single element.
      +
      Stream<A>toStream() +
      Returns the Stream representation of this zipper.
      +
      Zipper<A>tryNext() +
      Attempts to move the focus to the next element, or throws an error if there are no more elements.
      +
      Zipper<A>tryPrevious() +
      Attempts to move the focus to the previous element, or throws an error if there are no more elements.
      +
      static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>>zipper() +
      First-class constructor of zippers.
      +
      static <A> Zipper<A>zipper(P3<Stream<A>,A,Stream<A>> p) +
      Creates a new Zipper from the given triple.
      +
      static <A> Zipper<A>zipper(Stream<A> left, + A focus, + Stream<A> right) +
      Creates a new Zipper with the given streams before and after the focus, and the given focused item.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F<A,F<B,C>> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F2<A,B,C> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      Zipper<P2<A,java.lang.Boolean>>zipWithFocus() +
      Zips the elements of this zipper with a boolean that indicates whether that element has focus.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(Stream<A> left,
+                                   A focus,
+                                   Stream<A> right)
        +
        Creates a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        Parameters:
        +
        left - The stream of elements before the focus.
        +
        focus - The element under focus.
        +
        right - The stream of elements after the focus.
        +
        Returns:
        +
        a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(P3<Stream<A>,A,Stream<A>> p)
        +
        Creates a new Zipper from the given triple.
        +
        +
        Parameters:
        +
        p - A triple of the elements before the focus, the focus element, and the elements after the focus, + respectively.
        +
        Returns:
        +
        a new Zipper created from the given triple.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>> zipper()
        +
        First-class constructor of zippers.
        +
        +
        Returns:
        +
        A function that yields a new zipper given streams on the left and right and a focus element.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<Stream<A>,A,Stream<A>> p()
        +
        Returns the product-3 representation of this Zipper.
        +
        +
        Returns:
        +
        the product-3 representation of this Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>> p_()
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        Returns:
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<Zipper<A>> ord(Ord<A> o)
        +
        An Ord instance for Zippers.
        +
        +
        Parameters:
        +
        o - An Ord instance for the element type.
        +
        Returns:
        +
        An Ord instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static <A> Equal<Zipper<A>> eq(Equal<A> e)
        +
        An Equal instance for Zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for the element type.
        +
        Returns:
        +
        An Equal instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<Zipper<A>> show(Show<A> s)
        +
        A Show instance for Zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for the element type.
        +
        Returns:
        +
        A Show instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Zipper<B> map(F<A,B> f)
        +
        Maps the given function across the elements of this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to all elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B z)
        +
        Performs a right-fold reduction across this zipper.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of this zipper.
        +
        z - The beginning value to start the application from.
        +
        Returns:
        +
        the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Zipper<A> single(A a)
        +
        Creates a new zipper with a single element.
        +
        +
        Parameters:
        +
        a - The focus element of the new zipper.
        +
        Returns:
        +
        a new zipper with a single element which is in focus.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static <A> Option<Zipper<A>> fromStream(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's head will be the focus of the zipper, and the rest of the stream will follow + on the right side.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        fromStreamEnd

        +
        public static <A> Option<Zipper<A>> fromStreamEnd(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's last element will be the focus of the zipper, following the rest of the stream in order, + to the left.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public A focus()
        +
        Returns the focus element of this zipper.
        +
        +
        Returns:
        +
        the focus element of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public Option<Zipper<A>> next()
        +
        Possibly moves the focus to the next element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryNext

        +
        public Zipper<A> tryNext()
        +
        Attempts to move the focus to the next element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        previous

        +
        public Option<Zipper<A>> previous()
        +
        Possibly moves the focus to the previous element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryPrevious

        +
        public Zipper<A> tryPrevious()
        +
        Attempts to move the focus to the previous element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        next_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> next_()
        +
        First-class version of the next() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the next element.
        +
        +
        • +
      + + + +
        +
      • +

        previous_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> previous_()
        +
        First-class version of the previous() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the previous element.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertLeft

        +
        public Zipper<A> insertLeft(A a)
        +
        Inserts an element to the left of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its right.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertRight

        +
        public Zipper<A> insertRight(A a)
        +
        Inserts an element to the right of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeft

        +
        public Option<Zipper<A>> deleteLeft()
        +
        Possibly deletes the element at the focus, then moves the element on the left into focus. + If no element is on the left, focus on the element to the right. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRight

        +
        public Option<Zipper<A>> deleteRight()
        +
        Possibly deletes the element at the focus, then moves the element on the right into focus. + If no element is on the right, focus on the element to the left. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteOthers

        +
        public Zipper<A> deleteOthers()
        +
        Deletes all elements in the zipper except the focus.
        +
        +
        Returns:
        +
        A new zipper with the focus element as the only element.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this zipper.
        +
        +
        Returns:
        +
        the length of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        atStart

        +
        public boolean atStart()
        +
        Returns whether the focus is on the first element.
        +
        +
        Returns:
        +
        true if the focus is on the first element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        Returns whether the focus is on the last element.
        +
        +
        Returns:
        +
        true if the focus is on the last element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public Zipper<Zipper<A>> positions()
        +
        Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
        +
        +
        Returns:
        +
        a zipper of variations of the provided zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Zipper<B> cobind(F<Zipper<A>,B> f)
        +
        Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
        +
        +
        Parameters:
        +
        f - The comonadic function to apply for each variation of this zipper.
        +
        Returns:
        +
        A new zipper, with the given function applied for each variation of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public Zipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the elements of this zipper with a boolean that indicates whether that element has focus. + All of the booleans will be false, except the focused element.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each element of this zipper paired with a boolean that is true if that + element has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public Option<Zipper<A>> move(int n)
        +
        Move the focus to the specified index.
        +
        +
        Parameters:
        +
        n - The index to which to move the focus.
        +
        Returns:
        +
        A new zipper with the focus moved to the specified index, or none if there is no such index.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>> move()
        +
        A first-class version of the move function.
        +
        +
        Returns:
        +
        A function that moves the focus of the given zipper to the given index.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<Zipper<A>> find(F<A,java.lang.Boolean> p)
        +
        Moves the focus to the element matching the given predicate, if present.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        A new zipper with the nearest matching element focused if it is present in this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public int index()
        +
        Returns the index of the focus.
        +
        +
        Returns:
        +
        the index of the focus.
        +
        +
        • +
      + + + +
        +
      • +

        cycleNext

        +
        public Zipper<A> cycleNext()
        +
        Move the focus to the next element. If the last element is focused, loop to the first element.
        +
        +
        Returns:
        +
        A new zipper with the next element focused, unless the last element is currently focused, in which case + the first element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        cyclePrevious

        +
        public Zipper<A> cyclePrevious()
        +
        Move the focus to the previous element. If the first element is focused, loop to the last element.
        +
        +
        Returns:
        +
        A new zipper with the previous element focused, unless the first element is currently focused, + in which case the last element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeftCycle

        +
        public Option<Zipper<A>> deleteLeftCycle()
        +
        Possibly deletes the element at the focus, then move the element on the left into focus. If no element is on the + left, focus on the last element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the previous element to the left, or the last + element if there is no element to the left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRightCycle

        +
        public Option<Zipper<A>> deleteRightCycle()
        +
        Possibly deletes the element at the focus, then move the element on the right into focus. If no element is on the + right, focus on the first element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the next element to the right, or the first + element if there is no element to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public Zipper<A> replace(A a)
        +
        Replaces the element in focus with the given element.
        +
        +
        Parameters:
        +
        a - An element to replace the focused element with.
        +
        Returns:
        +
        A new zipper with the given element in focus.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns the Stream representation of this zipper.
        +
        +
        Returns:
        +
        A stream that contains all the elements of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<A> lefts()
        +
        Returns a Stream of the elements to the left of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the left of focus.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<A> rights()
        +
        Returns a Stream of the elements to the right of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the right of focus.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F2<A,B,C> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F<A,F<B,C>> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<Zipper<A>> iterator()
        +
        Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<Zipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Deep.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Deep.html new file mode 100644 index 0000000..a0de010 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Deep.html @@ -0,0 +1,727 @@ + + + + + +Deep (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Deep<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Deep<V,A>
+extends FingerTree<V,A>
    +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prefix

        +
        public Digit<V,A> prefix()
        +
        Returns the first few elements of this tree.
        +
        +
        Returns:
        +
        the first few elements of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        middle

        +
        public FingerTree<V,Node<V,A>> middle()
        +
        Returns a finger tree of the inner nodes of this tree.
        +
        +
        Returns:
        +
        a finger tree of the inner nodes of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        suffix

        +
        public Digit<V,A> suffix()
        +
        Returns the last few elements of this tree.
        +
        +
        Returns:
        +
        the last few elements of this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the tree. Matches the function on the Deep tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Digit.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Digit.html new file mode 100644 index 0000000..51f4395 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Digit.html @@ -0,0 +1,480 @@ + + + + + +Digit (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Digit<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Digit<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Four, One, Three, Two
    +
    +
    +
    +
    public abstract class Digit<V,A>
+extends java.lang.Object
    +
    A digit is a vector of 1-4 elements. Serves as a pointer to the prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Digit<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps a function across the elements of this digit, measuring with the given measurement.
      +
      abstract <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Vmeasure() +
      Returns the sum of the measurements of this digit according to the monoid.
      +
      AreduceLeft(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      AreduceRight(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      abstract Stream<A>toStream() 
      java.lang.StringtoString() 
      FingerTree<V,A>toTree() +
      Returns the tree representation of this digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public final A reduceRight(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public final A reduceLeft(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Digit<V,B> map(F<A,B> f,
+                                Measured<V,B> m)
        +
        Maps a function across the elements of this digit, measuring with the given measurement.
        +
        +
        Parameters:
        +
        f - A function to map across the elements of this digit.
        +
        m - A measuring for the function's domain (destination type).
        +
        Returns:
        +
        A new digit with the same structure as this digit, but with all elements transformed + with the given function and measured with the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<One<V,A>,B> one,
+                            F<Two<V,A>,B> two,
+                            F<Three<V,A>,B> three,
+                            F<Four<V,A>,B> four)
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        Returns the sum of the measurements of this digit according to the monoid.
        +
        +
        Returns:
        +
        the sum of the measurements of this digit according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public final FingerTree<V,A> toTree()
        +
        Returns the tree representation of this digit.
        +
        +
        Returns:
        +
        the tree representation of this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Empty.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Empty.html new file mode 100644 index 0000000..291a395 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Empty.html @@ -0,0 +1,667 @@ + + + + + +Empty (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Empty<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Empty<V,A>
+extends FingerTree<V,A>
    +
    The empty tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns zero.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        Zero.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the empty tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/FingerTree.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/FingerTree.html new file mode 100644 index 0000000..3bae9b4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/FingerTree.html @@ -0,0 +1,870 @@ + + + + + +FingerTree (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class FingerTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.FingerTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    V - The monoidal type with which to annotate nodes.
    +
    A - The type of the tree's elements.
    +
    +
    +
    Direct Known Subclasses:
    +
    Deep, Empty, Single
    +
    +
    +
    +
    public abstract class FingerTree<V,A>
+extends java.lang.Object
    +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. +

    + This class serves as a datastructure construction kit, rather than a datastructure in its own right. By supplying + a monoid, a measurement function, insertion, deletion, and so forth, any purely functional datastructure can be + emulated. See Seq for an example. +

    + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract FingerTree<V,A>append(FingerTree<V,A> t) +
      Appends one finger tree to another.
      +
      abstract FingerTree<V,A>cons(A a) +
      Adds the given element to this tree as the first element.
      +
      static <V,A> FingerTree<V,A>empty(Monoid<V> m, + F<A,V> f) +
      Creates an empty finger tree with elements of type A and node annotations + of type V.
      +
      static <A> FingerTree<java.lang.Integer,A>emptyIntAddition() 
      static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>>emptyIntMax() +
      Returns a finger tree which combines the integer node annotations with the + maximum function.
      +
      <B> FingerTree<V,A>filter(F<A,java.lang.Boolean> f) 
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds the tree to the left with the given function and the given initial element.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds the tree to the right with the given function and the given initial element.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      abstract Ahead() +
      The first element of this tree.
      +
      Option<A>headOption() 
      abstract FingerTree<V,A>init() +
      The tree without the last element.
      +
      booleanisEmpty() +
      Indicates whether this tree is empty.
      +
      abstract Alast() +
      The last element of this tree.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      abstract <B> FingerTree<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps the given function across this tree, measuring with the given Measured instance.
      +
      abstract <B> Bmatch(F<Empty<V,A>,B> empty, + F<Single<V,A>,B> single, + F<Deep<V,A>,B> deep) +
      Provides pattern matching on trees.
      +
      abstract Vmeasure() +
      Returns the sum of this tree's annotations.
      +
      Measured<V,A>measured() 
      static <V,A> Measured<V,A>measured(Monoid<V> monoid, + F<A,V> measure) +
      Constructs a Measured instance for the element type, given a monoid and a measuring function.
      +
      static <V,A> MakeTree<V,A>mkTree(Measured<V,A> m) +
      Returns a builder of trees and tree components that annotates them using the given Measured instance.
      +
      abstract AreduceLeft(F<A,F<A,A>> f) +
      Folds the tree to the left with the given function.
      +
      abstract AreduceRight(F<A,F<A,A>> f) +
      Folds the tree to the right with the given function.
      +
      abstract FingerTree<V,A>snoc(A a) +
      Adds the given element to this tree as the last element.
      +
      P2<FingerTree<V,A>,FingerTree<V,A>>split(F<V,java.lang.Boolean> predicate) +
      Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
      +
      P3<FingerTree<V,A>,A,FingerTree<V,A>>split1(F<V,java.lang.Boolean> predicate) +
      Like split, but returns the element where pred first holds separately.
      +
      abstract FingerTree<V,A>tail() +
      The tree without the first element.
      +
      abstract Stream<A>toStream() 
      <B> Buncons(B nil, + F2<A,FingerTree<V,A>,B> cons) +
      Performs a reduction on this finger tree using the given arguments.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B z)
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public abstract A reduceRight(F<A,F<A,A>> f)
        +
        Folds the tree to the right with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B z)
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public abstract A reduceLeft(F<A,F<A,A>> f)
        +
        Folds the tree to the left with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public abstract <B> FingerTree<V,B> map(F<A,B> f,
+                                        Measured<V,B> m)
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Parameters:
        +
        f - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <B> FingerTree<V,A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public abstract V measure()
        +
        Returns the sum of this tree's annotations.
        +
        +
        Returns:
        +
        the sum of this tree's annotations.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Indicates whether this tree is empty.
        +
        +
        Returns:
        +
        true if this tree is the empty tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public final Measured<V,A> measured()
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Empty<V,A>,B> empty,
+                            F<Single<V,A>,B> single,
+                            F<Deep<V,A>,B> deep)
        +
        Provides pattern matching on trees. This is the Church encoding of the FingerTree datatype.
        +
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> monoid,
+                                           F<A,V> measure)
        +
        Constructs a Measured instance for the element type, given a monoid and a measuring function.
        +
        +
        Parameters:
        +
        monoid - A monoid for the measures.
        +
        measure - A function with which to measure element values.
        +
        Returns:
        +
        A Measured instance for the given element type, that uses the given monoid and measuring function.
        +
        +
        • +
      + + + +
        +
      • +

        mkTree

        +
        public static <V,A> MakeTree<V,A> mkTree(Measured<V,A> m)
        +
        Returns a builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        Parameters:
        +
        m - A Measured instance with which to annotate trees, digits, and nodes.
        +
        Returns:
        +
        A builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public abstract FingerTree<V,A> cons(A a)
        +
        Adds the given element to this tree as the first element.
        +
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public abstract FingerTree<V,A> snoc(A a)
        +
        Adds the given element to this tree as the last element.
        +
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F2<A,FingerTree<V,A>,B> cons)
        +
        Performs a reduction on this finger tree using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this finger tree is empty.
        +
        cons - The function to apply to the head and tail of this finger tree if it is not empty.
        +
        Returns:
        +
        A reduction on this finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public abstract A last()
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract FingerTree<V,A> tail()
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public abstract FingerTree<V,A> init()
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public abstract FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Appends one finger tree to another.
        +
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<FingerTree<V,A>,FingerTree<V,A>> split(F<V,java.lang.Boolean> predicate)
        +
        Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subtree containing elements before the point where pred first holds and the subtree + containing element at and after the point where pred first holds. Empty if pred never holds.
        +
        +
        • +
      + + + +
        +
      • +

        split1

        +
        public final P3<FingerTree<V,A>,A,FingerTree<V,A>> split1(F<V,java.lang.Boolean> predicate)
        +
        Like split, but returns the element where pred first holds separately. + + Throws an error if the tree is empty.
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        emptyIntAddition

        +
        public static <A> FingerTree<java.lang.Integer,A> emptyIntAddition()
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <V,A> FingerTree<V,A> empty(Monoid<V> m,
+                                          F<A,V> f)
        +
        Creates an empty finger tree with elements of type A and node annotations + of type V.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations
        +
        f - Function to convert node element to annotation.
        +
        Returns:
        +
        An empty finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        emptyIntMax

        +
        public static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>> emptyIntMax()
        +
        Returns a finger tree which combines the integer node annotations with the + maximum function. A priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Four.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Four.html new file mode 100644 index 0000000..1202795 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Four.html @@ -0,0 +1,419 @@ + + + + + +Four (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Four<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Four<V,A>
+extends Digit<V,A>
    +
    A four-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V4<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V4<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/MakeTree.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/MakeTree.html new file mode 100644 index 0000000..8fdcdbb --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/MakeTree.html @@ -0,0 +1,544 @@ + + + + + +MakeTree (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class MakeTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class MakeTree<V,A>
+extends java.lang.Object
    +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public FingerTree<V,A> empty()
        +
        Constructs an empty tree.
        +
        +
        Returns:
        +
        The empty tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public FingerTree<V,A> single(A a)
        +
        Constructs a singleton tree.
        +
        +
        Parameters:
        +
        a - A single element for the tree.
        +
        Returns:
        +
        A tree with the given value as the single element.
        +
        +
        • +
      + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree. This structure consists of two digits, of 1 to 4 elements each, on the left and right, + with the rest of the tree in the middle.
        +
        +
        Parameters:
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle.
        +
        +
        • +
      + + + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(V v,
+                            Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree with the given annotation value.
        +
        +
        Parameters:
        +
        v - The value with which to annotate this tree.
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle, and annotated with the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        one

        +
        public One<V,A> one(A a)
        +
        A digit of one element.
        +
        +
        Parameters:
        +
        a - The element of the digit.
        +
        Returns:
        +
        A digit of the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        two

        +
        public Two<V,A> two(A a,
+                    A b)
        +
        A digit of two elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        three

        +
        public Three<V,A> three(A a,
+                        A b,
+                        A c)
        +
        A digit of three elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        four

        +
        public Four<V,A> four(A a,
+                      A b,
+                      A c,
+                      A d)
        +
        A digit of four elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        d - The fifth element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(A a,
+                        A b)
        +
        A binary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The right child of the node.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(A a,
+                        A b,
+                        A c)
        +
        A trinary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The middle child of the node.
        +
        c - The right child of the node.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(V2<A> v)
        +
        A binary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(V3<A> v)
        +
        A trinary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Measured.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Measured.html new file mode 100644 index 0000000..5181b13 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Measured.html @@ -0,0 +1,390 @@ + + + + + +Measured (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Measured<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Measured<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Measured<V,A>
+extends java.lang.Object
    +
    Determines how the elements of a tree are measured and how measures are summed. Consists of a monoid and a + measuring function. Different instances of this class will result in different behaviours for the tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> m,
+                                           F<A,V> measure)
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<V> monoid()
        +
        Returns the monoid used to sum measures.
        +
        +
        Returns:
        +
        the monoid used to sum measures.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public F<A,V> measure()
        +
        Returns the measuring function.
        +
        +
        Returns:
        +
        the measuring function.
        +
        +
        • +
      + + + + + +
        +
      • +

        measure

        +
        public V measure(A a)
        +
        Measures a given element.
        +
        +
        Parameters:
        +
        a - An element to measure.
        +
        Returns:
        +
        the element's measurement.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public V sum(V a,
+             V b)
        +
        Sums the given measurements with the monoid.
        +
        +
        Parameters:
        +
        a - A measurement to add to another.
        +
        b - A measurement to add to another.
        +
        Returns:
        +
        The sum of the two measurements.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public V zero()
        +
        Returns the identity measurement for the monoid.
        +
        +
        Returns:
        +
        the identity measurement for the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        nodeMeasured

        +
        public Measured<V,Node<V,A>> nodeMeasured()
        +
        A measured instance for nodes.
        +
        +
        Returns:
        +
        A measured instance for nodes.
        +
        +
        • +
      + + + +
        +
      • +

        digitMeasured

        +
        public Measured<V,Digit<V,A>> digitMeasured()
        +
        A measured instance for digits.
        +
        +
        Returns:
        +
        A measured instance for digits.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node.html new file mode 100644 index 0000000..99e4459 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node.html @@ -0,0 +1,399 @@ + + + + + +Node (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Node<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Node2, Node3
    +
    +
    +
    +
    public abstract class Node<V,A>
+extends java.lang.Object
    +
    An inner node of the 2-3 tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        • +
      + + + +
        +
      • +

        foldLeft_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldLeft_(F<B,F<A,B>> bff)
        +
        • +
      + + + +
        +
      • +

        foldRight_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldRight_(F<A,F<B,B>> aff)
        +
        • +
      + + + + + + + +
        +
      • +

        liftM

        +
        public static <V,A,B> F<Node<V,A>,Node<V,B>> liftM(F<A,B> f,
+                                                   Measured<V,B> m)
        +
        • +
      + + + +
        +
      • +

        toDigit

        +
        public abstract Digit<V,A> toDigit()
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Node2<V,A>,B> n2,
+                            F<Node3<V,A>,B> n3)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node2.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node2.html new file mode 100644 index 0000000..b43bdd1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node2.html @@ -0,0 +1,396 @@ + + + + + +Node2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node2<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node2<V,A>
+extends Node<V,A>
    +
    A two-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V2<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node3.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node3.html new file mode 100644 index 0000000..765ffe1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Node3.html @@ -0,0 +1,396 @@ + + + + + +Node3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node3<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node3<V,A>
+extends Node<V,A>
    +
    A three-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V3<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/One.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/One.html new file mode 100644 index 0000000..a818e7d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/One.html @@ -0,0 +1,419 @@ + + + + + +One (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class One<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class One<V,A>
+extends Digit<V,A>
    +
    A single-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      Avalue() +
      Returns the single element in this digit.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element in this digit.
        +
        +
        Returns:
        +
        the single element in this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Single.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Single.html new file mode 100644 index 0000000..d0eb519 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Single.html @@ -0,0 +1,687 @@ + + + + + +Single (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Single<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Single<V,A>
+extends FingerTree<V,A>
    +
    A tree with a single element.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the annotation of this tree's single element.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the annotation of this tree's single element.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the singleton tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element of this tree.
        +
        +
        Returns:
        +
        the single element of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Three.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Three.html new file mode 100644 index 0000000..9e95be5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Three.html @@ -0,0 +1,419 @@ + + + + + +Three (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Three<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Three<V,A>
+extends Digit<V,A>
    +
    A three-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V3<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V3<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Two.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Two.html new file mode 100644 index 0000000..6187c5a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/Two.html @@ -0,0 +1,419 @@ + + + + + +Two (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Two<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Two<V,A>
+extends Digit<V,A>
    +
    A two-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V2<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V2<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-frame.html new file mode 100644 index 0000000..42c117d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-frame.html @@ -0,0 +1,33 @@ + + + + + +fj.data.fingertrees (core 4.8.1 API) + + + + + +

fj.data.fingertrees

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-summary.html new file mode 100644 index 0000000..644d821 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-summary.html @@ -0,0 +1,236 @@ + + + + + +fj.data.fingertrees (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.fingertrees

+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Deep<V,A> +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    Digit<V,A> +
    A digit is a vector of 1-4 elements.
    +
    Empty<V,A> +
    The empty tree.
    +
    FingerTree<V,A> +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
    +
    Four<V,A> +
    A four-element prefix or suffix of a finger tree.
    +
    MakeTree<V,A> +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    Measured<V,A> +
    Determines how the elements of a tree are measured and how measures are summed.
    +
    Node<V,A> +
    An inner node of the 2-3 tree.
    +
    Node2<V,A> +
    A two-element inner tree node.
    +
    Node3<V,A> +
    A three-element inner tree node.
    +
    One<V,A> +
    A single-element prefix or suffix of a finger tree.
    +
    Single<V,A> +
    A tree with a single element.
    +
    Three<V,A> +
    A three-element prefix or suffix of a finger tree.
    +
    Two<V,A> +
    A two-element prefix or suffix of a finger tree.
    +
    +
    • +
+ + + +

Package fj.data.fingertrees Description

+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. + + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-tree.html new file mode 100644 index 0000000..e1d1313 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/fingertrees/package-tree.html @@ -0,0 +1,157 @@ + + + + + +fj.data.fingertrees Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.fingertrees

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.fingertrees.Digit<V,A> +
        +
      • fj.data.fingertrees.Four<V,A>
        • +
      • fj.data.fingertrees.One<V,A>
        • +
      • fj.data.fingertrees.Three<V,A>
        • +
      • fj.data.fingertrees.Two<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.FingerTree<V,A> +
        +
      • fj.data.fingertrees.Deep<V,A>
        • +
      • fj.data.fingertrees.Empty<V,A>
        • +
      • fj.data.fingertrees.Single<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    • fj.data.fingertrees.Measured<V,A>
      • +
    • fj.data.fingertrees.Node<V,A> +
        +
      • fj.data.fingertrees.Node2<V,A>
        • +
      • fj.data.fingertrees.Node3<V,A>
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/BitSet.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/BitSet.html new file mode 100644 index 0000000..a385734 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/BitSet.html @@ -0,0 +1,811 @@ + + + + + +BitSet (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class BitSet

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.BitSet
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BitSet
+extends java.lang.Object
    +
    A sequence of bits representing a value. The most significant bit (the + bit with the highest value) is the leftmost bit and has the highest index. + For example, the BitSet("1011") represents the decimal number 11 and has + indices [3, 0] inclusive where the bit with the lowest value has the lowest + index and is the rightmost bit. + + Created by maperr on 31/05/2016.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static BitSet empty()
        +
        • +
      + + + +
        +
      • +

        longBitSet

        +
        public static BitSet longBitSet(long l)
        +
        • +
      + + + +
        +
      • +

        listBitSet

        +
        public static BitSet listBitSet(List<java.lang.Boolean> list)
        +
        • +
      + + + +
        +
      • +

        streamBitSet

        +
        public static BitSet streamBitSet(Stream<java.lang.Boolean> s)
        +
        • +
      + + + +
        +
      • +

        stringBitSet

        +
        public static BitSet stringBitSet(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        isSet

        +
        public boolean isSet(int index)
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index,
+                  boolean b)
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public BitSet clear(int index)
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        shiftRight

        +
        public BitSet shiftRight(int n)
        +
        • +
      + + + +
        +
      • +

        shiftLeft

        +
        public BitSet shiftLeft(int n)
        +
        • +
      + + + +
        +
      • +

        bitsUsed

        +
        public int bitsUsed()
        +
        • +
      + + + +
        +
      • +

        bitsOn

        +
        public int bitsOn()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Boolean> toStream()
        +
        Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        bitsToRight

        +
        public int bitsToRight(int index)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<java.lang.Boolean> toList()
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <A> A foldRight(F2<java.lang.Boolean,A,A> f,
+                       A acc)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <A> A foldLeft(F2<A,java.lang.Boolean,A> f,
+                      A acc)
        +
        • +
      + + + + + + + +
        +
      • +

        not

        +
        public BitSet not()
        +
        • +
      + + + +
        +
      • +

        takeLower

        +
        public BitSet takeLower(int n)
        +
        • +
      + + + +
        +
      • +

        takeUpper

        +
        public BitSet takeUpper(int n)
        +
        • +
      + + + +
        +
      • +

        range

        +
        public BitSet range(int highIndex,
+                    int lowIndex)
        +
        Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g. "101101".range(1, 4) == "0110"
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(char c)
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(int i)
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public static int toInt(boolean b)
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/HashArrayMappedTrie.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/HashArrayMappedTrie.html new file mode 100644 index 0000000..3088917 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/HashArrayMappedTrie.html @@ -0,0 +1,606 @@ + + + + + +HashArrayMappedTrie (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class HashArrayMappedTrie<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.HashArrayMappedTrie<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HashArrayMappedTrie<K,V>
+extends java.lang.Object
    +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie. It is a refined version of the more general notion of + a hash tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        SIZE

        +
        public static final int SIZE
        +
        • +
      + + + + + + + +
        +
      • +

        MAX_INDEX

        +
        public static final int MAX_INDEX
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        emptyKeyInteger

        +
        public static <V> HashArrayMappedTrie<java.lang.Integer,V> emptyKeyInteger()
        +
        Create and empty trie keyed by integer.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns if the trie is empty.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k)
        +
        Returns an optional value for the given key k.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k,
+                      int lowIndex,
+                      int highIndex)
        +
        Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
        +
        • +
      + + + + + + + + + + + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        Returns a stream of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList(Ord<K> o)
        +
        Returns the list of key-value pairs, ordered by key.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        Returns a list of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeftOnNode

        +
        public <B> B foldLeftOnNode(F2<B,Node<K,V>,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      F2<B,HashArrayMappedTrie<K,V>,B> g,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + +
        +
      • +

        getBitSet

        +
        public BitSet getBitSet()
        +
        • +
      + + + +
        +
      • +

        getSeq

        +
        public Seq<Node<K,V>> getSeq()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in the trie.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/Node.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/Node.html new file mode 100644 index 0000000..052326b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/Node.html @@ -0,0 +1,358 @@ + + + + + +Node (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class Node<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.Node<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Node<K,V>
+extends java.lang.Object
    +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie. + + Created by maperr on 31/05/2016.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-frame.html new file mode 100644 index 0000000..2dcf9a0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-frame.html @@ -0,0 +1,22 @@ + + + + + +fj.data.hamt (core 4.8.1 API) + + + + + +

fj.data.hamt

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-summary.html new file mode 100644 index 0000000..ef9e61f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-summary.html @@ -0,0 +1,157 @@ + + + + + +fj.data.hamt (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hamt

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BitSet +
    A sequence of bits representing a value.
    +
    HashArrayMappedTrie<K,V> +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
    +
    Node<K,V> +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hamt/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-tree.html new file mode 100644 index 0000000..bb78128 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hamt/package-tree.html @@ -0,0 +1,137 @@ + + + + + +fj.data.hamt Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hamt

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.Apply.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.Apply.html new file mode 100644 index 0000000..b30205d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.Apply.html @@ -0,0 +1,392 @@ + + + + + +HList.Apply (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HList.Apply<F$,A,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.Apply<F$,A,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    F$ - The type of the function to apply.
    +
    A - The domain of the function.
    +
    R - The function's codomain.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public abstract static class HList.Apply<F$,A,R>
+extends java.lang.Object
    +
    Type-level function application operators.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Apply

        +
        public Apply()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public abstract R apply(F$ f,
+                        A a)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <X,Y> HList.Apply<F<X,Y>,X,Y> f()
        +
        Function application operator.
        +
        +
        Returns:
        +
        an operator that applies a given function to a given argument.
        +
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <X> HList.Apply<Unit,X,X> id()
        +
        Identity operator
        +
        +
        Returns:
        +
        An operator that returns its second argument no matter which function is being applied.
        +
        +
        • +
      + + + +
        +
      • +

        comp

        +
        public static <X,Y,Z> HList.Apply<Unit,P2<F<X,Y>,F<Y,Z>>,F<X,Z>> comp()
        +
        A function application operator for function composition.
        +
        +
        Type Parameters:
        +
        X - The domain.
        +
        Y - The type through which to compose.
        +
        Z - The codomain.
        +
        Returns:
        +
        an operator that composes functions.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.Apply<Unit,P2<E,L>,HList.HCons<E,L>> cons()
        +
        An operator for the construction of heterogeneous lists.
        +
        +
        Returns:
        +
        an operator that constructs heterogeneous lists.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B,C> HList.Apply<HList.HAppend<A,B,C>,P2<A,B>,C> append()
        +
        A function application operator for concatenating heterogeneous lists.
        +
        +
        Type Parameters:
        +
        A - The type of the list to which to append.
        +
        B - The type of the list to append.
        +
        C - The type of the concatenated list.
        +
        Returns:
        +
        an operator that concatenates heterogeneous lists.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HAppend.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HAppend.html new file mode 100644 index 0000000..d7f23e6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HAppend.html @@ -0,0 +1,304 @@ + + + + + +HList.HAppend (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HAppend<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HAppend<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The type of the first list.
    +
    B - The type of the second list.
    +
    C - The type of the combined list.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HAppend<A,B,C>
+extends java.lang.Object
    +
    The concatenation of two heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        append

        +
        public C append(A a,
+                B b)
        +
        Append a given heterogeneous list to another.
        +
        +
        Parameters:
        +
        a - a heterogeneous list to be appended to.
        +
        b - a heterogeneous list to append to another.
        +
        Returns:
        +
        a new heterogeneous list consisting of the second argument appended to the first.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <L extends HList<L>> HList.HAppend<HList.HNil,L,L> append()
        +
        Returns a method for concatenating lists to the empty list.
        +
        +
        Returns:
        +
        a method for concatenating lists to the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public static <X,A extends HList<A>,B,C extends HList<C>,H extends HList.HAppend<A,B,C>> HList.HAppend<HList.HCons<X,A>,B,HList.HCons<X,C>> append(H h)
        +
        Returns a method for appending lists to a nonempty heterogeneous list.
        +
        +
        Parameters:
        +
        h - a method for appending lists to the tail of the given nonempty list.
        +
        Returns:
        +
        a method for appending lists to a nonempty heterogeneous list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HCons.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HCons.html new file mode 100644 index 0000000..6b86737 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HCons.html @@ -0,0 +1,324 @@ + + + + + +HList.HCons (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HCons<E,L extends HList<L>>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HCons<E,L extends HList<L>>
+extends HList<HList.HCons<E,L>>
    +
    The nonempty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HFoldr.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HFoldr.html new file mode 100644 index 0000000..2f60e4a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HFoldr.html @@ -0,0 +1,323 @@ + + + + + +HList.HFoldr (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HFoldr<G,V,L,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HFoldr<G,V,L,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    G - The type of the function with which to fold.
    +
    V - The type of the value to be substituted for the empty list.
    +
    L - The type of the heterogeneous list to be folded.
    +
    R - The return type of the fold.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HFoldr<G,V,L,R>
+extends java.lang.Object
    +
    The catamorphism over heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hFoldr

        +
        public static <G,V> HList.HFoldr<G,V,HList.HNil,V> hFoldr()
        +
        A fold instance for the empty list.
        +
        +
        Type Parameters:
        +
        G - The type of the function with which to fold.
        +
        V - The type of value that this fold returns.
        +
        Returns:
        +
        a fold instance for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        hFoldr

        +
        public static <E,G,V,L extends HList<L>,R,RR,H extends HList.HFoldr<G,V,L,R>,PP extends HList.Apply<G,P2<E,R>,RR>> HList.HFoldr<G,V,HList.HCons<E,L>,RR> hFoldr(PP p,
+                                                                                                                                                                H h)
        +
        A fold instance for a non-empty heterogeneous list
        +
        +
        Type Parameters:
        +
        E - The type of the head of the list.
        +
        G - The type of function to apply to the head of the list and the fold of its tail.
        +
        V - The type of value to substitute for the empty list.
        +
        L - The type of the tail of the list.
        +
        R - The type of the fold of the tail of the list.
        +
        RR - The return type of the fold.
        +
        H - The type of the fold instance for the tail of the list.
        +
        PP - The type of the given function application operator.
        +
        Parameters:
        +
        p - An operator that applies a function on the head of the list and the fold of its tail.
        +
        h - A fold instance for the tail of the list.
        +
        Returns:
        +
        A fold instance for a non-empty heterogeneous list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public R foldRight(G f,
+                   V v,
+                   L l)
        +
        Folds a non-empty heterogeneous list.
        +
        +
        Parameters:
        +
        f - A function with which to fold.
        +
        v - The value to substitute for the empty list.
        +
        l - The heterogeneous list to be folded.
        +
        Returns:
        +
        a value obtained by folding the given list with the given function.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HNil.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HNil.html new file mode 100644 index 0000000..bc960d8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.HNil.html @@ -0,0 +1,298 @@ + + + + + +HList.HNil (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HNil

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HNil
+extends HList<HList.HNil>
    +
    The empty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.html new file mode 100644 index 0000000..0b6b289 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HList.html @@ -0,0 +1,384 @@ + + + + + +HList (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList<A extends HList<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The specific type of the list, as a subtype of HList
    +
    +
    +
    Direct Known Subclasses:
    +
    HList.HCons, HList.HNil
    +
    +
    +
    +
    public abstract class HList<A extends HList<A>>
+extends java.lang.Object
    +
    Type-safe heterogeneous lists.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class HList.Apply<F$,A,R> +
      Type-level function application operators.
      +
      static class HList.HAppend<A,B,C> +
      The concatenation of two heterogeneous lists.
      +
      static class HList.HCons<E,L extends HList<L>> +
      The nonempty list
      +
      static class HList.HFoldr<G,V,L,R> +
      The catamorphism over heterogeneous lists.
      +
      static class HList.HNil +
      The empty list
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        extend

        +
        public abstract <E> HList.HCons<E,A> extend(E e)
        +
        Extends (cons) this list by prepending the given element, returning a new list.
        +
        +
        Parameters:
        +
        e - an element to prepend to this list.
        +
        Returns:
        +
        a new heterogeneous list, consisting of the given element prepended to this list.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        nil

        +
        public static HList.HNil nil()
        +
        Returns the empty list.
        +
        +
        Returns:
        +
        the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.HCons<E,L> cons(E e,
+                                                           L l)
        +
        Returns a heterogeneous list consisting of an element and another list.
        +
        +
        Parameters:
        +
        e - an element to put in a list.
        +
        l - the rest of the list.
        +
        Returns:
        +
        a heterogeneous list consisting of an element and another list.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <E> HList.HCons<E,HList.HNil> single(E e)
        +
        Returns a heterogeneous list consisting of a single element.
        +
        +
        Parameters:
        +
        e - an element to put in a list
        +
        Returns:
        +
        a heterogeneous list consisting of a single element.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAdd.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAdd.html new file mode 100644 index 0000000..a1e3ae7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAdd.html @@ -0,0 +1,298 @@ + + + + + +HPre.HAdd (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAdd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>
+extends java.lang.Object
    +
    Type-level integer arithmetic
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAnd.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAnd.html new file mode 100644 index 0000000..0f4c7d4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HAnd.html @@ -0,0 +1,306 @@ + + + + + +HPre.HAnd (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAnd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A and B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean conjunction. A value of this type represents evidence that AB -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HBool.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HBool.html new file mode 100644 index 0000000..3d1553a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HBool.html @@ -0,0 +1,204 @@ + + + + + +HPre.HBool (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HBool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HBool
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HFalse, HPre.HTrue
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HBool
+extends java.lang.Object
    +
    A type-level Boolean
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HCond.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HCond.html new file mode 100644 index 0000000..e493b5a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HCond.html @@ -0,0 +1,285 @@ + + + + + +HPre.HCond (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HCond<T,X,Y,Z>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HCond<T,X,Y,Z>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - A boolean
    +
    X - The type of Z if T is true.
    +
    Y - The type of Z if T is false.
    +
    Z - A type that is either X or Z, depending on T.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HCond<T,X,Y,Z>
+extends java.lang.Object
    +
    A type-level conditional. The type of the last parameter is implied by the first three.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HEq.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HEq.html new file mode 100644 index 0000000..9531bb0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HEq.html @@ -0,0 +1,323 @@ + + + + + +HPre.HEq (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HEq<X,Y,B extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HEq<X,Y,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HEq<X,Y,B extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level equality. Represents evidence for X and Y being equal, or counterevidence against.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HFalse.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HFalse.html new file mode 100644 index 0000000..19698cb --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HFalse.html @@ -0,0 +1,205 @@ + + + + + +HPre.HFalse (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HFalse

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HFalse
+extends HPre.HBool
    +
    Boolean false
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HNat.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HNat.html new file mode 100644 index 0000000..076e524 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HNat.html @@ -0,0 +1,332 @@ + + + + + +HPre.HNat (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HNat<A extends HPre.HNat<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HNat<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HSucc, HPre.HZero
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public abstract static class HPre.HNat<A extends HPre.HNat<A>>
+extends java.lang.Object
    +
    Type-level natural numbers.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HNat

        +
        public HNat()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HOr.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HOr.html new file mode 100644 index 0000000..47661cb --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HOr.html @@ -0,0 +1,306 @@ + + + + + +HPre.HOr (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HOr<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A or B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean disjunction. A value of this type represents evidence that A+B -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HSucc.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HSucc.html new file mode 100644 index 0000000..456ad89 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HSucc.html @@ -0,0 +1,277 @@ + + + + + +HPre.HSucc (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HSucc<N extends HPre.HNat<N>>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    N - The predecessor of this number.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HSucc<N extends HPre.HNat<N>>
+extends HPre.HNat<HPre.HSucc<N>>
    +
    A natural number N + 1
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HTrue.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HTrue.html new file mode 100644 index 0000000..c7fc4d0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HTrue.html @@ -0,0 +1,205 @@ + + + + + +HPre.HTrue (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HTrue

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HTrue
+extends HPre.HBool
    +
    Boolean true
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HZero.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HZero.html new file mode 100644 index 0000000..2d1ccf3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.HZero.html @@ -0,0 +1,273 @@ + + + + + +HPre.HZero (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HZero

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HZero
+extends HPre.HNat<HPre.HZero>
    +
    Type-level zero
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.html new file mode 100644 index 0000000..c268352 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/HPre.html @@ -0,0 +1,344 @@ + + + + + +HPre (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HPre
+extends java.lang.Object
    +
    A basic prelude of values lifted into the type system.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hTrue

        +
        public static HPre.HTrue hTrue()
        +
        Returns a boolean value whose type represents truth.
        +
        +
        Returns:
        +
        a boolean value whose type represents truth.
        +
        +
        • +
      + + + +
        +
      • +

        hFalse

        +
        public static HPre.HFalse hFalse()
        +
        Returns a boolean value whose type represents falsehood.
        +
        +
        Returns:
        +
        a boolean value whose type represents falsehood.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-frame.html new file mode 100644 index 0000000..d4668f3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-frame.html @@ -0,0 +1,37 @@ + + + + + +fj.data.hlist (core 4.8.1 API) + + + + + +

fj.data.hlist

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-summary.html new file mode 100644 index 0000000..dfdd0bf --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-summary.html @@ -0,0 +1,253 @@ + + + + + +fj.data.hlist (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hlist

+
+
Type-safe, extensible, heterogeneous lists
+
+

See: Description

+
+
+ + + + +

Package fj.data.hlist Description

+
Type-safe, extensible, heterogeneous lists
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/hlist/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-tree.html new file mode 100644 index 0000000..880ea9e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/hlist/package-tree.html @@ -0,0 +1,161 @@ + + + + + +fj.data.hlist Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hlist

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Fold.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Fold.html new file mode 100644 index 0000000..1c361a3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Fold.html @@ -0,0 +1,524 @@ + + + + + +Fold (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Fold<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Fold<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Fold
    +
    A - the target of a Fold
    +
    +
    +
    +
    public abstract class Fold<S,A>
+extends java.lang.Object
    +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target. + + Fold is on the top of the Optic hierarchy which means that Getter, PTraversal, POptional, + PLens, PPrism and PIso are valid Fold
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fold

        +
        public Fold()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> m,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a Fold matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a Fold
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public final <S1> Fold<Either<S,S1>,A> sum(Fold<S1,A> other)
        +
        join two Fold with the same target
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <B> Fold<S,B> composeFold(Fold<A,B> other)
        +
        compose a Fold with a Fold
        +
        • +
      + + + +
        +
      • +

        composeGetter

        +
        public final <C> Fold<S,C> composeGetter(Getter<A,C> other)
        +
        compose a Fold with a Getter
        +
        • +
      + + + + + + + +
        +
      • +

        composePrism

        +
        public final <B,C,D> Fold<S,C> composePrism(PPrism<A,B,C,D> other)
        +
        compose a Fold with a PPrism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public final <B,C,D> Fold<S,C> composeLens(PLens<A,B,C,D> other)
        +
        compose a Fold with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <B,C,D> Fold<S,C> composeIso(PIso<A,B,C,D> other)
        +
        compose a Fold with a PIso
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <A> Fold<A,A> id()
        +
        • +
      + + + +
        +
      • +

        codiagonal

        +
        public static <A> Fold<Either<A,A>,A> codiagonal()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Getter.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Getter.html new file mode 100644 index 0000000..8b30858 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Getter.html @@ -0,0 +1,457 @@ + + + + + +Getter (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class Getter<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Getter<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Getter
    +
    A - the target of a Getter
    +
    +
    +
    +
    public abstract class Getter<S,A>
+extends java.lang.Object
    +
    A Getter can be seen as a glorified get method between a type S and a type A. + + A Getter is also a valid Fold
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Iso.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Iso.html new file mode 100644 index 0000000..0e957b4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Iso.html @@ -0,0 +1,624 @@ + + + + + +Iso (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Iso<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Iso<S,A>
+extends PIso<S,S,A,A>
    +
    PIso when S = T and A = B
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Iso

        +
        public Iso(PIso<S,S,A,A> pIso)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public A get(S s)
        +
        Description copied from class: PIso
        +
        get the target of a PIso
        +
        +
        Specified by:
        +
        get in class PIso<S,S,A,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public S reverseGet(A a)
        +
        Description copied from class: PIso
        +
        get the modified source of a PIso
        +
        +
        Specified by:
        +
        reverseGet in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Iso<A,S> reverse()
        +
        Description copied from class: PIso
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        +
        Specified by:
        +
        reverse in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public <S1,A1> Iso<P2<S,S1>,P2<A,A1>> product(Iso<S1,A1> other)
        +
        pair two disjoint Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composePrism

        +
        public <C> Prism<S,C> composePrism(Prism<A,C> other)
        +
        compose an Iso with a Prism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public <C> Lens<S,C> composeLens(Lens<A,C> other)
        +
        compose an Iso with a Lens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public <C> Iso<S,C> composeIso(Iso<A,C> other)
        +
        compose an Iso with an Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        iso

        +
        public static <S,A> Iso<S,A> iso(F<S,A> get,
+                                 F<A,S> reverseGet)
        +
        create an Iso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <S> Iso<S,S> id()
        +
        create an Iso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        
+  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Lens.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Lens.html new file mode 100644 index 0000000..36809e1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Lens.html @@ -0,0 +1,770 @@ + + + + + +Lens (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Lens<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Lens<S,A>
+extends PLens<S,S,A,A>
    +
    PLens with a monomorphic set function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Optional.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Optional.html new file mode 100644 index 0000000..35d27e0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Optional.html @@ -0,0 +1,817 @@ + + + + + +Optional (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Optional<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Optional<S,A>
+extends POptional<S,S,A,A>
    +
    POptional restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/PIso.html b/javadoc/4.8.1/functionaljava/fj/data/optic/PIso.html new file mode 100644 index 0000000..c066b68 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/PIso.html @@ -0,0 +1,844 @@ + + + + + +PIso (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PIso<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PIso<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PIso
    +
    T - the modified source of a PIso
    +
    A - the target of a PIso
    +
    B - the modified target of a PIso
    +
    +
    +
    Direct Known Subclasses:
    +
    Iso
    +
    +
    +
    +
    public abstract class PIso<S,T,A,B>
+extends java.lang.Object
    +
    A PIso defines an isomorphism between types S, A and B, T: + + 
    
+              get                           reverse.get
+     -------------------->             -------------------->
+   S                       A         T                       B
+     <--------------------             <--------------------
+       reverse.reverseGet                   reverseGet
+
    + + In addition, if f and g forms an isomorphism between A and B, i.e. if f . g = id and g . f = id, then a PIso + defines an isomorphism between S and T: + + 
    
+     S           T                                   S           T
+     |           |                                   |           |
+     |           |                                   |           |
+ get |           | reverseGet     reverse.reverseGet |           | reverse.get
+     |           |                                   |           |
+     |     f     |                                   |     g     |
+     A --------> B                                   A <-------- B
+
    + + A PIso is also a valid Getter, Fold, PLens, PPrism, POptional, + PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PIso
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PIso
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public abstract PIso<B,A,T,S> reverse()
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PIso with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PIso with a value
        +
        • +
      + + + +
        +
      • +

        product

        +
        public final <S1,T1,A1,B1> PIso<P2<S,S1>,P2<T,T1>,P2<A,A1>,P2<B,B1>> product(PIso<S1,T1,A1,B1> other)
        +
        pair two disjoint PIso
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PIso with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PIso with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PIso<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PIso with a PIso
        +
        • +
      + + + +
        +
      • +

        asFold

        +
        public final Fold<S,A> asFold()
        +
        view a PIso as a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pIso

        +
        public static <S,T,A,B> PIso<S,T,A,B> pIso(F<S,A> get,
+                                           F<B,T> reverseGet)
        +
        create a PIso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        pId

        +
        public static <S,T> PIso<S,T,S,T> pId()
        +
        create a PIso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        
+  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/PLens.html b/javadoc/4.8.1/functionaljava/fj/data/optic/PLens.html new file mode 100644 index 0000000..8bf31f2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/PLens.html @@ -0,0 +1,730 @@ + + + + + +PLens (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PLens<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PLens<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PLens
    +
    T - the modified source of a PLens
    +
    A - the target of a PLens
    +
    B - the modified target of a PLens
    +
    +
    +
    Direct Known Subclasses:
    +
    Lens
    +
    +
    +
    +
    public abstract class PLens<S,T,A,B>
+extends java.lang.Object
    +
    A PLens can be seen as a pair of functions:
      +
    • get: S => A i.e. from an S, we can extract an A
      • +
    • set: (B, S) => T i.e. if we replace an A by a B in an S, we obtain a T
      • +
    +

    + A PLens could also be defined as a weaker PIso where set requires an additional parameter than reverseGet.

    +

    + PLens stands for Polymorphic Lens as it set and modify methods change a type A to B and S to T. Lens + is a PLens restricted to monomoprhic updates.

    +

    + A PLens is also a valid Getter, Fold, POptional, PTraversal and PSetter

    +

    + Typically a PLens or Lens can be defined between a Product (e.g. case class, tuple, HList) and one of it is + component.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PLens
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public abstract F<S,T> set(B b)
        +
        set polymorphically the target of a PLens using a function
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public abstract <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public abstract F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PLens using a function
        +
        • +
      + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PLens with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PLens with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PLens<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PLens with an PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PLens<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pLens

        +
        public static <S,T,A,B> PLens<S,T,A,B> pLens(F<S,A> get,
+                                             F<B,F<S,T>> set)
        +
        create a PLens using a pair of functions: one to get the target, one to set the target.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/POptional.html b/javadoc/4.8.1/functionaljava/fj/data/optic/POptional.html new file mode 100644 index 0000000..8b45c0f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/POptional.html @@ -0,0 +1,790 @@ + + + + + +POptional (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class POptional<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.POptional<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a POptional
    +
    T - the modified source of a POptional
    +
    A - the target of a POptional
    +
    B - the modified target of a POptional
    +
    +
    +
    Direct Known Subclasses:
    +
    Optional
    +
    +
    +
    +
    public abstract class POptional<S,T,A,B>
+extends java.lang.Object
    +
    A POptional can be seen as a pair of functions:
      +
    • getOrModify: S => T \/ A
      • +
    • set : (B, S) => T
      • +
    +

    + A POptional could also be defined as a weaker PLens and weaker PPrism

    +

    + POptional stands for Polymorphic Optional as it set and modify methods change a type A to B and S to T. + Optional is a POptional restricted to monomoprhic updates: type Optional[S, A] = POptional[S, S, A, A]

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/PPrism.html b/javadoc/4.8.1/functionaljava/fj/data/optic/PPrism.html new file mode 100644 index 0000000..e54756a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/PPrism.html @@ -0,0 +1,802 @@ + + + + + +PPrism (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PPrism<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PPrism<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PPrism
    +
    T - the modified source of a PPrism
    +
    A - the target of a PPrism
    +
    B - the modified target of a PPrism
    +
    +
    +
    Direct Known Subclasses:
    +
    Prism
    +
    +
    +
    +
    public abstract class PPrism<S,T,A,B>
+extends java.lang.Object
    +
    A PPrism can be seen as a pair of functions:
      +
    • getOrModify: S => T \/ A
      • +
    • reverseGet : B => T
      • +
    +

    + A PPrism could also be defined as a weaker PIso where get can fail.

    +

    + Typically a PPrism or Prism encodes the relation between a Sum or CoProduct type (e.g. sealed trait) and one + of it is element.

    + + PPrism stands for Polymorphic Prism as it set and modify methods change a type A to B and S to T. + Prism is a PPrism where the type of target cannot be modified. + + A PPrism is also a valid Fold, POptional, PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        getOrModify

        +
        public abstract Either<T,A> getOrModify(S s)
        +
        get the target of a PPrism or modify the source in case there is no target
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PPrism
        +
        • +
      + + + + + +
        +
      • +

        getOption

        +
        public abstract Option<A> getOption(S s)
        +
        get the target of a PPrism or nothing if there is no target
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function
        +
        • +
      + + + +
        +
      • +

        modifyOption

        +
        public final F<S,Option<T>> modifyOption(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PPrism with a value
        +
        • +
      + + + + + +
        +
      • +

        setOption

        +
        public final F<S,Option<T>> setOption(B b)
        +
        set polymorphically the target of a PPrism with a value. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        isMatching

        +
        public final boolean isMatching(S s)
        +
        check if a PPrism has a target
        +
        • +
      + + + +
        +
      • +

        re

        +
        public final Getter<B,T> re()
        +
        create a Getter from the modified target to the modified source of a PPrism
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PPrism with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PPrism<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PPrism with a PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PPrism<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pPrism

        +
        public static <S,T,A,B> PPrism<S,T,A,B> pPrism(F<S,Either<T,A>> getOrModify,
+                                               F<B,T> reverseGet)
        +
        create a PPrism using the canonical functions: getOrModify and reverseGet
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/PSetter.html b/javadoc/4.8.1/functionaljava/fj/data/optic/PSetter.html new file mode 100644 index 0000000..79d3584 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/PSetter.html @@ -0,0 +1,426 @@ + + + + + +PSetter (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PSetter<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PSetter<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PSetter
    +
    T - the modified source of a PSetter
    +
    A - the target of a PSetter
    +
    B - the modified target of a PSetter
    +
    +
    +
    Direct Known Subclasses:
    +
    Setter
    +
    +
    +
    +
    public abstract class PSetter<S,T,A,B>
+extends java.lang.Object
    +
    A PSetter is a generalisation of Functor map:
      +
    • map: (A => B) => F[A] => F[B]
      • +
    • modify: (A => B) => S => T
      • +
    +

    + PSetter stands for Polymorphic Setter as it set and modify methods change a type A to B and S to T.

    +

    + PTraversal, POptional, PPrism, PLens and PIso are valid PSetter

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/PTraversal.html b/javadoc/4.8.1/functionaljava/fj/data/optic/PTraversal.html new file mode 100644 index 0000000..a8b99b1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/PTraversal.html @@ -0,0 +1,908 @@ + + + + + +PTraversal (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class PTraversal<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PTraversal<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PTraversal
    +
    T - the modified source of a PTraversal
    +
    A - the target of a PTraversal
    +
    B - the modified target of a PTraversal
    +
    +
    +
    Direct Known Subclasses:
    +
    Traversal
    +
    +
    +
    +
    public abstract class PTraversal<S,T,A,B>
+extends java.lang.Object
    +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite. +

    + PTraversal stands for Polymorphic Traversal as it set and modify methods change a type A to B and S to T. + Traversal is a PTraversal restricted to monomoprhic updates.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PTraversal

        +
        public PTraversal()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + + + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> monoid,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a PTraversal
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a PTraversal matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a PTraversal
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PTraversal with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PTraversal with a value
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PTraversal<S,T,S,T> pId()
        +
        • +
      + + + + + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F3<B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F4<B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F5<B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F6<B,B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F<S,A> get6,
+                                                       F7<B,B,B,B,B,B,S,T> set)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Prism.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Prism.html new file mode 100644 index 0000000..c8dff10 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Prism.html @@ -0,0 +1,522 @@ + + + + + +Prism (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Prism<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Prism<S,A>
+extends PPrism<S,S,A,A>
    +
    PPrism restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Setter.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Setter.html new file mode 100644 index 0000000..4f7cf54 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Setter.html @@ -0,0 +1,419 @@ + + + + + +Setter (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Setter<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Setter<S,A>
+extends PSetter<S,S,A,A>
    +
    PSetter with a monomorphic modify function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/Traversal.html b/javadoc/4.8.1/functionaljava/fj/data/optic/Traversal.html new file mode 100644 index 0000000..a6548c3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/Traversal.html @@ -0,0 +1,723 @@ + + + + + +Traversal (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Traversal<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Traversal<S,A>
+extends PTraversal<S,S,A,A>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/optic/package-frame.html new file mode 100644 index 0000000..029a6f4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/package-frame.html @@ -0,0 +1,33 @@ + + + + + +fj.data.optic (core 4.8.1 API) + + + + + +

fj.data.optic

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/optic/package-summary.html new file mode 100644 index 0000000..9a244c4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/package-summary.html @@ -0,0 +1,247 @@ + + + + + +fj.data.optic (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.optic

+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Fold<S,A> +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
    +
    Getter<S,A> +
    A Getter can be seen as a glorified get method between a type S and a type A.
    +
    Iso<S,A> +
    PIso when S = T and A = B
    +
    Lens<S,A> +
    PLens with a monomorphic set function
    +
    Optional<S,A> +
    POptional restricted to monomorphic update
    +
    PIso<S,T,A,B> +
    A PIso defines an isomorphism between types S, A and B, T:
    +
    PLens<S,T,A,B> +
    A PLens can be seen as a pair of functions: + get: S => A i.e.
    +
    POptional<S,T,A,B> +
    A POptional can be seen as a pair of functions: + getOrModify: S => T \/ A + set : (B, S) => T +
    +
    PPrism<S,T,A,B> +
    A PPrism can be seen as a pair of functions: + getOrModify: S => T \/ A + reverseGet : B => T +
    +
    Prism<S,A> +
    PPrism restricted to monomorphic update
    +
    PSetter<S,T,A,B> +
    A PSetter is a generalisation of Functor map: + map: (A => B) => F[A] => F[B] + modify: (A => B) => S => T +
    +
    PTraversal<S,T,A,B> +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
    +
    Setter<S,A> +
    PSetter with a monomorphic modify function
    +
    Traversal<S,A> 
    +
    • +
+ + + +

Package fj.data.optic Description

+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library. See the Monocle Github + page for an overview of the package.
+
+
See Also:
+
Monocle
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/optic/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/optic/package-tree.html new file mode 100644 index 0000000..7d62298 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/optic/package-tree.html @@ -0,0 +1,166 @@ + + + + + +fj.data.optic Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.optic

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.optic.Fold<S,A>
      • +
    • fj.data.optic.Getter<S,A>
      • +
    • fj.data.optic.PIso<S,T,A,B> +
        +
      • fj.data.optic.Iso<S,A>
        • +
      +
      • +
    • fj.data.optic.PLens<S,T,A,B> +
        +
      • fj.data.optic.Lens<S,A>
        • +
      +
      • +
    • fj.data.optic.POptional<S,T,A,B> + +
      • +
    • fj.data.optic.PPrism<S,T,A,B> +
        +
      • fj.data.optic.Prism<S,A>
        • +
      +
      • +
    • fj.data.optic.PSetter<S,T,A,B> + +
      • +
    • fj.data.optic.PTraversal<S,T,A,B> + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/package-frame.html new file mode 100644 index 0000000..006318d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/package-frame.html @@ -0,0 +1,65 @@ + + + + + +fj.data (core 4.8.1 API) + + + + + +

fj.data

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/package-summary.html new file mode 100644 index 0000000..70edf98 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/package-summary.html @@ -0,0 +1,413 @@ + + + + + +fj.data (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data

+
+
Common algebraic data types.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    IO<A> +
    IO monad for processing files
    +
    SafeIO<A> +
    Created by MarkPerry on 3/07/2014.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    $<A,B> +
    The constant arrow, for attaching a new name to an existing type.
    +
    Array<A> +
    Provides an interface to arrays.
    +
    Array.ImmutableProjection<A> +
    Projects an array by providing only operations which do not mutate.
    +
    Conversions +
    Functions that convert between data structure types.
    +
    DList<A> +
    Difference List.
    +
    Either<A,B> +
    The Either type represents a value of one of two possible types (a disjoint union).
    +
    Either.LeftProjection<A,B> +
    A left projection of an either value.
    +
    Either.RightProjection<A,B> +
    A right projection of an either value.
    +
    Enumerator<A> +
    Abstracts over a type that may have a successor and/or predecessor value.
    +
    Eval<A> +
    Eval is an abstraction over different models of evaluation.
    +
    HashMap<K,V> +
    A mutable hash map providing O(1) lookup.
    +
    HashSet<A> +
    A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
    +
    IOFunctions +
    IO monad for processing files, with main methods IOFunctions.enumFileLines(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.String, A>), + IOFunctions.enumFileChars(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.Character, A>) and IOFunctions.enumFileCharChunks(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<char[], A>) + (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee + without indirection in between).
    +
    IOW<A> +
    Created by MarkPerry on 9/06/2015.
    +
    IterableW<A> +
    A wrapper for Iterable that equips it with some useful functions.
    +
    Iteratee 
    Iteratee.Input<E> +
    The input to an iteratee.
    +
    Iteratee.IterV<E,A> +
    A pure iteratee computation which is either done or needs more input
    +
    Java +
    Functions that convert between types from the core Java API.
    +
    LazyString +
    A lazy (non-evaluated) immutable character string.
    +
    List<A> +
    Provides an in-memory, immutable, singly linked list.
    +
    List.Buffer<A> +
    A mutable, singly linked list.
    +
    List.Optic +
    Optic factory methods for a List
    +
    List.Unsafe 
    Natural +
    Represents a natural number (zero, one, two, etc.)
    +
    NonEmptyList<A> +
    Provides an in-memory, immutable, singly linked list with total head and tail.
    +
    Option<A> +
    An optional value that may be none (no value) or some (a value).
    +
    Option.Optic 
    PriorityQueue<K,A> +
    A priority queue implementation backed by a + FingerTree.
    +
    Reader<A,B> +
    The Reader monad (also called the function monad, so equivalent to the idea of F).
    +
    Seq<A> +
    Provides an immutable finite sequence, implemented as a finger tree.
    +
    Set<A> +
    Provides an in-memory, immutable set, implemented as a red/black tree.
    +
    State<S,A> +
    Created by MarkPerry on 7/07/2014.
    +
    Stream<A> +
    A lazy (not yet evaluated), immutable, singly linked list.
    +
    Tree<A> +
    Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
    +
    TreeMap<K,V> +
    An immutable, in-memory map, backed by a red-black tree.
    +
    TreeZipper<A> +
    Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.
    +
    Validation<E,T> +
    Isomorphic to Either but has renamed functions and represents failure on the left and success on the right.
    +
    Validation.FailProjection<E,T> +
    A failing projection of a validation.
    +
    Writer<W,A> +
    Created by MarkPerry on 7/07/2014.
    +
    Zipper<A> +
    Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream.
    +
    +
    • +
+ + + +

Package fj.data Description

+
Common algebraic data types.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/package-tree.html new file mode 100644 index 0000000..45b7563 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/package-tree.html @@ -0,0 +1,191 @@ + + + + + +fj.data Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+
    +
  • fj.data.IO<A> + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V.html new file mode 100644 index 0000000..4b1c7d6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V.html @@ -0,0 +1,547 @@ + + + + + +V (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class V
+extends java.lang.Object
    +
    Functions across vectors.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> V2<A>v(A a1, + A a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(A a1, + A a2, + A a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(A a1, + A a2, + A a3, + A a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(A a1, + A a2, + A a3, + A a4, + A a5) +
      Puts elements in a vector-5.
      +
      static <A> V2<A>v(F0<A> a1, + F0<A> a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(P1<A> a1, + F0<A> a2, + F0<A> a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(P1<A> a1, + P1<A> a2, + F0<A> a3, + F0<A> a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(P1<A> a1, + P1<A> a2, + P1<A> a3, + F0<A> a4, + F0<A> a5) +
      Puts elements in a vector-5.
      +
      static <A> F2<A,A,V2<A>>v2() +
      Returns a function that puts elements in a vector-2.
      +
      static <A> F3<A,A,A,V3<A>>v3() +
      Returns a function that puts elements in a vector-3.
      +
      static <A> F4<A,A,A,A,V4<A>>v4() +
      Returns a function that puts elements in a vector-4.
      +
      static <A> F5<A,A,A,A,A,V5<A>>v5() +
      Returns a function that puts elements in a vector-5.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(A a1,
+                          A a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(F0<A> a1,
+                          F0<A> a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v2

        +
        public static <A> F2<A,A,V2<A>> v2()
        +
        Returns a function that puts elements in a vector-2.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(A a1,
+                          A a2,
+                          A a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(P1<A> a1,
+                          F0<A> a2,
+                          F0<A> a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v3

        +
        public static <A> F3<A,A,A,V3<A>> v3()
        +
        Returns a function that puts elements in a vector-3.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(P1<A> a1,
+                          P1<A> a2,
+                          F0<A> a3,
+                          F0<A> a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v4

        +
        public static <A> F4<A,A,A,A,V4<A>> v4()
        +
        Returns a function that puts elements in a vector-4.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4,
+                          A a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(P1<A> a1,
+                          P1<A> a2,
+                          P1<A> a3,
+                          F0<A> a4,
+                          F0<A> a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v5

        +
        public static <A> F5<A,A,A,A,A,V5<A>> v5()
        +
        Returns a function that puts elements in a vector-5.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-5.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V2.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V2.html new file mode 100644 index 0000000..8aded20 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V2.html @@ -0,0 +1,647 @@ + + + + + +V2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V2<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V2<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V2<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V2<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V2<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      <B> V2<B>apply(V2<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Return the first element of this vector as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V2<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V2<A>,P2<A,A>>p_() +
      Returns a function that transforms a vector-2 to the equivalent product-2.
      +
      P2<A,A>p() +
      Returns a homogeneous product-2 equivalent to this vector.
      +
      static <A> V2<A>p(P2<A,A> p) +
      Creates a vector-2 from a homogeneous product-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V2<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-2 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V2<V2<A>>vzip(V2<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V2<P2<A,B>>zip(V2<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V2<C>zipWith(F<A,F<B,C>> f, + V2<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V2<A> p(P2<A,A> p)
        +
        Creates a vector-2 from a homogeneous product-2.
        +
        +
        Parameters:
        +
        p - The product-2 from which to create a vector.
        +
        Returns:
        +
        A new vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V2<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V2<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P2<A,A> p()
        +
        Returns a homogeneous product-2 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-2 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V2<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-2 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V2<A>,P2<A,A>> p_()
        +
        Returns a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V2<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V2<B> apply(V2<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V2<C> zipWith(F<A,F<B,C>> f,
+                           V2<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V2<P2<A,B>> zip(V2<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V2<V2<A>> vzip(V2<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Return the first element of this vector as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector as a product-1.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V3.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V3.html new file mode 100644 index 0000000..6e10b26 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V3.html @@ -0,0 +1,732 @@ + + + + + +V3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V3<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V3<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V3<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V3<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V3<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V3<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      <B> V3<B>apply(V3<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V3<A>cons(P1<A> head, + V2<A> tail) +
      Creates a vector-3 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V3<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V3<A>,P3<A,A,A>>p_() +
      Returns a function that transforms a vector-3 to the equivalent product-3.
      +
      P3<A,A,A>p() +
      Returns a homogeneous product-3 equivalent to this vector.
      +
      static <A> V3<A>p(P3<A,A,A> p) +
      Creates a vector-3 from a homogeneous product-3.
      +
      V2<A>tail() +
      Returns all but the first element of this vector, as a vector-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V3<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-3 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V3<V2<A>>vzip(V3<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V3<P2<A,B>>zip(V3<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V3<C>zipWith(F<A,F<B,C>> f, + V3<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V3<A> p(P3<A,A,A> p)
        +
        Creates a vector-3 from a homogeneous product-3.
        +
        +
        Parameters:
        +
        p - The product-3 from which to create a vector.
        +
        Returns:
        +
        A new vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V3<A> cons(P1<A> head,
+                             V2<A> tail)
        +
        Creates a vector-3 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V2<A> tail()
        +
        Returns all but the first element of this vector, as a vector-2.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<A,A,A> p()
        +
        Returns a homogeneous product-3 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-3 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V3<B> apply(V3<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V3<C> zipWith(F<A,F<B,C>> f,
+                           V3<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V3<P2<A,B>> zip(V3<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V3<V2<A>> vzip(V3<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V3<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V3<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-3 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V3<A>,P3<A,A,A>> p_()
        +
        Returns a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V3<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V3<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V3<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V4.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V4.html new file mode 100644 index 0000000..d0a8ef6 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V4.html @@ -0,0 +1,772 @@ + + + + + +V4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V4<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V4<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V4<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V4<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V4<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V4<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V4<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      <B> V4<B>apply(V4<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V4<A>cons(P1<A> head, + V3<A> tail) +
      Creates a vector-4 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V4<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V4<A>,P4<A,A,A,A>>p_() +
      Returns a function that transforms a vector-4 to the equivalent product-4.
      +
      P4<A,A,A,A>p() +
      Returns a homogeneous product-4 equivalent to this vector.
      +
      static <A> V4<A>p(P4<A,A,A,A> p) +
      Creates a vector-4 from a homogeneous product-4.
      +
      V3<A>tail() +
      Returns all but the first element of this vector, as a vector-3.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V4<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-4 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V4<V2<A>>vzip(V4<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V4<P2<A,B>>zip(V4<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V4<C>zipWith(F<A,F<B,C>> f, + V4<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V4<A> p(P4<A,A,A,A> p)
        +
        Creates a vector-4 from a homogeneous product-4.
        +
        +
        Parameters:
        +
        p - The product-4 from which to create a vector.
        +
        Returns:
        +
        A new vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V4<A> cons(P1<A> head,
+                             V3<A> tail)
        +
        Creates a vector-4 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V3<A> tail()
        +
        Returns all but the first element of this vector, as a vector-3.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P4<A,A,A,A> p()
        +
        Returns a homogeneous product-4 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-4 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V4<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V4<B> apply(V4<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V4<C> zipWith(F<A,F<B,C>> f,
+                           V4<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V4<P2<A,B>> zip(V4<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V4<V2<A>> vzip(V4<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V4<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-4 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V4<A>,P4<A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V4<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V4<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V4<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V4<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V5.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V5.html new file mode 100644 index 0000000..f9c9ebe --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V5.html @@ -0,0 +1,812 @@ + + + + + +V5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V5<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V5<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V5<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V5<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V5<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V5<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V5<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V5<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      <B> V5<B>apply(V5<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V5<A>cons(P1<A> head, + V4<A> tail) +
      Creates a vector-5 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V5<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V5<A>,P5<A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-5 to the equivalent product-5.
      +
      P5<A,A,A,A,A>p() +
      Returns a homogeneous product-5 equivalent to this vector.
      +
      static <A> V5<A>p(P5<A,A,A,A,A> p) +
      Creates a vector-5 from a homogeneous product-5.
      +
      V4<A>tail() +
      Returns all but the first element of this vector, as a vector-4.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V5<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-5 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V5<V2<A>>vzip(V5<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V5<P2<A,B>>zip(V5<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V5<C>zipWith(F<A,F<B,C>> f, + V5<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V5<A> p(P5<A,A,A,A,A> p)
        +
        Creates a vector-5 from a homogeneous product-5.
        +
        +
        Parameters:
        +
        p - The product-5 from which to create a vector.
        +
        Returns:
        +
        A new vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V5<A> cons(P1<A> head,
+                             V4<A> tail)
        +
        Creates a vector-5 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V4<A> tail()
        +
        Returns all but the first element of this vector, as a vector-4.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P5<A,A,A,A,A> p()
        +
        Returns a homogeneous product-5 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-5 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V5<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V5<B> apply(V5<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V5<C> zipWith(F<A,F<B,C>> f,
+                           V5<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V5<P2<A,B>> zip(V5<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V5<V2<A>> vzip(V5<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V5<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-5 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V5<A>,P5<A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V5<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V5<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V5<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V5<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V5<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V6.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V6.html new file mode 100644 index 0000000..472f498 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V6.html @@ -0,0 +1,852 @@ + + + + + +V6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V6<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V6<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V6<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V6<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V6<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V6<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V6<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V6<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V6<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      <B> V6<B>apply(V6<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V6<A>cons(P1<A> head, + V5<A> tail) +
      Creates a vector-6 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V6<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V6<A>,P6<A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-6 to the equivalent product-6.
      +
      P6<A,A,A,A,A,A>p() +
      Returns a homogeneous product-6 equivalent to this vector.
      +
      static <A> V6<A>p(P6<A,A,A,A,A,A> p) +
      Creates a vector-6 from a homogeneous product-6.
      +
      V5<A>tail() +
      Returns all but the first element of this vector, as a vector-5.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V6<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-6 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V6<V2<A>>vzip(V6<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V6<P2<A,B>>zip(V6<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V6<C>zipWith(F<A,F<B,C>> f, + V6<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V6<A> p(P6<A,A,A,A,A,A> p)
        +
        Creates a vector-6 from a homogeneous product-6.
        +
        +
        Parameters:
        +
        p - The product-6 from which to create a vector.
        +
        Returns:
        +
        A new vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V6<A> cons(P1<A> head,
+                             V5<A> tail)
        +
        Creates a vector-6 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V5<A> tail()
        +
        Returns all but the first element of this vector, as a vector-5.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P6<A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-6 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-6 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V6<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V6<B> apply(V6<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V6<C> zipWith(F<A,F<B,C>> f,
+                           V6<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V6<P2<A,B>> zip(V6<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V6<V2<A>> vzip(V6<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V6<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-6 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V6<A>,P6<A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V6<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V6<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V6<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V6<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V6<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V6<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V7.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V7.html new file mode 100644 index 0000000..2ceaab8 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V7.html @@ -0,0 +1,892 @@ + + + + + +V7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V7<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V7<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V7<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V7<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V7<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V7<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V7<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V7<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V7<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V7<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      <B> V7<B>apply(V7<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V7<A>cons(P1<A> head, + V6<A> tail) +
      Creates a vector-7 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V7<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V7<A>,P7<A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-7 to the equivalent product-7.
      +
      P7<A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-7 equivalent to this vector.
      +
      static <A> V7<A>p(P7<A,A,A,A,A,A,A> p) +
      Creates a vector-7 from a homogeneous product-7.
      +
      V6<A>tail() +
      Returns all but the first element of this vector, as a vector-6.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V7<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-7 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V7<V2<A>>vzip(V7<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V7<P2<A,B>>zip(V7<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V7<C>zipWith(F<A,F<B,C>> f, + V7<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V7<A> p(P7<A,A,A,A,A,A,A> p)
        +
        Creates a vector-7 from a homogeneous product-7.
        +
        +
        Parameters:
        +
        p - The product-7 from which to create a vector.
        +
        Returns:
        +
        A new vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V7<A> cons(P1<A> head,
+                             V6<A> tail)
        +
        Creates a vector-7 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V6<A> tail()
        +
        Returns all but the first element of this vector, as a vector-6.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P7<A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-7 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-7 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V7<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V7<B> apply(V7<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V7<C> zipWith(F<A,F<B,C>> f,
+                           V7<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V7<P2<A,B>> zip(V7<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V7<V2<A>> vzip(V7<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V7<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-7 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V7<A>,P7<A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V7<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V7<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V7<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V7<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V7<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V7<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V7<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/V8.html b/javadoc/4.8.1/functionaljava/fj/data/vector/V8.html new file mode 100644 index 0000000..e1ddb65 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/V8.html @@ -0,0 +1,932 @@ + + + + + +V8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V8<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V8<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V8<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V8<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V8<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V8<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V8<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V8<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V8<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V8<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      static <A> F<V8<A>,A>__8() +
      A first-class function to get the eighth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      A_8() +
      Returns the eighth element of this vector.
      +
      <B> V8<B>apply(V8<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V8<A>cons(P1<A> head, + V7<A> tail) +
      Creates a vector-8 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V8<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-8 to the equivalent product-8.
      +
      P8<A,A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-8 equivalent to this vector.
      +
      static <A> V8<A>p(P8<A,A,A,A,A,A,A,A> p) +
      Creates a vector-8 from a homogeneous product-8.
      +
      V7<A>tail() +
      Returns all but the first element of this vector, as a vector-7.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V8<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-8 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V8<V2<A>>vzip(V8<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V8<P2<A,B>>zip(V8<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V8<C>zipWith(F<A,F<B,C>> f, + V8<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V8<A> p(P8<A,A,A,A,A,A,A,A> p)
        +
        Creates a vector-8 from a homogeneous product-8.
        +
        +
        Parameters:
        +
        p - The product-8 from which to create a vector.
        +
        Returns:
        +
        A new vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V8<A> cons(P1<A> head,
+                             V7<A> tail)
        +
        Creates a vector-8 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public A _8()
        +
        Returns the eighth element of this vector.
        +
        +
        Returns:
        +
        the eighth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V7<A> tail()
        +
        Returns all but the first element of this vector, as a vector-7.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P8<A,A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-8 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-8 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V8<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V8<B> apply(V8<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V8<C> zipWith(F<A,F<B,C>> f,
+                           V8<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V8<P2<A,B>> zip(V8<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V8<V2<A>> vzip(V8<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V8<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-8 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V8<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V8<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V8<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V8<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V8<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V8<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V8<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A> F<V8<A>,A> __8()
        +
        A first-class function to get the eighth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the eighth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/package-frame.html b/javadoc/4.8.1/functionaljava/fj/data/vector/package-frame.html new file mode 100644 index 0000000..b79af0e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/package-frame.html @@ -0,0 +1,27 @@ + + + + + +fj.data.vector (core 4.8.1 API) + + + + + +

fj.data.vector

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/package-summary.html b/javadoc/4.8.1/functionaljava/fj/data/vector/package-summary.html new file mode 100644 index 0000000..f111b7e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/package-summary.html @@ -0,0 +1,193 @@ + + + + + +fj.data.vector (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.vector

+
+
Fixed-length vectors
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    V +
    Functions across vectors.
    +
    V2<A> +
    A vector-2.
    +
    V3<A> +
    A vector-3.
    +
    V4<A> +
    A vector-4.
    +
    V5<A> +
    A vector-5.
    +
    V6<A> +
    A vector-6.
    +
    V7<A> +
    A vector-7.
    +
    V8<A> +
    A vector-8.
    +
    +
    • +
+ + + +

Package fj.data.vector Description

+
Fixed-length vectors
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/data/vector/package-tree.html b/javadoc/4.8.1/functionaljava/fj/data/vector/package-tree.html new file mode 100644 index 0000000..d35d2ec --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/data/vector/package-tree.html @@ -0,0 +1,142 @@ + + + + + +fj.data.vector Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.vector

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.vector.V
      • +
    • fj.data.vector.V2<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V3<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V4<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V5<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V6<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V7<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V8<A> (implements java.lang.Iterable<T>)
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/BigIntegers.html b/javadoc/4.8.1/functionaljava/fj/function/BigIntegers.html new file mode 100644 index 0000000..f437866 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/BigIntegers.html @@ -0,0 +1,402 @@ + + + + + +BigIntegers (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class BigIntegers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.BigIntegers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BigIntegers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.math.BigInteger,java.math.BigInteger>abs +
      Absolute value.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>add +
      Curried Integer addition.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>multiply +
      Curried Integer multiplication.
      +
      static F<java.math.BigInteger,java.math.BigInteger>negate +
      Negation.
      +
      static F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>>power +
      Power.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>remainder +
      Remainder.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.math.BigIntegerproduct(List<java.math.BigInteger> ints) +
      Returns the product of a list of big integers.
      +
      static java.math.BigIntegersum(List<java.math.BigInteger> ints) +
      Sums a list of big integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>> power
        +
        Power.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static java.math.BigInteger sum(List<java.math.BigInteger> ints)
        +
        Sums a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to sum.
        +
        Returns:
        +
        The sum of the big integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static java.math.BigInteger product(List<java.math.BigInteger> ints)
        +
        Returns the product of a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to multiply together.
        +
        Returns:
        +
        The product of the big integers in the list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Booleans.html b/javadoc/4.8.1/functionaljava/fj/function/Booleans.html new file mode 100644 index 0000000..8007319 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Booleans.html @@ -0,0 +1,775 @@ + + + + + +Booleans (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Booleans

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Booleans
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Booleans
+extends java.lang.Object
    +
    Curried logical functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>and +
      Curried form of logical "and" (conjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>if_ +
      Curried form of logical "if" (reverse material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>iff +
      Curried form of logical "if and only if" (biconditional, equivalence).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>implies +
      Curried form of logical "only if" (material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nif +
      Curried form of logical "not if" (reverse nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nimp +
      Curried form of logical "not implies" (nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nor +
      Curried form of logical "not or".
      +
      static F<java.lang.Boolean,java.lang.Boolean>not +
      Logical negation.
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>or +
      Curried form of logical "inclusive or" (disjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>xor +
      Curried form of logical xor (nonequivalence).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<A,java.lang.Boolean>and(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using conjunction
      +
      static booleanand(List<java.lang.Boolean> l) +
      Returns true if all the elements of the given list are true.
      +
      static booleanand(Stream<java.lang.Boolean> l) +
      Returns true if all the elements of the given stream are true.
      +
      static <A> F<A,java.lang.Boolean>andAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>andAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns composed predicate
      +
      static <A> F<java.lang.Boolean,F<A,F<A,A>>>cond() +
      Curried form of conditional.
      +
      static <A,B> F<B,java.lang.Boolean>contramap(F<B,A> f, + F<A,java.lang.Boolean> p) +
      maps given function to the predicate function
      +
      static <A,B> F<B,java.lang.Boolean>is(F<B,A> f, + F<A,java.lang.Boolean> p) +
      alias for contramap
      +
      static <A,B> F<B,java.lang.Boolean>isnot(F<B,A> f, + F<A,java.lang.Boolean> p) +
      returns inverse of contramap
      +
      static <A> F<A,java.lang.Boolean>not(F<A,java.lang.Boolean> p) +
      Negates the given predicate.
      +
      static <A> F<A,java.lang.Boolean>or(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      returns composed predicate using disjunction
      +
      static booleanor(List<java.lang.Boolean> l) +
      Returns true if any element of the given list is true.
      +
      static booleanor(Stream<java.lang.Boolean> l) +
      Returns true if any element of the given stream is true.
      +
      static <A> F<A,java.lang.Boolean>orAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>orAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given Stream of predicates
      +
      static <A> F<A,java.lang.Boolean>xor(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using exclusive disjunction
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        or

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> or
        +
        Curried form of logical "inclusive or" (disjunction).
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> and
        +
        Curried form of logical "and" (conjunction).
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> xor
        +
        Curried form of logical xor (nonequivalence).
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static final F<java.lang.Boolean,java.lang.Boolean> not
        +
        Logical negation.
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> implies
        +
        Curried form of logical "only if" (material implication).
        +
        • +
      + + + +
        +
      • +

        if_

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> if_
        +
        Curried form of logical "if" (reverse material implication).
        +
        • +
      + + + +
        +
      • +

        iff

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> iff
        +
        Curried form of logical "if and only if" (biconditional, equivalence).
        +
        • +
      + + + +
        +
      • +

        nimp

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nimp
        +
        Curried form of logical "not implies" (nonimplication).
        +
        • +
      + + + +
        +
      • +

        nif

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nif
        +
        Curried form of logical "not if" (reverse nonimplication).
        +
        • +
      + + + +
        +
      • +

        nor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nor
        +
        Curried form of logical "not or".
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public static boolean and(List<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given list are true.
        +
        +
        Parameters:
        +
        l - A list to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given list are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> F<B,java.lang.Boolean> contramap(F<B,A> f,
+                                                     F<A,java.lang.Boolean> p)
        +
        maps given function to the predicate function
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        is

        +
        public static <A,B> F<B,java.lang.Boolean> is(F<B,A> f,
+                                              F<A,java.lang.Boolean> p)
        +
        alias for contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        isnot

        +
        public static <A,B> F<B,java.lang.Boolean> isnot(F<B,A> f,
+                                                 F<A,java.lang.Boolean> p)
        +
        returns inverse of contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static <A> F<A,java.lang.Boolean> and(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using conjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static <A> F<A,java.lang.Boolean> xor(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using exclusive disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static <A> F<A,java.lang.Boolean> or(F<A,java.lang.Boolean> p1,
+                                            F<A,java.lang.Boolean> p2)
        +
        returns composed predicate using disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static boolean and(Stream<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given stream are true.
        +
        +
        Parameters:
        +
        l - A stream to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given stream are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns composed predicate
        +
        +
        Parameters:
        +
        l - A stream of predicates
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given Stream of predicates
        +
        +
        Parameters:
        +
        l - A stream of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(List<java.lang.Boolean> l)
        +
        Returns true if any element of the given list is true.
        +
        +
        Parameters:
        +
        l - A list to check for any element being true.
        +
        Returns:
        +
        true if any element of the given list is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(Stream<java.lang.Boolean> l)
        +
        Returns true if any element of the given stream is true.
        +
        +
        Parameters:
        +
        l - A stream to check for any element being true.
        +
        Returns:
        +
        true if any element of the given stream is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static <A> F<A,java.lang.Boolean> not(F<A,java.lang.Boolean> p)
        +
        Negates the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to negate.
        +
        Returns:
        +
        The negation of the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        cond

        +
        public static <A> F<java.lang.Boolean,F<A,F<A,A>>> cond()
        +
        Curried form of conditional. If the first argument is true, returns the second argument, + otherwise the third argument.
        +
        +
        Returns:
        +
        A function that returns its second argument if the first argument is true, otherwise the third argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Characters.html b/javadoc/4.8.1/functionaljava/fj/function/Characters.html new file mode 100644 index 0000000..d8942ae --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Characters.html @@ -0,0 +1,563 @@ + + + + + +Characters (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Characters

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Characters
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Characters
+extends java.lang.Object
    +
    First-class functions on Characters.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>>digit 
      static F<java.lang.Character,java.lang.Byte>getDirectionality 
      static F<java.lang.Character,java.lang.Integer>getNumericValue 
      static F<java.lang.Character,java.lang.Integer>getType 
      static F<java.lang.Character,java.lang.Boolean>isDefined 
      static F<java.lang.Character,java.lang.Boolean>isDigit 
      static F<java.lang.Character,java.lang.Boolean>isIdentifierIgnorable 
      static F<java.lang.Character,java.lang.Boolean>isISOControl 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isLetter 
      static F<java.lang.Character,java.lang.Boolean>isLetterOrDigit 
      static F<java.lang.Character,java.lang.Boolean>isLowerCase 
      static F<java.lang.Character,java.lang.Boolean>isMirrored 
      static F<java.lang.Character,java.lang.Boolean>isNewLine 
      static F<java.lang.Character,java.lang.Boolean>isSpaceChar 
      static F<java.lang.Character,java.lang.Boolean>isTitleCase 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isUpperCase 
      static F<java.lang.Character,java.lang.Boolean>isWhitespace 
      static F<java.lang.Character,java.lang.Character>reverseBytes 
      static F<java.lang.Character,java.lang.Character>toLowerCase 
      static F<java.lang.Character,java.lang.String>toString 
      static F<java.lang.Character,java.lang.Character>toTitleCase 
      static F<java.lang.Character,java.lang.Character>toUpperCase 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        toString

        +
        public static final F<java.lang.Character,java.lang.String> toString
        +
        • +
      + + + +
        +
      • +

        isLowerCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLowerCase
        +
        • +
      + + + +
        +
      • +

        isUpperCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUpperCase
        +
        • +
      + + + +
        +
      • +

        isTitleCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isTitleCase
        +
        • +
      + + + +
        +
      • +

        isDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDigit
        +
        • +
      + + + +
        +
      • +

        isDefined

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDefined
        +
        • +
      + + + +
        +
      • +

        isLetter

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetter
        +
        • +
      + + + +
        +
      • +

        isLetterOrDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetterOrDigit
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isIdentifierIgnorable

        +
        public static final F<java.lang.Character,java.lang.Boolean> isIdentifierIgnorable
        +
        • +
      + + + +
        +
      • +

        toLowerCase

        +
        public static final F<java.lang.Character,java.lang.Character> toLowerCase
        +
        • +
      + + + +
        +
      • +

        toUpperCase

        +
        public static final F<java.lang.Character,java.lang.Character> toUpperCase
        +
        • +
      + + + +
        +
      • +

        toTitleCase

        +
        public static final F<java.lang.Character,java.lang.Character> toTitleCase
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static final F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>> digit
        +
        • +
      + + + +
        +
      • +

        getNumericValue

        +
        public static final F<java.lang.Character,java.lang.Integer> getNumericValue
        +
        • +
      + + + +
        +
      • +

        isSpaceChar

        +
        public static final F<java.lang.Character,java.lang.Boolean> isSpaceChar
        +
        • +
      + + + +
        +
      • +

        isWhitespace

        +
        public static final F<java.lang.Character,java.lang.Boolean> isWhitespace
        +
        • +
      + + + +
        +
      • +

        isISOControl

        +
        public static final F<java.lang.Character,java.lang.Boolean> isISOControl
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public static final F<java.lang.Character,java.lang.Integer> getType
        +
        • +
      + + + +
        +
      • +

        getDirectionality

        +
        public static final F<java.lang.Character,java.lang.Byte> getDirectionality
        +
        • +
      + + + +
        +
      • +

        isMirrored

        +
        public static final F<java.lang.Character,java.lang.Boolean> isMirrored
        +
        • +
      + + + +
        +
      • +

        reverseBytes

        +
        public static final F<java.lang.Character,java.lang.Character> reverseBytes
        +
        • +
      + + + +
        +
      • +

        isNewLine

        +
        public static final F<java.lang.Character,java.lang.Boolean> isNewLine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Doubles.html b/javadoc/4.8.1/functionaljava/fj/function/Doubles.html new file mode 100644 index 0000000..2b66f44 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Doubles.html @@ -0,0 +1,502 @@ + + + + + +Doubles (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Doubles

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Doubles
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Doubles
+extends java.lang.Object
    +
    Curried functions over Doubles.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Double,java.lang.Double>abs +
      Absolute value.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>add +
      Curried Double addition.
      +
      static F<java.lang.Double,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Double,java.lang.Boolean>gteZero +
      A function that returns true if the given double is greater than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>gtZero +
      A function that returns true if the given double is greater than zero.
      +
      static F<java.lang.Double,java.lang.Boolean>lteZero +
      A function that returns true if the given double is less than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>ltZero +
      A function that returns true if the given double is less than zero.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>multiply +
      Curried Double multiplication.
      +
      static F<java.lang.Double,java.lang.Double>negate +
      Negation.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>power +
      Power.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>remainder +
      Remainder.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>subtract +
      Curried Double subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Double>>fromString() +
      A function that converts strings to doubles.
      +
      static doubleproduct(List<java.lang.Double> doubles) +
      Returns the product of a list of doubles.
      +
      static doublesum(List<java.lang.Double> doubles) +
      Sums a list of doubles.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> add
        +
        Curried Double addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> multiply
        +
        Curried Double multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> subtract
        +
        Curried Double subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Double,java.lang.Double> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Double,java.lang.Double> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Double,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gtZero
        +
        A function that returns true if the given double is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gteZero
        +
        A function that returns true if the given double is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> ltZero
        +
        A function that returns true if the given double is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> lteZero
        +
        A function that returns true if the given double is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static double sum(List<java.lang.Double> doubles)
        +
        Sums a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to sum.
        +
        Returns:
        +
        The sum of the doubless in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static double product(List<java.lang.Double> doubles)
        +
        Returns the product of a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to multiply together.
        +
        Returns:
        +
        The product of the doubles in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Double>> fromString()
        +
        A function that converts strings to doubles.
        +
        +
        Returns:
        +
        A function that converts strings to doubles.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect0.html b/javadoc/4.8.1/functionaljava/fj/function/Effect0.html new file mode 100644 index 0000000..0deaacd --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect0.html @@ -0,0 +1,220 @@ + + + + + +Effect0 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect0

+
+
+
+
    +
  • +
    +
    +
    public interface Effect0
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect1.html b/javadoc/4.8.1/functionaljava/fj/function/Effect1.html new file mode 100644 index 0000000..309b57c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect1.html @@ -0,0 +1,222 @@ + + + + + +Effect1 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect1<A>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect1<A>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect2.html b/javadoc/4.8.1/functionaljava/fj/function/Effect2.html new file mode 100644 index 0000000..1223bba --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect2.html @@ -0,0 +1,224 @@ + + + + + +Effect2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect2<A,B>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect2<A,B>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect3.html b/javadoc/4.8.1/functionaljava/fj/function/Effect3.html new file mode 100644 index 0000000..e997c6b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect3.html @@ -0,0 +1,226 @@ + + + + + +Effect3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect3<A,B,C>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect3<A,B,C>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect4.html b/javadoc/4.8.1/functionaljava/fj/function/Effect4.html new file mode 100644 index 0000000..08d9152 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect4.html @@ -0,0 +1,228 @@ + + + + + +Effect4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect4<A,B,C,D>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect4<A,B,C,D>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect5.html b/javadoc/4.8.1/functionaljava/fj/function/Effect5.html new file mode 100644 index 0000000..d0b43ec --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect5.html @@ -0,0 +1,230 @@ + + + + + +Effect5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect5<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect5<A,B,C,D,E>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect6.html b/javadoc/4.8.1/functionaljava/fj/function/Effect6.html new file mode 100644 index 0000000..96eb310 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect6.html @@ -0,0 +1,232 @@ + + + + + +Effect6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect6<A,B,C,D,E,F>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect6<A,B,C,D,E,F>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect7.html b/javadoc/4.8.1/functionaljava/fj/function/Effect7.html new file mode 100644 index 0000000..1327ec4 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect7.html @@ -0,0 +1,234 @@ + + + + + +Effect7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect7<A,B,C,D,E,F,G>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect7<A,B,C,D,E,F,G>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Effect8.html b/javadoc/4.8.1/functionaljava/fj/function/Effect8.html new file mode 100644 index 0000000..0bc1ce3 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Effect8.html @@ -0,0 +1,236 @@ + + + + + +Effect8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect8<A,B,C,D,E,F,G,H>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect8<A,B,C,D,E,F,G,H>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Integers.html b/javadoc/4.8.1/functionaljava/fj/function/Integers.html new file mode 100644 index 0000000..8b8a3f5 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Integers.html @@ -0,0 +1,502 @@ + + + + + +Integers (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Integers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Integers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Integers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Integer,java.lang.Integer>abs +
      Absolute value.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>add +
      Curried Integer addition.
      +
      static F<java.lang.Integer,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Integer,java.lang.Boolean>gteZero +
      A function that returns true if the given integer is greater than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>gtZero +
      A function that returns true if the given integer is greater than zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>lteZero +
      A function that returns true if the given integer is less than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>ltZero +
      A function that returns true if the given integer is less than zero.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>multiply +
      Curried Integer multiplication.
      +
      static F<java.lang.Integer,java.lang.Integer>negate +
      Negation.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>power +
      Power.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>remainder +
      Remainder.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Integer>>fromString() +
      A function that converts strings to integers.
      +
      static intproduct(List<java.lang.Integer> ints) +
      Returns the product of a list of integers.
      +
      static intsum(List<java.lang.Integer> ints) +
      Sums a list of integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Integer,java.lang.Integer> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Integer,java.lang.Integer> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Integer,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gtZero
        +
        A function that returns true if the given integer is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gteZero
        +
        A function that returns true if the given integer is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> ltZero
        +
        A function that returns true if the given integer is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> lteZero
        +
        A function that returns true if the given integer is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static int sum(List<java.lang.Integer> ints)
        +
        Sums a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to sum.
        +
        Returns:
        +
        The sum of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static int product(List<java.lang.Integer> ints)
        +
        Returns the product of a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to multiply together.
        +
        Returns:
        +
        The product of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Integer>> fromString()
        +
        A function that converts strings to integers.
        +
        +
        Returns:
        +
        A function that converts strings to integers.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Longs.html b/javadoc/4.8.1/functionaljava/fj/function/Longs.html new file mode 100644 index 0000000..6c7459e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Longs.html @@ -0,0 +1,321 @@ + + + + + +Longs (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Longs

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Longs
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Longs
+extends java.lang.Object
    +
    Curried functions over Longs.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Long,java.lang.Long>abs +
      Absolute value.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>add +
      Curried Long addition.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>multiply +
      Curried Long multiplication.
      +
      static F<java.lang.Long,java.lang.Long>negate +
      Negation.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>remainder +
      Remainder.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>subtract +
      Curried Long subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> add
        +
        Curried Long addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> multiply
        +
        Curried Long multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> subtract
        +
        Curried Long subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Long,java.lang.Long> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Long,java.lang.Long> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> remainder
        +
        Remainder.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Strings.html b/javadoc/4.8.1/functionaljava/fj/function/Strings.html new file mode 100644 index 0000000..fafe42f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Strings.html @@ -0,0 +1,467 @@ + + + + + +Strings (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Strings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Strings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strings
+extends java.lang.Object
    +
    Curried string functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>contains +
      A curried version of String.contains(CharSequence).
      +
      static F<java.lang.String,java.lang.Boolean>isEmpty +
      A curried version of String.isEmpty().
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrBlank +
      This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrEmpty +
      This function checks if a given String is neither null nor empty.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrBlank +
      This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrEmpty +
      This function checks if a given String is null or empty (String.isEmpty()).
      +
      static F<java.lang.String,java.lang.Integer>length +
      A curried version of String.length().
      +
      static java.lang.StringlineSeparator 
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>matches +
      A curried version of String.matches(String).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,List<java.lang.String>>lines() 
      static List<java.lang.String>lines(java.lang.String s) 
      static F<List<java.lang.String>,java.lang.String>unlines() 
      static java.lang.Stringunlines(List<java.lang.String> list) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        lineSeparator

        +
        public static final java.lang.String lineSeparator
        +
        • +
      + + + +
        +
      • +

        isNotNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrEmpty
        +
        This function checks if a given String is neither null nor empty.
        +
        +
        See Also:
        +
        isNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrEmpty
        +
        This function checks if a given String is null or empty (String.isEmpty()).
        +
        +
        See Also:
        +
        isNotNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNotNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrBlank
        +
        This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
        +
        +
        See Also:
        +
        isNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrBlank
        +
        This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
        +
        +
        See Also:
        +
        isNotNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isEmpty
        +
        A curried version of String.isEmpty().
        +
        • +
      + + + +
        +
      • +

        length

        +
        public static final F<java.lang.String,java.lang.Integer> length
        +
        A curried version of String.length().
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> contains
        +
        A curried version of String.contains(CharSequence). + The function returns true if the second argument contains the first.
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> matches
        +
        A curried version of String.matches(String). + The function returns true if the second argument matches the first.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lines

        +
        public static List<java.lang.String> lines(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public static F<java.lang.String,List<java.lang.String>> lines()
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static java.lang.String unlines(List<java.lang.String> list)
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static F<List<java.lang.String>,java.lang.String> unlines()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try0.html b/javadoc/4.8.1/functionaljava/fj/function/Try0.html new file mode 100644 index 0000000..fb54fcd --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try0.html @@ -0,0 +1,231 @@ + + + + + +Try0 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try0<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try0<A,Z extends java.lang.Exception>
    +
    A product of A which may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to a P1.
    +
    +
    See Also:
    +
    Try.f(Try0)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try1.html b/javadoc/4.8.1/functionaljava/fj/function/Try1.html new file mode 100644 index 0000000..c675532 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try1.html @@ -0,0 +1,233 @@ + + + + + +Try1 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try1<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try1<A,B,Z extends java.lang.Exception>
    +
    A transformation function from A to B that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F.
    +
    +
    See Also:
    +
    Try.f(Try1)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try2.html b/javadoc/4.8.1/functionaljava/fj/function/Try2.html new file mode 100644 index 0000000..3a2d67e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try2.html @@ -0,0 +1,235 @@ + + + + + +Try2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try2<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try2<A,B,C,Z extends java.lang.Exception>
    +
    A transformation function of arity-2 from A and B to C that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F2.
    +
    +
    See Also:
    +
    Try.f(Try2)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try3.html b/javadoc/4.8.1/functionaljava/fj/function/Try3.html new file mode 100644 index 0000000..35395a0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try3.html @@ -0,0 +1,237 @@ + + + + + +Try3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try3<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try3<A,B,C,D,Z extends java.lang.Exception>
    +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F3.
    +
    +
    See Also:
    +
    Try.f(Try3)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try4.html b/javadoc/4.8.1/functionaljava/fj/function/Try4.html new file mode 100644 index 0000000..bfaeaee --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try4.html @@ -0,0 +1,239 @@ + + + + + +Try4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try4<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try4<A,B,C,D,E,Z extends java.lang.Exception>
    +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F4.
    +
    +
    See Also:
    +
    Try.f(Try4)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try5.html b/javadoc/4.8.1/functionaljava/fj/function/Try5.html new file mode 100644 index 0000000..ef552aa --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try5.html @@ -0,0 +1,241 @@ + + + + + +Try5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F5.
    +
    +
    See Also:
    +
    Try.f(Try5)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F f(A a,
+    B b,
+    C c,
+    D d,
+    E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try6.html b/javadoc/4.8.1/functionaljava/fj/function/Try6.html new file mode 100644 index 0000000..1a3481e --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try6.html @@ -0,0 +1,243 @@ + + + + + +Try6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F6.
    +
    +
    See Also:
    +
    Try.f(Try6)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try7.html b/javadoc/4.8.1/functionaljava/fj/function/Try7.html new file mode 100644 index 0000000..051dbb0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try7.html @@ -0,0 +1,245 @@ + + + + + +Try7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F7.
    +
    +
    See Also:
    +
    Try.f(Try7)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Try8.html b/javadoc/4.8.1/functionaljava/fj/function/Try8.html new file mode 100644 index 0000000..89afc61 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Try8.html @@ -0,0 +1,247 @@ + + + + + +Try8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
    +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F8.
    +
    +
    See Also:
    +
    Try.f(Try8)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g,
+    H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect0.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect0.html new file mode 100644 index 0000000..9ca465f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect0.html @@ -0,0 +1,225 @@ + + + + + +TryEffect0 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect0<Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect0<Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect1.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect1.html new file mode 100644 index 0000000..d1fe02a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect1.html @@ -0,0 +1,227 @@ + + + + + +TryEffect1 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect1<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect1<A,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect2.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect2.html new file mode 100644 index 0000000..eda64fb --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect2.html @@ -0,0 +1,229 @@ + + + + + +TryEffect2 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect2<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect2<A,B,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect3.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect3.html new file mode 100644 index 0000000..d0f1953 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect3.html @@ -0,0 +1,231 @@ + + + + + +TryEffect3 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect3<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect3<A,B,C,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect4.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect4.html new file mode 100644 index 0000000..a40e98d --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect4.html @@ -0,0 +1,233 @@ + + + + + +TryEffect4 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect5.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect5.html new file mode 100644 index 0000000..a113351 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect5.html @@ -0,0 +1,235 @@ + + + + + +TryEffect5 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect6.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect6.html new file mode 100644 index 0000000..aee2061 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect6.html @@ -0,0 +1,237 @@ + + + + + +TryEffect6 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect7.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect7.html new file mode 100644 index 0000000..d40360a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect7.html @@ -0,0 +1,239 @@ + + + + + +TryEffect7 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/TryEffect8.html b/javadoc/4.8.1/functionaljava/fj/function/TryEffect8.html new file mode 100644 index 0000000..37c695a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/TryEffect8.html @@ -0,0 +1,241 @@ + + + + + +TryEffect8 (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    Created by mperry on 28/08/2014.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/Visitor.html b/javadoc/4.8.1/functionaljava/fj/function/Visitor.html new file mode 100644 index 0000000..3bf4ca7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/Visitor.html @@ -0,0 +1,393 @@ + + + + + +Visitor (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Visitor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Visitor
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Visitor
+extends java.lang.Object
    +
    The essence of the visitor design pattern expressed polymorphically.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<B,F<A,B>>association(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <A,B> F<P1<B>,F<A,B>>associationLazy(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <X> XfindFirst(List<Option<X>> values, + F0<X> def) +
      Returns the first value available in the given list of optional values.
      +
      static <X> XnullablefindFirst(List<X> values, + F0<X> def) +
      Returns the first non-null value in the given list of optional values.
      +
      static <A,B> BnullableVisitor(List<F<A,B>> visitors, + F0<B> def, + A value) +
      Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
      +
      static <A,B> Bvisitor(List<F<A,Option<B>>> visitors, + F0<B> def, + A value) +
      Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        findFirst

        +
        public static <X> X findFirst(List<Option<X>> values,
+                              F0<X> def)
        +
        Returns the first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The optional values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + +
        +
      • +

        nullablefindFirst

        +
        public static <X> X nullablefindFirst(List<X> values,
+                                      F0<X> def)
        +
        Returns the first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The potentially null values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + + + +
        +
      • +

        visitor

        +
        public static <A,B> B visitor(List<F<A,Option<B>>> visitors,
+                              F0<B> def,
+                              A value)
        +
        Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply.
        +
        def - The default if none of the visitors yield a value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + + + +
        +
      • +

        nullableVisitor

        +
        public static <A,B> B nullableVisitor(List<F<A,B>> visitors,
+                                      F0<B> def,
+                                      A value)
        +
        Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply looking for a non-null.
        +
        def - The default if none of the visitors yield a non-null value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + +
        +
      • +

        association

        +
        public static <A,B> F<B,F<A,B>> association(List<P2<A,B>> x,
+                                            Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      + + + +
        +
      • +

        associationLazy

        +
        public static <A,B> F<P1<B>,F<A,B>> associationLazy(List<P2<A,B>> x,
+                                                    Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/package-frame.html b/javadoc/4.8.1/functionaljava/fj/function/package-frame.html new file mode 100644 index 0000000..7fa5d73 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/package-frame.html @@ -0,0 +1,57 @@ + + + + + +fj.function (core 4.8.1 API) + + + + + +

fj.function

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/function/package-summary.html b/javadoc/4.8.1/functionaljava/fj/function/package-summary.html new file mode 100644 index 0000000..1bdfb85 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/package-summary.html @@ -0,0 +1,366 @@ + + + + + +fj.function (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.function

+
+
A prelude of commonly used first-class functions
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Effect0 +
    Created by mperry on 28/08/2014.
    +
    Effect1<A> +
    Created by mperry on 28/08/2014.
    +
    Effect2<A,B> +
    Created by mperry on 28/08/2014.
    +
    Effect3<A,B,C> +
    Created by mperry on 28/08/2014.
    +
    Effect4<A,B,C,D> +
    Created by mperry on 28/08/2014.
    +
    Effect5<A,B,C,D,E> +
    Created by mperry on 28/08/2014.
    +
    Effect6<A,B,C,D,E,F> +
    Created by mperry on 28/08/2014.
    +
    Effect7<A,B,C,D,E,F,G> +
    Created by mperry on 28/08/2014.
    +
    Effect8<A,B,C,D,E,F,G,H> +
    Created by mperry on 28/08/2014.
    +
    Try0<A,Z extends java.lang.Exception> +
    A product of A which may throw an Exception.
    +
    Try1<A,B,Z extends java.lang.Exception> +
    A transformation function from A to B that may throw an Exception.
    +
    Try2<A,B,C,Z extends java.lang.Exception> +
    A transformation function of arity-2 from A and B to C that may throw an Exception.
    +
    Try3<A,B,C,D,Z extends java.lang.Exception> +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception.
    +
    Try4<A,B,C,D,E,Z extends java.lang.Exception> +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
    +
    Try5<A,B,C,D,E,F,Z extends java.lang.Exception> +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
    +
    Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
    +
    Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
    +
    Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
    +
    TryEffect0<Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect1<A,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect2<A,B,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect3<A,B,C,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect4<A,B,C,D,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> +
    Created by mperry on 28/08/2014.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BigIntegers +
    Curried functions over Integers.
    +
    Booleans +
    Curried logical functions.
    +
    Characters +
    First-class functions on Characters.
    +
    Doubles +
    Curried functions over Doubles.
    +
    Integers +
    Curried functions over Integers.
    +
    Longs +
    Curried functions over Longs.
    +
    Strings +
    Curried string functions.
    +
    Visitor +
    The essence of the visitor design pattern expressed polymorphically.
    +
    +
    • +
+ + + +

Package fj.function Description

+
A prelude of commonly used first-class functions
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/function/package-tree.html b/javadoc/4.8.1/functionaljava/fj/function/package-tree.html new file mode 100644 index 0000000..cd1cc65 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/function/package-tree.html @@ -0,0 +1,172 @@ + + + + + +fj.function Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.function

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/package-frame.html b/javadoc/4.8.1/functionaljava/fj/package-frame.html new file mode 100644 index 0000000..5466ac7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/package-frame.html @@ -0,0 +1,89 @@ + + + + + +fj (core 4.8.1 API) + + + + + +

fj

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/package-summary.html b/javadoc/4.8.1/functionaljava/fj/package-summary.html new file mode 100644 index 0000000..cedbd18 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/package-summary.html @@ -0,0 +1,555 @@ + + + + + +fj (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj

+
+
Types that set the premise for the existence of Functional Java.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Equal.AltDefinition<A> +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    Equal.Definition<A> +
    Primitives functions of Equal: minimal definition and overridable methods.
    +
    F<A,B> +
    A transformation or function from A to B.
    +
    F0<A> +
    Created by MarkPerry on 21/01/2015.
    +
    F2<A,B,C> +
    A transformation function of arity-2 from A and B to C.
    +
    F3<A,B,C,D> +
    A transformation function of arity-3 from A, B and C to + D.
    +
    F4<A,B,C,D,E> +
    A transformation function of arity-4 from A, B, C and + D to E.
    +
    F5<A,B,C,D,E,F$> +
    A transformation function of arity-5 from A, B, C, + D and E to F$.
    +
    F6<A,B,C,D,E,F$,G> +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
    +
    F7<A,B,C,D,E,F$,G,H> +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
    +
    F8<A,B,C,D,E,F$,G,H,I> +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
    +
    Monoid.AltDefinition<A> +
    Primitives functions of Monoid: alternative minimal definition and overridable methods.
    +
    Monoid.Definition<A> +
    Primitives functions of Monoid: minimal definition and overridable methods.
    +
    Ord.AltDefinition<A> +
    Primitives functions of Ord: alternative minimal definition and overridable methods.
    +
    Ord.Definition<A> +
    Primitives functions of Ord: minimal definition and overridable methods.
    +
    Semigroup.AltDefinition<A> +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    Semigroup.Definition<A> +
    Primitives functions of Semigroup: minimal definition and overridable methods.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Bottom +
    Represents the bottom _|_ value.
    +
    Class<T> +
    A wrapper for a Class that provides additional methods.
    +
    Effect +
    Represents a side-effect.
    +
    Equal<A> +
    Tests for equality between two objects.
    +
    F1Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F1W<A,B> +
    Created by MarkPerry on 22/01/2015.
    +
    F1W.F1WFunc<A,B> 
    F2Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F2W<A,B,C> +
    Created by MarkPerry on 22/01/2015.
    +
    F2W.F2WFunc<A,B,C> 
    F3Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F3W<A,B,C,D> +
    Created by MarkPerry on 22/01/2015.
    +
    F4Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F4W<A,B,C,D,E> +
    Created by MarkPerry on 22/01/2015.
    +
    F5Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F5W<A,B,C,D,E,$F> +
    Created by MarkPerry on 22/01/2015.
    +
    F6Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F6W<A,B,C,D,E,$F,G> +
    Created by MarkPerry on 22/01/2015.
    +
    F7Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F7W<A,B,C,D,E,$F,G,H> +
    Created by MarkPerry on 22/01/2015.
    +
    F8Functions +
    Created by MarkPerry on 6/04/2014.
    +
    F8W<A,B,C,D,E,$F,G,H,I> +
    Created by MarkPerry on 22/01/2015.
    +
    Function +
    Transformations on functions.
    +
    Hash<A> +
    Produces a hash code for an object which should attempt uniqueness.
    +
    LcgRng +
    Created by MarkPerry on 7/07/2014.
    +
    Monoid<A> +
    A monoid abstraction to be defined across types of the given type argument.
    +
    Ord<A> +
    Tests for ordering between two objects.
    +
    P +
    Functions across products.
    +
    P1<A> 
    P2<A,B> +
    A product-2.
    +
    P2.Optic +
    Optic factory methods for a P2
    +
    P3<A,B,C> +
    A product-3.
    +
    P4<A,B,C,D> +
    A product-4.
    +
    P5<A,B,C,D,E> +
    A product-5.
    +
    P6<A,B,C,D,E,F> +
    A product-6.
    +
    P7<A,B,C,D,E,F,G> +
    A product-7.
    +
    P8<A,B,C,D,E,F,G,H> +
    A product-8.
    +
    Primitive +
    Functions that convert between Java primitive types.
    +
    Rng +
    Created by MarkPerry on 7/07/2014.
    +
    Semigroup<A> +
    Implementations must satisfy the law of associativity: + + Associativity; forall x.
    +
    Show<A> +
    Renders an object for display.
    +
    Try +
    Created by mperry on 24/07/2014.
    +
    TryEffect +
    Created by mperry on 29/08/2014.
    +
    Unit +
    The unit type which has only one value.
    +
    Void +
    A logically uninhabited data type.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    Digit +
    The digits zero to nine.
    +
    Ordering +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    +
    • +
+ + + +

Package fj Description

+
Types that set the premise for the existence of Functional Java.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/package-tree.html b/javadoc/4.8.1/functionaljava/fj/package-tree.html new file mode 100644 index 0000000..65f29b0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/package-tree.html @@ -0,0 +1,238 @@ + + + + + +fj Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/Parser.CharsParser.html b/javadoc/4.8.1/functionaljava/fj/parser/Parser.CharsParser.html new file mode 100644 index 0000000..3856944 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/Parser.CharsParser.html @@ -0,0 +1,1503 @@ + + + + + +Parser.CharsParser (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.CharsParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.CharsParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.CharsParser
+extends java.lang.Object
    +
    Parsers that accept Stream<Character> input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(E missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(F0<E> missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(F0<E> missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(E missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(F0<E> missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(E missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(F0<E> missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(E missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(F0<E> missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(E missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(E missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(F0<E> missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(E missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(E missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(F0<E> missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(E missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(F0<E> missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(E missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/Parser.StreamParser.html b/javadoc/4.8.1/functionaljava/fj/parser/Parser.StreamParser.html new file mode 100644 index 0000000..7f93bc1 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/Parser.StreamParser.html @@ -0,0 +1,331 @@ + + + + + +Parser.StreamParser (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.StreamParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.StreamParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.StreamParser
+extends java.lang.Object
    +
    Parsers that accept Stream input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <I,E> Parser<Stream<I>,I,E>element(E e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>element(F0<E> e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(E missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(F0<E> missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(F0<E> e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(E e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(F0<E> missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      + + + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(E missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/Parser.html b/javadoc/4.8.1/functionaljava/fj/parser/Parser.html new file mode 100644 index 0000000..13dd28a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/Parser.html @@ -0,0 +1,949 @@ + + + + + +Parser (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser<I,A,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser<I,A,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Parser<I,A,E>
+extends java.lang.Object
    +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        parse

        +
        public Validation<E,Result<I,A>> parse(I i)
        +
        Parses the input to produce a result or error.
        +
        +
        Parameters:
        +
        i - The input to parse.
        +
        Returns:
        +
        A parse result with the remaining input or an error.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <Z> Parser<Z,A,E> xmap(F<I,Z> f,
+                              F<Z,I> g)
        +
        Maps the parse input type through an invariant functor.
        +
        +
        Parameters:
        +
        f - The function to covariant map.
        +
        g - The function to contra-variant map.
        +
        Returns:
        +
        A parser with the new input type.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Parser<I,B,E> map(F<A,B> f)
        +
        Maps the given result type across this parser.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A parser with the new result type.
        +
        +
        • +
      + + + + + +
        +
      • +

        filter

        +
        public Parser<I,A,E> filter(F<A,java.lang.Boolean> f,
+                            E e)
        +
        Returns a parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to filter on.
        +
        e - The error to in the event that the predicate is not met.
        +
        Returns:
        +
        A parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Parser<I,B,E> bind(F<A,Parser<I,B,E>> f)
        +
        Binds the given function across the parser with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this parser.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Parser<I,C,E> bind(Parser<I,B,E> pb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Parser<I,D,E> bind(Parser<I,B,E> pb,
+                                  Parser<I,C,E> pc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$> Parser<I,E$,E> bind(Parser<I,B,E> pb,
+                                      Parser<I,C,E> pc,
+                                      Parser<I,D,E> pd,
+                                      F<A,F<B,F<C,F<D,E$>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$> Parser<I,F$,E> bind(Parser<I,B,E> pb,
+                                         Parser<I,C,E> pc,
+                                         Parser<I,D,E> pd,
+                                         Parser<I,E$,E> pe,
+                                         F<A,F<B,F<C,F<D,F<E$,F$>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G> Parser<I,G,E> bind(Parser<I,B,E> pb,
+                                          Parser<I,C,E> pc,
+                                          Parser<I,D,E> pd,
+                                          Parser<I,E$,E> pe,
+                                          Parser<I,F$,E> pf,
+                                          F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H> Parser<I,H,E> bind(Parser<I,B,E> pb,
+                                            Parser<I,C,E> pc,
+                                            Parser<I,D,E> pd,
+                                            Parser<I,E$,E> pe,
+                                            Parser<I,F$,E> pf,
+                                            Parser<I,G,E> pg,
+                                            F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H,I$> Parser<I,I$,E> bind(Parser<I,B,E> pb,
+                                                Parser<I,C,E> pc,
+                                                Parser<I,D,E> pd,
+                                                Parser<I,E$,E> pe,
+                                                Parser<I,F$,E> pf,
+                                                Parser<I,G,E> pg,
+                                                Parser<I,H,E> ph,
+                                                F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,F<H,I$>>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        ph - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Parser<I,B,E> sequence(Parser<I,B,E> p)
        +
        Binds anonymously, ignoring the result value.
        +
        +
        Parameters:
        +
        p - The parser to bind with.
        +
        Returns:
        +
        A parser after binding anonymously.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Parser<I,B,E> apply(Parser<I,F<A,B>,E> p)
        +
        Performs function application within a parser.
        +
        +
        Parameters:
        +
        p - The parser returning a function value.
        +
        Returns:
        +
        A new parser after function application.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(F0<E> e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(E e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + +
        +
      • +

        repeat

        +
        public Parser<I,Stream<A>,E> repeat()
        +
        Returns a parser that repeats application of this parser zero or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser zero or many times.
        +
        +
        • +
      + + + +
        +
      • +

        repeat1

        +
        public Parser<I,Stream<A>,E> repeat1()
        +
        Returns a parser that repeats application of this parser one or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser one or many times.
        +
        +
        • +
      + + + +
        +
      • +

        mapError

        +
        public <K> Parser<I,A,K> mapError(F<E,K> f)
        +
        Maps the given function across this parser's error.
        +
        +
        Parameters:
        +
        f - The function to map this parser's error with.
        +
        Returns:
        +
        A new parser with a new error type.
        +
        +
        • +
      + + + +
        +
      • +

        parser

        +
        public static <I,A,E> Parser<I,A,E> parser(F<I,Validation<E,Result<I,A>>> f)
        +
        Returns a parser that computes using the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the parser with.
        +
        Returns:
        +
        A parser that computes using the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <I,A,E> Parser<I,A,E> value(A a)
        +
        Constructs a parser that always returns the given value. The unital for a parser.
        +
        +
        Parameters:
        +
        a - The value to consistently return from a parser.
        +
        Returns:
        +
        A parser that always returns the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <I,A,E> Parser<I,A,E> fail(E e)
        +
        Returns a parser that always fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with.
        +
        Returns:
        +
        A parser that always fails with the given error.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/Result.html b/javadoc/4.8.1/functionaljava/fj/parser/Result.html new file mode 100644 index 0000000..7ed906c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/Result.html @@ -0,0 +1,524 @@ + + + + + +Result (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Result<I,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Result<I,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Result<I,A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>>bimap() +
      First-class bifunctor map.
      +
      <B,J> Result<J,B>bimap(F<I,J> f, + F<A,B> g) +
      A bifunctor map across both the remainder of the parse input and the parse value.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      java.util.Iterator<A>iterator() +
      Returns an iterator over the parse value.
      +
      <J> F<F<I,J>,Result<J,A>>mapRest() +
      First-class function mapping across the remainder of the parse input.
      +
      <J> Result<J,A>mapRest(F<I,J> f) +
      Maps the given function across the remainder of the parse input.
      +
      <B> F<F<A,B>,Result<I,B>>mapValue() +
      First-class function mapping across the parse value.
      +
      <B> Result<I,B>mapValue(F<A,B> f) +
      Maps the given function across the parse value.
      +
      Irest() +
      The remainder of the parse input.
      +
      static <A,I> F<I,F<A,Result<I,A>>>result() +
      First-class construction of a result.
      +
      static <A,I> Result<I,A>result(I i, + A a) +
      Construct a result with the given remainder of the parse input and parse value.
      +
      java.lang.StringtoString() 
      Avalue() +
      The parsed value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        rest

        +
        public I rest()
        +
        The remainder of the parse input.
        +
        +
        Returns:
        +
        The remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The parsed value.
        +
        +
        Returns:
        +
        The parsed value.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> Result<J,A> mapRest(F<I,J> f)
        +
        Maps the given function across the remainder of the parse input.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> F<F<I,J>,Result<J,A>> mapRest()
        +
        First-class function mapping across the remainder of the parse input.
        +
        +
        Returns:
        +
        A first-class function mapping across the remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> Result<I,B> mapValue(F<A,B> f)
        +
        Maps the given function across the parse value.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse value.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> F<F<A,B>,Result<I,B>> mapValue()
        +
        First-class function mapping across the parse value.
        +
        +
        Returns:
        +
        A first-class function mapping across the parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> Result<J,B> bimap(F<I,J> f,
+                               F<A,B> g)
        +
        A bifunctor map across both the remainder of the parse input and the parse value.
        +
        +
        Parameters:
        +
        f - The function to map the remainder of the parse input with.
        +
        g - The function to map the parse value with.
        +
        Returns:
        +
        A result with a different parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>> bimap()
        +
        First-class bifunctor map.
        +
        +
        Returns:
        +
        A first-class bifunctor map.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator over the parse value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        An iterator over the parse value.
        +
        +
        • +
      + + + + + +
        +
      • +

        result

        +
        public static <A,I> Result<I,A> result(I i,
+                                       A a)
        +
        Construct a result with the given remainder of the parse input and parse value.
        +
        +
        Parameters:
        +
        i - The remainder of the parse input.
        +
        a - The parse value.
        +
        Returns:
        +
        A result with the given remainder of the parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        result

        +
        public static <A,I> F<I,F<A,Result<I,A>>> result()
        +
        First-class construction of a result.
        +
        +
        Returns:
        +
        A first-class function for construction of a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/package-frame.html b/javadoc/4.8.1/functionaljava/fj/parser/package-frame.html new file mode 100644 index 0000000..6cb33f7 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/package-frame.html @@ -0,0 +1,23 @@ + + + + + +fj.parser (core 4.8.1 API) + + + + + +

fj.parser

+
+

Classes

+ +
+ + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/package-summary.html b/javadoc/4.8.1/functionaljava/fj/parser/package-summary.html new file mode 100644 index 0000000..01dbad0 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/package-summary.html @@ -0,0 +1,170 @@ + + + + + +fj.parser (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.parser

+
+
Parser combinators.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Parser<I,A,E> +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    Parser.CharsParser +
    Parsers that accept Stream<Character> input.
    +
    Parser.StreamParser +
    Parsers that accept Stream input.
    +
    Result<I,A> +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    +
    • +
+ + + +

Package fj.parser Description

+
Parser combinators.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/fj/parser/package-tree.html b/javadoc/4.8.1/functionaljava/fj/parser/package-tree.html new file mode 100644 index 0000000..ab94a52 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/fj/parser/package-tree.html @@ -0,0 +1,138 @@ + + + + + +fj.parser Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.parser

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/help-doc.html b/javadoc/4.8.1/functionaljava/help-doc.html new file mode 100644 index 0000000..1974599 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/index-all.html b/javadoc/4.8.1/functionaljava/index-all.html new file mode 100644 index 0000000..129240b --- /dev/null +++ b/javadoc/4.8.1/functionaljava/index-all.html @@ -0,0 +1,15676 @@ + + + + + +Index (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _  + + +

$

+
+
$<A,B> - Class in fj.data
+
+
The constant arrow, for attaching a new name to an existing type.
+
+
+ + + +

A

+
+
abs - Static variable in class fj.function.BigIntegers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Doubles
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Integers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Longs
+
+
Absolute value.
+
+
absurd() - Method in class fj.Void
+
+
Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
+
+
accumapply(Semigroup<E>, Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F<T, F<A, B>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F2<T, A, B>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F<T, F<A, F<B, C>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F3<T, A, B, C>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F<T, F<A, F<B, F<C, D>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F4<T, A, B, C, D>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F<T, F<A, F<B, F<C, F<D, E$>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F5<T, A, B, C, D, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F<T, F<A, F<B, F<C, F<D, F<E$, F$>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F6<T, A, B, C, D, E$, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F7<T, A, B, C, D, E$, F$, G>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F8<T, A, B, C, D, E$, F$, G, H>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate() - Method in class fj.data.Validation
+
 
+
accumulate(F<T, B>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, F2<T, B, C>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, F3<T, B, C, D>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, F4<T, B, C, D, $E>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, F5<T, B, C, D, $E, $F>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, F6<T, B, C, D, $E, $F, G>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, F7<T, B, C, D, $E, $F, G, H>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, Validation<E, H>, F8<T, B, C, D, $E, $F, G, H, I>) - Method in class fj.data.Validation
+
 
+
act(A) - Method in class fj.control.parallel.Actor
+
+
Pass a message to this actor, applying its side-effect to the message.
+
+
Actor<A> - Class in fj.control.parallel
+
+
Light weight actors for Java.
+
+
actor(Strategy<Unit>, Effect1<A>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Strategy<Unit>, F<A, P1<Unit>>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a concurrent actor that is guaranteed to process only one message at a time.
+
+
actor() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of actors.
+
+
add(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HSucc<M>, H) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of numbers a and b is one greater than the sum of b and the predecessor of a.
+
+
add - Static variable in class fj.data.Natural
+
+
A function that adds two natural numbers.
+
+
add(Natural) - Method in class fj.data.Natural
+
+
Add two natural numbers together.
+
+
add - Static variable in class fj.function.BigIntegers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Doubles
+
+
Curried Double addition.
+
+
add - Static variable in class fj.function.Integers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Longs
+
+
Curried Long addition.
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if all targets satisfy the predicate
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if all targets satisfy the predicate
+
+
allEqual(Equal<A>) - Method in class fj.data.List
+
+
Returns whether or not all elements in the list are equal according to the given equality test.
+
+
alpha(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alpha(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alphaNum(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
alphaNum(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
always(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation without caching.
+
+
and(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
and - Static variable in class fj.function.Booleans
+
+
Curried form of logical "and" (conjunction).
+
+
and(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given list are true.
+
+
and(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using conjunction
+
+
and(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given stream are true.
+
+
andAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns composed predicate
+
+
andAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
andThen(F<B, C>) - Method in class fj.data.Reader
+
 
+
andThen(F<A, B>, F<B, C>) - Static method in class fj.F1Functions
+
+
Function composition flipped.
+
+
andThen(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class composition flipped.
+
+
andThen(F<B, C>) - Method in class fj.F1W
+
+
Function composition flipped.
+
+
andThen() - Method in class fj.F1W
+
+
First-class composition flipped.
+
+
andThen() - Static method in class fj.Function
+
+
Function composition flipped.
+
+
andThen(F<A, B>, F<B, C>) - Static method in class fj.Function
+
+
Function composition flipped.
+
+
anyEqual() - Static method in class fj.Equal
+
+
Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
+
+
anyHash() - Static method in class fj.Hash
+
+
A hash that uses Object.hashCode().
+
+
anyShow() - Static method in class fj.Show
+
+
Returns a show instance that uses Object.toString() to perform the display rendering.
+
+
append(Array<A>) - Method in class fj.data.Array
+
+
Appends the given array to this array.
+
+
append(Array<A>) - Method in class fj.data.Array.ImmutableProjection
+
+
Appends the given array to this array.
+
+
append(DList<A>) - Method in class fj.data.DList
+
+
Appends two DLists together to produce a new DList.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Deep
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Empty
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.FingerTree
+
+
Appends one finger tree to another.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Single
+
 
+
append() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for concatenating heterogeneous lists.
+
+
append(A, B) - Method in class fj.data.hlist.HList.HAppend
+
+
Append a given heterogeneous list to another.
+
+
append() - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for concatenating lists to the empty list.
+
+
append(H) - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for appending lists to a nonempty heterogeneous list.
+
+
append(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
append(IO<B>) - Method in class fj.data.IOW
+
 
+
append(LazyString) - Method in class fj.data.LazyString
+
+
Appends the given lazy string to the end of this lazy string.
+
+
append(String) - Method in class fj.data.LazyString
+
+
Appends the given String to the end of this lazy string.
+
+
append(List<A>) - Method in class fj.data.List
+
+
Appends the given list to this list.
+
+
append(List<A>) - Method in class fj.data.List.Buffer
+
+
Appends the given list to this buffer.
+
+
append(List<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(NonEmptyList<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(Seq<A>) - Method in class fj.data.Seq
+
+
Appends the given sequence to this sequence.
+
+
append(Stream<A>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(A, A) - Method in interface fj.Monoid.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Ord.Definition
+
 
+
append(C) - Method in class fj.P2
+
+
Creates a P3 by adding the given element to the current P2
+
+
append(P2<C, D>) - Method in class fj.P2
+
+
Creates a P4 by adding the given element to the current P2
+
+
append(P3<C, D, E>) - Method in class fj.P2
+
+
Creates a P5 by adding the given element to the current P2
+
+
append(P4<C, D, E, F>) - Method in class fj.P2
+
+
Creates a P6 by adding the given element to the current P2
+
+
append(P5<C, D, E, F, G>) - Method in class fj.P2
+
+
Creates a P7 by adding the given element to the current P2
+
+
append(P6<C, D, E, F, G, H>) - Method in class fj.P2
+
+
Creates a P8 by adding the given element to the current P2
+
+
append(D) - Method in class fj.P3
+
+
Creates a P4 by adding the given element to the current P3
+
+
append(P2<D, E>) - Method in class fj.P3
+
+
Creates a P5 by adding the given element to the current P3
+
+
append(P3<D, E, F>) - Method in class fj.P3
+
+
Creates a P6 by adding the given element to the current P3
+
+
append(P4<D, E, F, G>) - Method in class fj.P3
+
+
Creates a P7 by adding the given element to the current P3
+
+
append(P5<D, E, F, G, H>) - Method in class fj.P3
+
+
Creates a P8 by adding the given element to the current P3
+
+
append(E) - Method in class fj.P4
+
+
Creates a P5 by adding the given element to the current P4
+
+
append(P2<E, F>) - Method in class fj.P4
+
+
Creates a P6 by adding the given element to the current P4
+
+
append(P3<E, F, G>) - Method in class fj.P4
+
+
Creates a P7 by adding the given element to the current P4
+
+
append(P4<E, F, G, H>) - Method in class fj.P4
+
+
Creates a P8 by adding the given element to the current P4
+
+
append(F) - Method in class fj.P5
+
+
Creates a P6 by adding the given element to the current P5
+
+
append(P2<F, G>) - Method in class fj.P5
+
+
Creates a P7 by adding the given element to the current P5
+
+
append(P3<F, G, H>) - Method in class fj.P5
+
+
Creates a P8 by adding the given element to the current P5
+
+
append(G) - Method in class fj.P6
+
+
Creates a P7 by adding the given element to the current P6
+
+
append(P2<G, H>) - Method in class fj.P6
+
+
Creates a P8 by adding the given element to the current P6
+
+
append(H) - Method in class fj.P7
+
+
Creates a P8 by adding the given element to the current P7
+
+
append(A, A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Semigroup.Definition
+
 
+
apply(Callable<A>, Callable<F<A, B>>) - Static method in class fj.control.parallel.Callables
+
+
Performs function application within a callable (applicative functor pattern).
+
+
apply(Promise<F<A, B>>) - Method in class fj.control.parallel.Promise
+
+
Performs function application within a promise (applicative functor pattern).
+
+
apply(Trampoline<F<A, B>>) - Method in class fj.control.Trampoline
+
+
Performs function application within a Trampoline (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Either<F<A, X>, B>) - Method in class fj.data.Either.LeftProjection
+
+
Function application on this projection's value.
+
+
apply(Either<A, F<B, X>>) - Method in class fj.data.Either.RightProjection
+
+
Function application on this projection's value.
+
+
Apply() - Constructor for class fj.data.hlist.HList.Apply
+
 
+
apply(F$, A) - Method in class fj.data.hlist.HList.Apply
+
 
+
apply(IO<A>, IO<F<A, B>>) - Static method in class fj.data.IOFunctions
+
 
+
apply(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Performs function application within an iterable (applicative functor pattern).
+
+
apply(F0<Z>, F0<F<E, Z>>, F0<Z>) - Method in class fj.data.Iteratee.Input
+
 
+
apply(List<F<A, B>>) - Method in class fj.data.List
+
+
Performs function application within a list (applicative functor pattern).
+
+
apply(Option<F<A, B>>) - Method in class fj.data.Option
+
+
Performs function application within an optional value (applicative functor pattern).
+
+
apply(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Performs function application within a stream (applicative functor pattern).
+
+
apply(Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the success value.
+
+
apply(Validation<F<E, A>, T>) - Method in class fj.data.Validation.FailProjection
+
+
Function application on the failing value.
+
+
apply(V2<F<A, B>>) - Method in class fj.data.vector.V2
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V3<F<A, B>>) - Method in class fj.data.vector.V3
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V4<F<A, B>>) - Method in class fj.data.vector.V4
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V5<F<A, B>>) - Method in class fj.data.vector.V5
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V6<F<A, B>>) - Method in class fj.data.vector.V6
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V7<F<A, B>>) - Method in class fj.data.vector.V7
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V8<F<A, B>>) - Method in class fj.data.vector.V8
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(F<A, B>, F<A, F<B, C>>) - Static method in class fj.F1Functions
+
+
Function application in an environment (Applicative Functor).
+
+
apply(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function application in an environment.
+
+
apply(F<A, F<B, C>>) - Method in class fj.F1W
+
+
Function application in an environment (Applicative Functor).
+
+
apply() - Method in class fj.F1W
+
+
First-class function application in an environment.
+
+
apply(A) - Static method in class fj.Function
+
+
Function application with the arguments flipped.
+
+
apply(F<C, F<A, B>>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(F2<C, A, B>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(P1<F<A, B>>) - Method in class fj.P1
+
+
Performs function application within a P1 (applicative functor pattern).
+
+
apply(Parser<I, F<A, B>, E>) - Method in class fj.parser.Parser
+
+
Performs function application within a parser.
+
+
Array<A> - Class in fj.data
+
+
Provides an interface to arrays.
+
+
array(Class<A[]>) - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array() - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array(A...) - Static method in class fj.data.Array
+
+
Constructs an array from the given elements.
+
+
array(Class<A[]>) - Method in class fj.data.List
+
+
Returns an array from this list.
+
+
array(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array from this optional value.
+
+
array(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns an array from this stream.
+
+
Array.ImmutableProjection<A> - Class in fj.data
+
+
Projects an array by providing only operations which do not mutate.
+
+
Array_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to array blocking queues.
+
+
Array_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to array lists.
+
+
Array_BitSet - Static variable in class fj.data.Java
+
+
A function that converts arrays to bit sets.
+
+
Array_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to concurrent linked queues.
+
+
Array_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array lists.
+
+
Array_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array sets.
+
+
Array_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to delay queues.
+
+
Array_Either() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to eithers.
+
+
Array_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to enum sets.
+
+
Array_HashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to hash sets.
+
+
Array_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked blocking queues.
+
+
Array_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked hash sets.
+
+
Array_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked lists.
+
+
Array_List() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to lists.
+
+
Array_Option() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to options.
+
+
Array_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority blocking queues.
+
+
Array_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority queues.
+
+
Array_Stack() - Static method in class fj.data.Java
+
+
A function that converts arrays to stacks.
+
+
Array_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to streams.
+
+
Array_String - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to strings.
+
+
Array_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string buffers.
+
+
Array_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string builders.
+
+
Array_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to synchronous queues.
+
+
Array_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to tree sets.
+
+
Array_Vector() - Static method in class fj.data.Java
+
+
A function that converts arrays to vectors.
+
+
arrayArray(A...) - Static method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
ArrayBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts array blocking queues to lists.
+
+
arrayDList(A...) - Static method in class fj.data.DList
+
+
Creates a DList from an array
+
+
arrayEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Array type.
+
+
arrayHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Array type.
+
+
arrayHashMap(P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashMap(Equal<K>, Hash<K>, P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayHashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a Array.
+
+
arrayK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a Array.
+
+
arrayList(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
ArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts array lists to lists.
+
+
arrayM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Arrays.
+
+
arrayM() - Method in class fj.F2W
+
+
Promotes this function to a function on Arrays.
+
+
arrayMonoid() - Static method in class fj.Monoid
+
+
A monoid for arrays.
+
+
arrayOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Array type.
+
+
arraySemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for arrays.
+
+
arraySeq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the array.
+
+
arraySet(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
arrayShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Array type.
+
+
arrayStream(A...) - Static method in class fj.data.Stream
+
 
+
arrayTreeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
arrow() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a function to a Callable-valued function that is equivalent to it.
+
+
arrow() - Static method in class fj.data.IterableW
+
+
Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
+
+
as(IO<A>, B) - Static method in class fj.data.IOFunctions
+
 
+
asFold() - Method in class fj.data.optic.Getter
+
+
view a Getter with a Fold
+
+
asFold() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Fold
+
+
asFold() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Fold
+
+
asFold() - Method in class fj.data.optic.POptional
+
+
view a POptional as a Fold
+
+
asFold() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Fold
+
+
asFold() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a Fold
+
+
asFunction() - Method in class fj.control.db.DB
+
+
Returns the callable-valued function projection of this database action.
+
+
asGetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Getter
+
+
asGetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Getter
+
+
asJavaList() - Method in class fj.data.Array
+
+
Projects an unmodifiable list view of this array.
+
+
asLens() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Lens
+
+
asLens() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PLens
+
+
asOptional() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Optional
+
+
asOptional() - Method in class fj.data.optic.Lens
+
+
view a Lens as an Optional
+
+
asOptional() - Method in class fj.data.optic.PIso
+
+
view a PIso as a POptional
+
+
asOptional() - Method in class fj.data.optic.PLens
+
+
view a PLens as an POptional
+
+
asOptional() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a POptional
+
+
asOptional() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Optional
+
+
asPrism() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Prism
+
+
asPrism() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PPrism
+
+
asSetter() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Setter
+
+
asSetter() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Setter
+
+
asSetter() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Setter
+
+
asSetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Setter
+
+
asSetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PSetter
+
+
asSetter() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PSetter
+
+
asSetter() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Setter
+
+
asSetter() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Setter
+
+
asSetter() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a PSetter
+
+
asSetter() - Method in class fj.data.optic.Traversal
+
+
view a Traversal as a Setter
+
+
association(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
associationLazy(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
asString() - Method in class fj.data.hamt.BitSet
+
 
+
asString(List<Character>) - Static method in class fj.data.List
+
+
Returns a string from the given list of characters.
+
+
asString() - Static method in class fj.data.List
+
+
A first-class asString.
+
+
asString(Stream<Character>) - Static method in class fj.data.Stream
+
+
Returns a string from the given stream of characters.
+
+
asTraversal() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Traversal
+
+
atEnd() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the last element.
+
+
atStart() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the first element.
+
+
+ + + +

B

+
+
BASE_LONG - Static variable in class fj.data.hamt.BitSet
+
 
+
bigdecimalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big decimals.
+
+
bigdecimalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big decimals.
+
+
bigdecimalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigDecimal.
+
+
bigdecimalEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigDecimal type.
+
+
bigdecimalHash - Static variable in class fj.Hash
+
+
A hash instance for the BigDecimal type.
+
+
bigDecimalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big decimals.
+
+
bigDecimalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big decimals.
+
+
bigdecimalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big decimals.
+
+
bigdecimalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big decimals.
+
+
bigdecimalOrd - Static variable in class fj.Ord
+
+
An order instance for the BigDecimal type.
+
+
bigdecimalShow - Static variable in class fj.Show
+
+
A show instance for the BigDecimal type.
+
+
bigintAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big integers.
+
+
bigintAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big integers.
+
+
BigIntegers - Class in fj.function
+
+
Curried functions over Integers.
+
+
bigIntegerValue - Static variable in class fj.data.Natural
+
+
A function that returns the BigInteger value of a given Natural.
+
+
bigIntegerValue() - Method in class fj.data.Natural
+
+
Return the BigInteger value of this natural number.
+
+
bigintEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigInteger.
+
+
bigintEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigInteger type.
+
+
bigintHash - Static variable in class fj.Hash
+
+
A hash instance for the BigInteger type.
+
+
bigintMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big integers.
+
+
bigintMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big integers.
+
+
bigintMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big integers.
+
+
bigintMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big integers.
+
+
bigintOrd - Static variable in class fj.Ord
+
+
An order instance for the BigInteger type.
+
+
bigintShow - Static variable in class fj.Show
+
+
A show instance for the BigInteger type.
+
+
bimap(F<A, X>, F<B, Y>) - Method in class fj.data.Either
+
+
Map the given functions across the appropriate side.
+
+
bimap(F<I, J>, F<A, B>) - Method in class fj.parser.Result
+
+
A bifunctor map across both the remainder of the parse input and the parse value.
+
+
bimap() - Method in class fj.parser.Result
+
+
First-class bifunctor map.
+
+
bind(F<A, DB<B>>) - Method in class fj.control.db.DB
+
+
Binds the given action across the result of this database action.
+
+
bind(Callable<A>, F<A, Callable<B>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the value in a Callable with a final join.
+
+
bind(Callable<A>, Callable<B>, F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the values in the given callables with a final join.
+
+
bind(F<A, Promise<B>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function over this promise, with a final join.
+
+
bind(Promise<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(P1<Promise<B>>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(F<A, Trampoline<B>>) - Method in class fj.control.Trampoline
+
+
Binds the given continuation to the result of this trampoline.
+
+
bind(Trampoline<B>, F<A, F<B, C>>) - Method in class fj.control.Trampoline
+
+
Binds the given function across the result of this Trampoline and the given Trampoline.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(F<A, Either<X, B>>) - Method in class fj.data.Either.LeftProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<B, Either<A, X>>) - Method in class fj.data.Either.RightProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function that directly produces Eval.
+
+
bind(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
bind(F<A, IO<B>>) - Method in class fj.data.IOW
+
 
+
bind(F<A, T>) - Method in class fj.data.IterableW
+
+
Binds the given function across the wrapped Iterable with a final join.
+
+
bind(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Binds the given function to the values in the given iterables with a final join.
+
+
bind() - Static method in class fj.data.IterableW
+
+
The first-class bind function over Iterable.
+
+
bind(F<A, Iteratee.IterV<E, B>>) - Method in class fj.data.Iteratee.IterV
+
+
TODO more documentation
+
+
bind(F<Character, LazyString>) - Method in class fj.data.LazyString
+
 
+
bind(F<A, List<B>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, List<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, List<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(F<A, NonEmptyList<B>>) - Method in class fj.data.NonEmptyList
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(F<A, Option<B>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value with a final join.
+
+
bind(Option<B>, F<A, F<B, C>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind() - Static method in class fj.data.Option
+
+
First-class bind function.
+
+
bind(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
bind(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Set
+
+
Binds the given function across this set.
+
+
bind(F<A, Stream<B>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream with a final join.
+
+
bind(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, Stream<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, Stream<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(F<T, Validation<E, A>>) - Method in class fj.data.Validation
+
+
Binds the given function across this validation's success value if it has one.
+
+
bind(F<E, Validation<A, T>>) - Method in class fj.data.Validation.FailProjection
+
+
Binds the given function across this validation's failing value if it has one.
+
+
bind(F<A, B>, F<B, F<A, C>>) - Static method in class fj.F1Functions
+
+
Binds a given function across this function (Reader Monad).
+
+
bind(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function binding.
+
+
bind(F<B, F<A, C>>) - Method in class fj.F1W
+
+
Binds a given function across this function (Reader Monad).
+
+
bind() - Method in class fj.F1W
+
+
First-class function binding.
+
+
bind(F<C, A>, F<A, F<C, B>>) - Static method in class fj.Function
+
+
Binds the function in the second argument to the function in the first argument.
+
+
bind(F<D, A>, F<D, B>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Binds the given function f to the values of the given functions, with a final join.
+
+
bind(F<A, P1<B>>) - Method in class fj.P1
+
+
Binds the given function to the value in a product-1 with a final join.
+
+
bind(P1<B>, F<A, F<B, C>>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(F<A, Parser<I, B, E>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parser with a final join.
+
+
bind(Parser<I, B, E>, F<A, F<B, C>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, F<A, F<B, F<C, D>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, F<A, F<B, F<C, F<D, E$>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, F<A, F<B, F<C, F<D, F<E$, F$>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, Parser<I, H, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, F<H, I$>>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind_() - Static method in class fj.control.Trampoline
+
 
+
bind_() - Static method in class fj.data.List
+
+
Provides a first-class version of bind()
+
+
bind_() - Static method in class fj.data.Stream
+
+
A first-class version of the bind function.
+
+
bindProduct(Option<B>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>) - Method in class fj.data.Option
+
 
+
BITS_IN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
BitSet - Class in fj.data.hamt
+
+
A sequence of bits representing a value.
+
+
BitSet_List - Static variable in class fj.data.Java
+
+
A function that converts bit sets to lists.
+
+
bitSetSequal - Static variable in class fj.Equal
+
+
An equal instance for the BitSet type.
+
+
bitSetShow - Static variable in class fj.Show
+
 
+
bitsOn() - Method in class fj.data.hamt.BitSet
+
 
+
bitsToRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
bitsUsed() - Method in class fj.data.hamt.BitSet
+
 
+
Boolean_Byte - Static variable in class fj.Primitive
+
+
A function that converts booleans to bytes.
+
+
Boolean_Character - Static variable in class fj.Primitive
+
+
A function that converts booleans to characters.
+
+
Boolean_Double - Static variable in class fj.Primitive
+
+
A function that converts booleans to doubles.
+
+
Boolean_Float - Static variable in class fj.Primitive
+
+
A function that converts booleans to floats.
+
+
Boolean_Integer - Static variable in class fj.Primitive
+
+
A function that converts booleans to integers.
+
+
Boolean_Long - Static variable in class fj.Primitive
+
+
A function that converts booleans to longs.
+
+
Boolean_Short - Static variable in class fj.Primitive
+
+
A function that converts booleans to shorts.
+
+
booleanEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for boolean.
+
+
booleanEqual - Static variable in class fj.Equal
+
+
An equal instance for the boolean type.
+
+
booleanHash - Static variable in class fj.Hash
+
+
A hash instance for the boolean type.
+
+
booleanOrd - Static variable in class fj.Ord
+
+
An order instance for the boolean type.
+
+
Booleans - Class in fj.function
+
+
Curried logical functions.
+
+
booleanShow - Static variable in class fj.Show
+
+
A show instance for the boolean type.
+
+
Bottom - Class in fj
+
+
Represents the bottom _|_ value.
+
+
bottomUp(Tree<A>, F<P2<A, Stream<B>>, B>) - Static method in class fj.data.Tree
+
+
Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
+
+
bracket(IO<A>, F<A, IO<B>>, F<A, IO<C>>) - Static method in class fj.data.IOFunctions
+
 
+
breakk(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
+
+
Buffer() - Constructor for class fj.data.List.Buffer
+
 
+
bufferedReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
Byte_Boolean - Static variable in class fj.Primitive
+
+
A function that converts bytes to booleans.
+
+
Byte_Character - Static variable in class fj.Primitive
+
+
A function that converts bytes to characters.
+
+
Byte_Double - Static variable in class fj.Primitive
+
+
A function that converts bytes to doubles.
+
+
Byte_Float - Static variable in class fj.Primitive
+
+
A function that converts bytes to floats.
+
+
Byte_Integer - Static variable in class fj.Primitive
+
+
A function that converts bytes to integers.
+
+
Byte_Long - Static variable in class fj.Primitive
+
+
A function that converts bytes to longs.
+
+
Byte_Short - Static variable in class fj.Primitive
+
+
A function that converts bytes to shorts.
+
+
byteEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for byte.
+
+
byteEqual - Static variable in class fj.Equal
+
+
An equal instance for the byte type.
+
+
byteHash - Static variable in class fj.Hash
+
+
A hash instance for the byte type.
+
+
byteOrd - Static variable in class fj.Ord
+
+
An order instance for the byte type.
+
+
byteShow - Static variable in class fj.Show
+
+
A show instance for the byte type.
+
+
+ + + +

C

+
+
callable(A) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that completely preserves the argument.
+
+
callable(Exception) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that throws the given exception.
+
+
callable() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a value to a Callable that completely preserves that value.
+
+
callable(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Wraps a given function's return value in a Callable.
+
+
Callables - Class in fj.control.parallel
+
+
Monadic functions and conversion methods for java.util.concurrent.Callable.
+
+
callableStrategy(Strategy<Callable<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a normalising strategy that fully evaluates its Callable argument.
+
+
character(F0<E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(E) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(F0<E>, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
character(E, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
Character_Boolean - Static variable in class fj.Primitive
+
+
A function that converts characters to booleans.
+
+
Character_Byte - Static variable in class fj.Primitive
+
+
A function that converts characters to bytes.
+
+
Character_Double - Static variable in class fj.Primitive
+
+
A function that converts characters to doubles.
+
+
Character_Float - Static variable in class fj.Primitive
+
+
A function that converts characters to floats.
+
+
Character_Integer - Static variable in class fj.Primitive
+
+
A function that converts characters to integers.
+
+
Character_Long - Static variable in class fj.Primitive
+
+
A function that converts characters to longs.
+
+
Character_Short - Static variable in class fj.Primitive
+
+
A function that converts characters to shorts.
+
+
Characters - Class in fj.function
+
+
First-class functions on Characters.
+
+
characters(F0<E>, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(E, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(F0<E>, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
characters(E, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
charAt(int) - Method in class fj.data.LazyString
+
+
Returns the caracter at the specified index.
+
+
charChunkReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with character chunks read from a Reader + (char[] of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charChunkReader2() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for char.
+
+
charEqual - Static variable in class fj.Equal
+
+
An equal instance for the char type.
+
+
charHash - Static variable in class fj.Hash
+
+
A hash instance for the char type.
+
+
charOrd - Static variable in class fj.Ord
+
+
An order instance for the char type.
+
+
charShow - Static variable in class fj.Show
+
+
A show instance for the char type.
+
+
claim() - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
claim(long, TimeUnit) - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
clas() - Method in class fj.Class
+
+
Returns the underlying class.
+
+
clas(Class<T>) - Static method in class fj.Class
+
+
Constructs a class from the given argument.
+
+
Class<T> - Class in fj
+
+
A wrapper for a Class that provides additional methods.
+
+
classParameters() - Method in class fj.Class
+
+
Provides this class's type parameter information as a Tree of the type expression.
+
+
classShow() - Static method in class fj.Show
+
+
A show instance for the Class type.
+
+
clear(int) - Method in class fj.data.hamt.BitSet
+
 
+
clear() - Method in class fj.data.HashMap
+
+
Clear all entries from this hash map.
+
+
clear() - Method in class fj.data.HashSet
+
+
Clear all elements from this hash set.
+
+
closeReader - Static variable in class fj.data.IOFunctions
+
 
+
closeReader(Reader) - Static method in class fj.data.IOFunctions
+
 
+
cobind(F<Promise<A>, B>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function across a promise of this promise (Comonad pattern).
+
+
cobind(F<Stream<A>, B>) - Method in class fj.data.Stream
+
+
Binds the given function across the stream of substreams of this stream.
+
+
cobind(F<Tree<A>, B>) - Method in class fj.data.Tree
+
+
Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
+
+
cobind(F<TreeZipper<A>, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function over the tree of all positions for this zipper (comonad pattern).
+
+
cobind(F<Zipper<A>, B>) - Method in class fj.data.Zipper
+
+
Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
+
+
cobind(F<P2<A, B>, C>) - Method in class fj.P2
+
+
Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
+
+
codiagonal() - Static method in class fj.data.optic.Fold
+
 
+
codiagonal() - Static method in class fj.data.optic.Getter
+
 
+
codiagonal() - Static method in class fj.data.optic.Setter
+
 
+
codiagonal() - Static method in class fj.data.optic.Traversal
+
 
+
cojoin() - Method in class fj.control.parallel.Promise
+
+
Duplicates this promise to a promise of itself (Comonad pattern).
+
+
cojoin() - Method in class fj.data.Tree
+
+
Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
+
+
Collection_List(Collection<A>) - Static method in class fj.data.Java
+
 
+
Collection_List() - Static method in class fj.data.Java
+
 
+
comp() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for function composition.
+
+
comparableOrd() - Static method in class fj.Ord
+
+
An order instance for the Comparable interface.
+
+
compare(A, A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare(A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare() - Method in class fj.Ord
+
+
First-class ordering.
+
+
compare(A, A) - Method in class fj.Ord
+
+
Returns an ordering for the given arguments.
+
+
compare(A) - Method in interface fj.Ord.Definition
+
 
+
compare(A, A) - Method in interface fj.Ord.Definition
+
 
+
completionStrategy(CompletionService<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
+
+
compose() - Static method in class fj.Function
+
+
Function composition.
+
+
compose(F<B, C>, F<A, B>) - Static method in class fj.Function
+
+
Function composition.
+
+
compose(Monoid<B>) - Method in class fj.Monoid
+
+
Composes this monoid with another.
+
+
compose(Monoid<B>, F<C, A>, F<C, B>, F2<A, B, C>) - Method in class fj.Monoid
+
 
+
compose(Semigroup<B>, F<C, B>, F<C, A>, F2<A, B, C>) - Method in class fj.Semigroup
+
 
+
compose2(F<C, D>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function composition.
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Fold
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Fold
+
+
composeFold(Getter<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Getter
+
+
composeGetter(Getter<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Getter
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with an Iso
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PLens
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a POptional
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PPrism
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Setter
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Traversal
+
+
ConcurrentLinkedQueue_List() - Static method in class fj.data.Java
+
+
A function that converts concurrent linked queues to lists.
+
+
concurry(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a concurrent function.
+
+
concurry(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function of arity-2 to a concurrent function.
+
+
cond() - Static method in class fj.function.Booleans
+
+
Curried form of conditional.
+
+
condition(boolean, E, T) - Static method in class fj.data.Validation
+
+
Returns a validation based on a boolean condition.
+
+
conjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ANDs booleans.
+
+
conjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ANDs booleans.
+
+
connect() - Method in class fj.control.db.Connector
+
 
+
Connector - Class in fj.control.db
+
+
A method of connecting to the database.
+
+
Connector() - Constructor for class fj.control.db.Connector
+
 
+
cons(A) - Method in class fj.data.DList
+
+
Prepends a single element on the DList to produce a new DList.
+
+
cons(A) - Method in class fj.data.fingertrees.Deep
+
 
+
cons(A) - Method in class fj.data.fingertrees.Empty
+
 
+
cons(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the first element.
+
+
cons(A) - Method in class fj.data.fingertrees.Single
+
 
+
cons() - Static method in class fj.data.hlist.HList.Apply
+
+
An operator for the construction of heterogeneous lists.
+
+
cons(E, L) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of an element and another list.
+
+
cons(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
cons() - Static method in class fj.data.List
+
+
Returns a function that prepends (cons) an element to a list to produce a new list.
+
+
cons(List<A>) - Static method in class fj.data.List
+
+
Returns a function that prepends a value to the given list.
+
+
cons(A, List<A>) - Static method in class fj.data.List
+
+
Prepends the given head element to the given tail element to produce a new list.
+
+
cons() - Static method in class fj.data.List.Optic
+
+
Cons prism
+
+
cons(A) - Method in class fj.data.NonEmptyList
+
+
Prepend the given value to this list.
+
+
cons(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the front of this sequence.
+
+
cons(A) - Method in class fj.data.Stream
+
+
Prepends (cons) the given element to this stream to product a new stream.
+
+
cons() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
cons(A, F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Prepends the given head element to the given tail element to produce a new stream.
+
+
cons(P1<A>, V2<A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a head and a tail.
+
+
cons(P1<A>, V3<A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a head and a tail.
+
+
cons(P1<A>, V4<A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a head and a tail.
+
+
cons(P1<A>, V5<A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a head and a tail.
+
+
cons(P1<A>, V6<A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a head and a tail.
+
+
cons(P1<A>, V7<A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a head and a tail.
+
+
cons_() - Static method in class fj.data.List
+
 
+
cons_(A) - Static method in class fj.data.List
+
+
Returns a function that prepends the given value to a list.
+
+
cons_() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
conss(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
constant(B) - Static method in class fj.data.$
+
 
+
constant(B) - Static method in class fj.data.Reader
+
 
+
constant(A) - Static method in class fj.data.State
+
 
+
constant() - Static method in class fj.Function
+
+
Returns a function that given an argument, returns a function that ignores its argument.
+
+
constant(B) - Static method in class fj.Function
+
+
Returns a function that ignores its argument to constantly produce the given value.
+
+
constant() - Method in class fj.P1
+
+
Returns a constant function that always uses this value.
+
+
cont(F<Iteratee.Input<E>, Iteratee.IterV<E, A>>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that takes an element from an input to yield a new computation
+
+
contains(K) - Method in class fj.data.HashMap
+
+
Determines if the given key value exists in this hash map.
+
+
contains(A) - Method in class fj.data.HashSet
+
+
Determines if this hash set contains the given element.
+
+
contains(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a substring of this lazy string.
+
+
contains(K) - Method in class fj.data.PriorityQueue
+
+
Does the priority k exist already?
+
+
contains(K) - Method in class fj.data.TreeMap
+
+
Determines if the given key value exists in this tree map.
+
+
contains - Static variable in class fj.function.Strings
+
+
A curried version of String.contains(CharSequence).
+
+
contramap(F<B, A>) - Method in class fj.control.parallel.Actor
+
+
Contravariant functor pattern.
+
+
contramap(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
+
+
contramap(Effect1<A>, F<B, A>) - Static method in class fj.Effect
+
+
A contra-variant functor on effect.
+
+
contramap(F<B, A>) - Method in class fj.Equal
+
+
Maps the given function across this equal as a contra-variant functor.
+
+
contramap(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Static version of Equal.contramap(F)
+
+
contramap(F<A, B>, F<C, A>) - Static method in class fj.F1Functions
+
 
+
contramap(F<C, A>) - Method in class fj.F1W
+
 
+
contramap(F2<A, B, C>, F<X, A>, F<Y, B>) - Static method in class fj.F2Functions
+
 
+
contramap(F<X, A>, F<Y, B>) - Method in class fj.F2W
+
 
+
contramap(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
maps given function to the predicate function
+
+
contramap(F<B, A>) - Method in class fj.Hash
+
+
Maps the given function across this hash as a contra-variant functor.
+
+
contramap(F<B, A>) - Method in class fj.Ord
+
+
Maps the given function across this ord as a contra-variant functor.
+
+
contramap(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Static version of Ord.contramap(F)
+
+
contramap(F<B, A>) - Method in class fj.Show
+
+
Maps the given function across this show as a contra-variant functor.
+
+
contramapActor(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that contramaps over a given actor.
+
+
contramapActor() - Method in class fj.F1W
+
+
Returns a function that contramaps over a given actor.
+
+
contramapEqual(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over an Equal as a contravariant functor.
+
+
contramapEqual() - Method in class fj.F1W
+
+
Promotes this function to map over an Equal as a contravariant functor.
+
+
contramapFirst(F2<A, B, C>, F<Z, A>) - Static method in class fj.F2Functions
+
 
+
contramapFirst(F<Z, A>) - Method in class fj.F2W
+
 
+
contramapHash(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Hash as a contravariant functor.
+
+
contramapHash() - Method in class fj.F1W
+
+
Promotes this function to map over a Hash as a contravariant functor.
+
+
contramapSecond(F2<A, B, C>, F<Z, B>) - Static method in class fj.F2Functions
+
 
+
contramapSecond(F<Z, B>) - Method in class fj.F2W
+
 
+
contramapShow(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Show as a contravariant functor.
+
+
contramapShow() - Method in class fj.F1W
+
+
Promotes this function to map over a Show as a contravariant functor.
+
+
Conversions - Class in fj.data
+
+
Functions that convert between data structure types.
+
+
copyOf(U[], int, Class<? extends T[]>) - Static method in class fj.data.Array
+
 
+
copyOf(T[], int) - Static method in class fj.data.Array
+
 
+
copyOfRange(char[], int, int) - Static method in class fj.data.Array
+
 
+
CopyOnWriteArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array lists to lists.
+
+
CopyOnWriteArraySet_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array sets to lists.
+
+
curry(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
+
+
curry() - Method in class fj.F2W
+
+
Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
+
+
curry(F2<A, B, C>) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F2<A, B, C>, A) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F3<A, B, C, D>) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F4<A, B, C, D, E>) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F5<A, B, C, D, E, F$>) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F6<A, B, C, D, E, F$, G>) - Static method in class fj.Function
+
+
Curry a function of arity-6.
+
+
curry(F7<A, B, C, D, E, F$, G, H>) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$, G) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F<A, B>) - Static method in class fj.P1
+
+
Promotes the given function so that it returns its value in a P1.
+
+
cycle(Stream<A>) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given elements cycling.
+
+
cycleNext() - Method in class fj.data.Zipper
+
+
Move the focus to the next element.
+
+
cyclePrevious() - Method in class fj.data.Zipper
+
+
Move the focus to the previous element.
+
+
+ + + +

D

+
+
DB<A> - Class in fj.control.db
+
+
The DB monad represents a database action, or a value within the context of a database connection.
+
+
DB() - Constructor for class fj.control.db.DB
+
 
+
db(F<Connection, A>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
db(Try1<Connection, A, SQLException>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
DbState - Class in fj.control.db
+
+
Performs database I/O, in order to read or write the database state.
+
+
decons(A, Show<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
decons(Class<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
Deep<V,A> - Class in fj.data.fingertrees
+
+
A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
+
+
deep(Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree.
+
+
deep(V, Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree with the given annotation value.
+
+
defer(F0<Eval<A>>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation of an expression that produces Eval.
+
+
defined(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
defined(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
DelayQueue_List() - Static method in class fj.data.Java
+
+
A function that converts delay queues to lists.
+
+
delete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key.
+
+
delete(A) - Method in class fj.data.HashSet
+
+
Deletes the given element from this hash set.
+
+
delete(A, Equal<A>) - Method in class fj.data.List
+
+
Removes the first element that equals the given object.
+
+
delete(int) - Method in class fj.data.Seq
+
+
Delete the element at the given index.
+
+
delete(A) - Method in class fj.data.Set
+
+
Deletes the given element from this set.
+
+
delete() - Method in class fj.data.Set
+
+
First-class deletion function.
+
+
delete(K) - Method in class fj.data.TreeMap
+
+
Deletes the entry in the tree map that corresponds to the given key.
+
+
delete() - Method in class fj.data.TreeZipper
+
+
Removes the current node from the tree.
+
+
deleteLeft() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the left into focus.
+
+
deleteLeftCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the left into focus.
+
+
deleteOthers() - Method in class fj.data.Zipper
+
+
Deletes all elements in the zipper except the focus.
+
+
deleteRight() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the right into focus.
+
+
deleteRightCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the right into focus.
+
+
dequeue() - Method in class fj.data.PriorityQueue
+
+
Removes the node with the highest priority.
+
+
dequeue(int) - Method in class fj.data.PriorityQueue
+
+
Removes the top n elements with the highest priority.
+
+
Digit<V,A> - Class in fj.data.fingertrees
+
+
A digit is a vector of 1-4 elements.
+
+
Digit - Enum in fj
+
+
The digits zero to nine.
+
+
digit - Static variable in class fj.function.Characters
+
 
+
digit(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digit(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digitMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for digits.
+
+
digitShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
dimap(F<A, B>, F<C, A>, F<B, D>) - Static method in class fj.F1Functions
+
+
Both map (with g) and contramap (with f) the target function.
+
+
discard() - Static method in class fj.control.parallel.Strategy
+
+
Returns an Effect that waits for a given Future to obtain a value, discarding the value.
+
+
disjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ORs booleans.
+
+
disjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ORs booleans.
+
+
divide - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first.
+
+
divide(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another.
+
+
divmod - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first, yielding both the quotient and the remainder.
+
+
divmod(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another yielding both the quotient and the remainder.
+
+
DList<A> - Class in fj.data
+
+
Difference List.
+
+
dlist(F<List<A>, Trampoline<List<A>>>) - Static method in class fj.data.DList
+
+
Creates a DList from the function + + For alternatives functions to create a DList:
+
+
done(A, Iteratee.Input<E>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that has finished
+
+
Double_Boolean - Static variable in class fj.Primitive
+
+
A function that converts doubles to booleans.
+
+
Double_Byte - Static variable in class fj.Primitive
+
+
A function that converts doubles to bytes.
+
+
Double_Character - Static variable in class fj.Primitive
+
+
A function that converts doubles to characters.
+
+
Double_Float - Static variable in class fj.Primitive
+
+
A function that converts doubles to floats.
+
+
Double_Integer - Static variable in class fj.Primitive
+
+
A function that converts doubles to integers.
+
+
Double_Long - Static variable in class fj.Primitive
+
+
A function that converts doubles to longs.
+
+
Double_Short - Static variable in class fj.Primitive
+
+
A function that converts doubles to shorts.
+
+
doubleAdditionMonoid - Static variable in class fj.Monoid
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleAdditionSemigroup - Static variable in class fj.Semigroup
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for double.
+
+
doubleEqual - Static variable in class fj.Equal
+
+
An equal instance for the double type.
+
+
doubleHash - Static variable in class fj.Hash
+
+
A hash instance for the double type.
+
+
doubleMultiplicationMonoid - Static variable in class fj.Monoid
+
+
Deprecated. +
Since 4.7. Due to rounding errors, multiplication of doubles does not comply with monoid laws
+
+
+
doubleMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
Deprecated. +
Since 4.7. Due to rounding errors, addition of doubles does not comply with monoid laws
+
+
+
doubleOrd - Static variable in class fj.Ord
+
+
An order instance for the double type.
+
+
Doubles - Class in fj.function
+
+
Curried functions over Doubles.
+
+
doubleShow - Static variable in class fj.Show
+
+
A show instance for the double type.
+
+
doubleValue() - Method in class fj.data.Natural
+
+
Return the double value of this natural number.
+
+
draw(Show<A>) - Method in class fj.data.Tree
+
+
Draws a 2-dimensional representation of a tree.
+
+
driverManager(String) - Static method in class fj.control.db.DbState
+
+
A simple connector (the default) that gets connections to the given database URL from the driver manager.
+
+
drop(int) - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that skips the first n elements of the input
+
+
drop(int) - Method in class fj.data.List
+
+
Drops the given number of elements from the head of this list if they are available.
+
+
drop(int) - Method in class fj.data.Seq
+
+
Drops the given number of elements from the head of this sequence if they are available.
+
+
drop(int) - Method in class fj.data.Stream
+
+
Drops the given number of elements from the head of this stream if they are available.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
+
+
dual() - Method in interface fj.Monoid.Definition
+
 
+
dual() - Method in class fj.Monoid
+
+
Swaps the arguments when summing.
+
+
dual() - Method in interface fj.Ord.Definition
+
 
+
dual() - Method in interface fj.Semigroup.Definition
+
 
+
dual() - Method in class fj.Semigroup
+
+
Swaps the arguments when summing.
+
+
duplicate() - Method in class fj.P2
+
+
Duplicates this product into the first element (Comonad pattern).
+
+
+ + + +

E

+
+
effect(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
+
+
effect() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
+
+
Effect - Class in fj
+
+
Represents a side-effect.
+
+
Effect0 - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect0_P1() - Static method in class fj.data.Conversions
+
 
+
Effect0_P1(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect1<A> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect1_F(Effect1<A>) - Static method in class fj.data.Conversions
+
 
+
Effect1_F() - Static method in class fj.data.Conversions
+
 
+
Effect2<A,B> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect3<A,B,C> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect4<A,B,C,D> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect5<A,B,C,D,E> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect6<A,B,C,D,E,F> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect7<A,B,C,D,E,F,G> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect8<A,B,C,D,E,F,G,H> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
Effect_IO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_IO() - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO() - Static method in class fj.data.Conversions
+
 
+
either(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into either an exception or the value in the Callable.
+
+
either() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an Either.
+
+
Either<A,B> - Class in fj.data
+
+
The Either type represents a value of one of two possible types (a disjoint union).
+
+
either(F<A, X>, F<B, X>) - Method in class fj.data.Either
+
+
The catamorphism for either.
+
+
either() - Method in class fj.data.Either.LeftProjection
+
+
The either value underlying this projection.
+
+
either() - Method in class fj.data.Either.RightProjection
+
+
The either value underlying this projection.
+
+
either() - Static method in class fj.data.Validation
+
+
Returns a function that constructs an either with a validation.
+
+
Either.LeftProjection<A,B> - Class in fj.data
+
+
A left projection of an either value.
+
+
Either.RightProjection<A,B> - Class in fj.data
+
+
A right projection of an either value.
+
+
either_(F<A, X>, F<B, X>) - Static method in class fj.data.Either
+
+
First class catamorphism for either.
+
+
Either_ArrayA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayBlockingQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayBlockingQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_ArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_BitSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_BitSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_ConcurrentLinkedQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_ConcurrentLinkedQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_CopyOnWriteArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArraySetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_CopyOnWriteArraySetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_DelayQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_DelayQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_EnumSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_EnumSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_HashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_HashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_LinkedBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedHashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedHashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_LinkedListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_ListA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_ListB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_OptionA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_OptionB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_PriorityBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_PriorityBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_StackA() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StackB() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StreamA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StreamB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StringA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringBufferA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBufferB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBuilderA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_StringBuilderB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_SynchronousQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_SynchronousQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_TreeSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_TreeSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_VectorA() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
Either_VectorB() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
eitherEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Either type.
+
+
eitherHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Either type.
+
+
eitherLeftK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the left side of an Either.
+
+
eitherLeftK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the left side of an Either.
+
+
eitherOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Either type.
+
+
eitherRightK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the right side of an Either.
+
+
eitherRightK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the right side of an Either.
+
+
eitherShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Either type.
+
+
el(E) - Static method in class fj.data.Iteratee.Input
+
+
Input that has a value available
+
+
element(F0<E>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
element(E) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
elementIndex(Equal<A>, A) - Method in class fj.data.List
+
+
Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
+
+
eMessage() - Static method in class fj.Bottom
+
+
A function that returns the getMessage for a throwable.
+
+
empty() - Static method in class fj.data.Array
+
+
Returns an empty array.
+
+
Empty<V,A> - Class in fj.data.fingertrees
+
+
The empty tree.
+
+
empty(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Creates an empty finger tree with elements of type A and node annotations + of type V.
+
+
empty() - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs an empty tree.
+
+
EMPTY - Static variable in class fj.data.hamt.BitSet
+
 
+
empty() - Static method in class fj.data.hamt.BitSet
+
 
+
empty(Equal<K>, Hash<K>) - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Creates an empty trie.
+
+
empty(Equal<A>, Hash<A>) - Static method in class fj.data.HashSet
+
+
Creates a new HashSet using the given Equal and Hash
+
+
empty() - Static method in class fj.data.HashSet
+
+
Creates an empty HashSet
+
+
empty() - Static method in class fj.data.Iteratee.Input
+
+
Input that has no values available
+
+
empty - Static variable in class fj.data.LazyString
+
+
The empty string.
+
+
empty() - Static method in class fj.data.List.Buffer
+
+
An empty buffer.
+
+
empty(Monoid<K>, Equal<K>) - Static method in class fj.data.PriorityQueue
+
+
Creates an empty priority queue.
+
+
empty() - Static method in class fj.data.Seq
+
+
The empty sequence.
+
+
empty(Ord<A>) - Static method in class fj.data.Set
+
+
The empty set.
+
+
empty(Ord<K>) - Static method in class fj.data.TreeMap
+
+
Constructs an empty tree map.
+
+
empty() - Method in interface fj.Monoid.Definition
+
 
+
emptyInt() - Static method in class fj.data.PriorityQueue
+
+
An empty priority queue with integer priorities.
+
+
emptyIntAddition() - Static method in class fj.data.fingertrees.FingerTree
+
 
+
emptyIntMax() - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a finger tree which combines the integer node annotations with the + maximum function.
+
+
emptyKeyInteger() - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Create and empty trie keyed by integer.
+
+
endsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a suffix of this lazy string.
+
+
enqueue(K, A) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enqueue(List<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the list of products with priority k and value a.
+
+
enqueue(Iterable<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the iterable of products with priority k and value a.
+
+
enqueue(P2<K, A>) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enumerationStream(Enumeration<A>) - Static method in class fj.data.Stream
+
 
+
Enumerator<A> - Class in fj.data
+
+
Abstracts over a type that may have a successor and/or predecessor value.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>, F<A, F<Long, Option<A>>>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumFileCharChunks(File, Option<Charset>, Iteratee.IterV<char[], A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes them to the given iteratee.
+
+
enumFileChars(File, Option<Charset>, Iteratee.IterV<Character, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
+
+
enumFileLines(File, Option<Charset>, Iteratee.IterV<String, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads lines from the given file (using a BufferedReader) and passes + lines to the provided iteratee.
+
+
EnumSet_List() - Static method in class fj.data.Java
+
+
A function that converts enum sets to lists.
+
+
eof() - Static method in class fj.data.Iteratee.Input
+
+
Input that is exhausted
+
+
eq(K, K) - Method in class fj.data.HashMap
+
+
Compare two key values for equality using the underlying equality strategy.
+
+
eq(A, A) - Method in class fj.data.HashSet
+
+
Compare two values for equality using the underlying equality strategy.
+
+
eq(HPre.HZero, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is equal to itself.
+
+
eq(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HSucc<NN>, E) - Static method in class fj.data.hlist.HPre.HEq
+
+
A number is equal to another if their predecessors are equal.
+
+
eq(Equal<A>) - Static method in class fj.data.TreeZipper
+
+
An Equal instance for tree zippers.
+
+
eq(Equal<A>) - Static method in class fj.data.Zipper
+
+
An Equal instance for Zippers.
+
+
eq - Static variable in class fj.Equal
+
+
An equal instance for lazy strings.
+
+
eq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are equal, false otherwise.
+
+
eq() - Method in class fj.Equal
+
+
First-class equality check.
+
+
eq(A) - Method in class fj.Equal
+
+
Partially applied equality check.
+
+
eq(A, A) - Method in class fj.Ord
+
+
Returns true if the given arguments are equal, false otherwise.
+
+
Equal<A> - Class in fj
+
+
Tests for equality between two objects.
+
+
equal(A, A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.Definition
+
 
+
equal(A, A) - Method in interface fj.Equal.Definition
+
 
+
equal() - Method in interface fj.Equal.Definition
+
+
Build an equal instance from this definition.
+
+
equal(F<A, F<A, Boolean>>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(F2<A, A, Boolean>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(A, A) - Method in interface fj.Ord.Definition
+
 
+
equal(A) - Method in interface fj.Ord.Definition
+
 
+
equal() - Method in class fj.Ord
+
+
Returns an Equal for this order.
+
+
Equal.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Equal: alternative minimal definition and overridable methods.
+
+
Equal.Definition<A> - Interface in fj
+
+
Primitives functions of Equal: minimal definition and overridable methods.
+
+
equalDef(Equal.Definition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given definition.
+
+
equalDef(Equal.AltDefinition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given (alternative) definition.
+
+
equals(Object) - Method in class fj.data.Array
+
 
+
equals(Object) - Method in class fj.data.Either
+
 
+
equals(Object) - Method in class fj.data.hamt.BitSet
+
 
+
equals(Object) - Method in class fj.data.List
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Natural
+
 
+
equals(Object) - Method in class fj.data.NonEmptyList
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Option
+
 
+
equals(Object) - Method in class fj.data.Seq
+
 
+
equals(Object) - Method in class fj.data.Set
+
 
+
equals(Object) - Method in class fj.data.Stream
+
 
+
equals(Object) - Method in class fj.data.Tree
+
 
+
equals(Object) - Method in class fj.data.TreeMap
+
 
+
equals(Object) - Method in class fj.data.TreeZipper
+
 
+
equals(Object) - Method in class fj.data.Validation
+
 
+
equals(Object) - Method in class fj.data.vector.V2
+
 
+
equals(Object) - Method in class fj.data.vector.V3
+
 
+
equals(Object) - Method in class fj.data.vector.V4
+
 
+
equals(Object) - Method in class fj.data.vector.V5
+
 
+
equals(Object) - Method in class fj.data.vector.V6
+
 
+
equals(Object) - Method in class fj.data.vector.V7
+
 
+
equals(Object) - Method in class fj.data.vector.V8
+
 
+
equals(Object) - Method in class fj.data.Zipper
+
 
+
equals(Object) - Method in class fj.P1
+
 
+
equals(Object) - Method in class fj.P2
+
 
+
equals(Object) - Method in class fj.P3
+
 
+
equals(Object) - Method in class fj.P4
+
 
+
equals(Object) - Method in class fj.P5
+
 
+
equals(Object) - Method in class fj.P6
+
 
+
equals(Object) - Method in class fj.P7
+
 
+
equals(Object) - Method in class fj.P8
+
 
+
equals(Object) - Method in class fj.parser.Result
+
 
+
equals0(Class<? super A>, A, Object, Equal<A>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
equals0(Class<? super A>, A, Object, F0<Equal<A>>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
error(String) - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation with early failure using the given + message.
+
+
error_(String) - Static method in class fj.Bottom
+
+
Provides a thunk that throws an error using the given message when evaluated.
+
+
errorF(String) - Static method in class fj.Bottom
+
+
Provides a function that throws an error using the given message, ignoring its argument.
+
+
errorStrategy(Effect1<Error>) - Method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
errorStrategy(Strategy<A>, Effect1<Error>) - Static method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
eToString() - Static method in class fj.Bottom
+
+
A function that returns the toString for a throwable.
+
+
Eval<A> - Class in fj.data
+
+
Eval is an abstraction over different models of evaluation.
+
+
Eval() - Constructor for class fj.data.Eval
+
 
+
eval() - Method in class fj.data.LazyString
+
 
+
eval(S) - Method in class fj.data.State
+
 
+
even - Static variable in class fj.function.Doubles
+
+
Evenness.
+
+
even - Static variable in class fj.function.Integers
+
+
Evenness.
+
+
exclusiveDisjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that XORs booleans.
+
+
exclusiveDisjunctionSemiGroup - Static variable in class fj.Semigroup
+
+
A semigroup that XORs booleans.
+
+
exec(S) - Method in class fj.data.State
+
 
+
executorStrategy(ExecutorService) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if at least one target satisfies the predicate
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if at least one target satisfies the predicate
+
+
exists(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
+
+
exists(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
+
+
exists(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns false if this is a failure or returns the result of the application of the given + function to the success value.
+
+
exists(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns false if this is a success or returns the result of the application of the given + function to the failing value.
+
+
extend(E) - Method in class fj.data.hlist.HList
+
+
Extends (cons) this list by prepending the given element, returning a new list.
+
+
extend(X) - Method in class fj.data.hlist.HList.HCons
+
 
+
extend(E) - Method in class fj.data.hlist.HList.HNil
+
 
+
extender() - Method in class fj.data.hlist.HList
+
 
+
extender() - Method in class fj.data.hlist.HList.HCons
+
 
+
extender() - Method in class fj.data.hlist.HList.HNil
+
 
+
+ + + +

F

+
+
f() - Method in class fj.control.parallel.Strategy
+
+
Returns the functional representation of this Strategy, a function that evaluates a product-1.
+
+
f() - Static method in class fj.data.hlist.HList.Apply
+
+
Function application operator.
+
+
f(A) - Method in class fj.data.Reader
+
 
+
f() - Method in class fj.data.Validation
+
+
Returns a failing projection of this validation.
+
+
f(Effect0) - Static method in class fj.Effect
+
 
+
f(Effect1<A>) - Static method in class fj.Effect
+
+
Returns a function for the given effect.
+
+
f(Effect2<A, B>) - Static method in class fj.Effect
+
 
+
f(Effect3<A, B, C>) - Static method in class fj.Effect
+
 
+
f(Effect4<A, B, C, D>) - Static method in class fj.Effect
+
 
+
f(Effect5<A, B, C, D, E>) - Static method in class fj.Effect
+
 
+
f(Effect6<A, B, C, D, E, $F>) - Static method in class fj.Effect
+
 
+
f(Effect7<A, B, C, D, E, $F, G>) - Static method in class fj.Effect
+
 
+
f(Effect8<A, B, C, D, E, $F, G, H>) - Static method in class fj.Effect
+
 
+
F<A,B> - Interface in fj
+
+
A transformation or function from A to B.
+
+
f(A) - Method in interface fj.F
+
+
Transform A to B.
+
+
f() - Method in interface fj.F0
+
 
+
f(F<A, B>, A) - Static method in class fj.F1Functions
+
+
Partial application.
+
+
f(A) - Method in class fj.F1W.F1WFunc
+
 
+
f(A, B) - Method in interface fj.F2
+
+
Transform A and B to C.
+
+
f(F2<A, B, C>, A) - Static method in class fj.F2Functions
+
+
Partial application.
+
+
f(A) - Method in class fj.F2W
+
+
Partial application.
+
+
f(A, B) - Method in class fj.F2W.F2WFunc
+
 
+
f(A, B, C) - Method in interface fj.F3
+
+
Transform A, B and C to D.
+
+
f(F3<A, B, C, D>, A) - Static method in class fj.F3Functions
+
+
Partial application.
+
+
f(A, B, C, D) - Method in interface fj.F4
+
+
Transform A, B, C and D to E.
+
+
f(F4<A, B, C, D, E>, A) - Static method in class fj.F4Functions
+
+
Partial application.
+
+
f(A, B, C, D, E) - Method in interface fj.F5
+
+
Transform A, B, C, D and E to + F$.
+
+
f(F5<A, B, C, D, E, F$>, A) - Static method in class fj.F5Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$) - Method in interface fj.F6
+
+
Transform A, B, C, D, E and + F$ to G.
+
+
f(F6<A, B, C, D, E, F$, G>, A) - Static method in class fj.F6Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$, G) - Method in interface fj.F7
+
+
Transform A, B, C, D, E, + F$ and G to H.
+
+
f(F7<A, B, C, D, E, F$, G, H>, A) - Static method in class fj.F7Functions
+
+
Partial application.
+
+
f(A, B, C, D, E, F$, G, H) - Method in interface fj.F8
+
+
Transform A, B, C, D, E, + F$, G and H to I.
+
+
f(F8<A, B, C, D, E, F$, G, H, I>, A) - Static method in class fj.F8Functions
+
+
Partial application.
+
+
f() - Method in interface fj.function.Effect0
+
 
+
f(A) - Method in interface fj.function.Effect1
+
 
+
f(A, B) - Method in interface fj.function.Effect2
+
 
+
f(A, B, C) - Method in interface fj.function.Effect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Effect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Effect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Effect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Effect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Effect8
+
 
+
f() - Method in interface fj.function.Try0
+
 
+
f(A) - Method in interface fj.function.Try1
+
 
+
f(A, B) - Method in interface fj.function.Try2
+
 
+
f(A, B, C) - Method in interface fj.function.Try3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Try4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Try5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Try6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Try7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Try8
+
 
+
f() - Method in interface fj.function.TryEffect0
+
 
+
f(A) - Method in interface fj.function.TryEffect1
+
 
+
f(A, B) - Method in interface fj.function.TryEffect2
+
 
+
f(A, B, C) - Method in interface fj.function.TryEffect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.TryEffect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.TryEffect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.TryEffect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.TryEffect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.TryEffect8
+
 
+
f() - Method in class fj.P1
+
 
+
f(Try0<A, E>) - Static method in class fj.Try
+
+
Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try1<A, B, E>) - Static method in class fj.Try
+
+
Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try2<A, B, C, E>) - Static method in class fj.Try
+
+
Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try3<A, B, C, D, E>) - Static method in class fj.Try
+
+
Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try4<A, B, C, D, E, Z>) - Static method in class fj.Try
+
+
Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try5<A, B, C, D, E, F, Z>) - Static method in class fj.Try
+
+
Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try6<A, B, C, D, E, F, G, Z>) - Static method in class fj.Try
+
+
Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try7<A, B, C, D, E, F, G, H, Z>) - Static method in class fj.Try
+
+
Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try8<A, B, C, D, E, F, G, H, I, Z>) - Static method in class fj.Try
+
+
Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(TryEffect0<Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect1<A, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect2<A, B, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect3<A, B, C, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect4<A, B, C, D, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect5<A, B, C, D, E, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect6<A, B, C, D, E, $F, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect7<A, B, C, D, E, $F, G, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect8<A, B, C, D, E, $F, G, H, Z>) - Static method in class fj.TryEffect
+
 
+
F0<A> - Interface in fj
+
+
Created by MarkPerry on 21/01/2015.
+
+
F1Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F1W<A,B> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F1W() - Constructor for class fj.F1W
+
 
+
F1W.F1WFunc<A,B> - Class in fj
+
 
+
F1WFunc(F<A, B>) - Constructor for class fj.F1W.F1WFunc
+
 
+
F2<A,B,C> - Interface in fj
+
+
A transformation function of arity-2 from A and B to C.
+
+
F2Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F2W<A,B,C> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F2W() - Constructor for class fj.F2W
+
 
+
F2W.F2WFunc<A,B,C> - Class in fj
+
 
+
F2WFunc(F2<A, B, C>) - Constructor for class fj.F2W.F2WFunc
+
 
+
F3<A,B,C,D> - Interface in fj
+
+
A transformation function of arity-3 from A, B and C to + D.
+
+
F3Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F3W<A,B,C,D> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F3W() - Constructor for class fj.F3W
+
 
+
F4<A,B,C,D,E> - Interface in fj
+
+
A transformation function of arity-4 from A, B, C and + D to E.
+
+
F4Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F4W<A,B,C,D,E> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F4W() - Constructor for class fj.F4W
+
 
+
F5<A,B,C,D,E,F$> - Interface in fj
+
+
A transformation function of arity-5 from A, B, C, + D and E to F$.
+
+
F5Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F5W<A,B,C,D,E,$F> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F5W() - Constructor for class fj.F5W
+
 
+
F6<A,B,C,D,E,F$,G> - Interface in fj
+
+
A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
+
+
F6Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F6W<A,B,C,D,E,$F,G> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F6W() - Constructor for class fj.F6W
+
 
+
F7<A,B,C,D,E,F$,G,H> - Interface in fj
+
+
A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
+
+
F7Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F7W<A,B,C,D,E,$F,G,H> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F7W() - Constructor for class fj.F7W
+
 
+
F8<A,B,C,D,E,F$,G,H,I> - Interface in fj
+
+
A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
+
+
F8Functions - Class in fj
+
+
Created by MarkPerry on 6/04/2014.
+
+
F8W<A,B,C,D,E,$F,G,H,I> - Class in fj
+
+
Created by MarkPerry on 22/01/2015.
+
+
F8W() - Constructor for class fj.F8W
+
 
+
F_SafeIO(F<Unit, A>) - Static method in class fj.data.Conversions
+
 
+
F_SafeIO() - Static method in class fj.data.Conversions
+
 
+
fail() - Method in class fj.data.Validation
+
+
Returns the failing value, or throws an error if there is no failing value.
+
+
fail(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing the given value.
+
+
fail(E) - Static method in class fj.parser.Parser
+
+
Returns a parser that always fails with the given error.
+
+
failE(F0<String>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failE(String) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the failure side of a Validation.
+
+
failK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the failure side of a Validation.
+
+
failNEL(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing a non-empty list that contains the given value.
+
+
fails(List<Validation<E, ?>>) - Static method in class fj.data.Validation
+
 
+
FALSE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
fanout(F<B, C>, F<B, D>, B) - Static method in class fj.P2
+
+
Sends the given input value to both argument functions and combines their output.
+
+
fileReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Array
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Array.ImmutableProjection
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
+
+
filter(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
+
+
filter(F<A, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Option
+
+
Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Seq
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Set
+
+
Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
+
+
filter() - Static method in class fj.data.Stream
+
+
Returns a first-class version of the filter function.
+
+
filter(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
+
+
filter(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
+
+
filter(F<A, Boolean>, E) - Method in class fj.parser.Parser
+
+
Returns a parser that fails with the given error if the result value does not meet the given predicate.
+
+
filterKeys(F<K, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters the nodes based on the annotation of each node.
+
+
filterValues(F<A, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters nodes based on the value inside each node.
+
+
find(F<A, Boolean>) - Method in class fj.data.Array
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(K) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k.
+
+
find(K, int, int) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
+
+
find(F<A, Boolean>) - Method in class fj.data.List
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
find the first target of a Fold matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
find the first target of a PTraversal matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.Zipper
+
+
Moves the focus to the element matching the given predicate, if present.
+
+
findChild(F<Tree<A>, Boolean>) - Method in class fj.data.TreeZipper
+
+
Navigates to the first child of the current location, that satisfies the given predicate.
+
+
findChild() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the findChild function.
+
+
findFirst(List<Option<X>>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first value available in the given list of optional values.
+
+
FingerTree<V,A> - Class in fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fingerTreeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
first() - Method in class fj.data.optic.Getter
+
 
+
first() - Method in class fj.data.optic.Iso
+
 
+
first() - Method in class fj.data.optic.Optional
+
 
+
first() - Method in class fj.data.optic.PIso
+
 
+
first() - Method in class fj.data.optic.POptional
+
 
+
firstChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the first child of the current location.
+
+
firstOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the first available value.
+
+
firstOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the first available value.
+
+
firstSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "first" (left-hand side) value.
+
+
fj - package fj
+
+
Types that set the premise for the existence of Functional Java.
+
+
fj.control - package fj.control
+
+
Functional control abstractions.
+
+
fj.control.db - package fj.control.db
+
+
Abstractions for JDBC connections.
+
+
fj.control.parallel - package fj.control.parallel
+
+
Parallelization strategies.
+
+
fj.data - package fj.data
+
+
Common algebraic data types.
+
+
fj.data.fingertrees - package fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fj.data.hamt - package fj.data.hamt
+
 
+
fj.data.hlist - package fj.data.hlist
+
+
Type-safe, extensible, heterogeneous lists
+
+
fj.data.optic - package fj.data.optic
+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+
fj.data.vector - package fj.data.vector
+
+
Fixed-length vectors
+
+
fj.function - package fj.function
+
+
A prelude of commonly used first-class functions
+
+
fj.parser - package fj.parser
+
+
Parser combinators.
+
+
flatMap(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Alias for Eval.bind(F).
+
+
flatMap(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
flatMap(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
flatMap(State<S, A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
 
+
flatMap(F<A, State<S, B>>) - Method in class fj.data.State
+
 
+
flatMap(F<A, Writer<W, B>>) - Method in class fj.data.Writer
+
 
+
flatten() - Method in class fj.data.Tree
+
+
Puts the elements of the tree into a Stream, in pre-order.
+
+
flatten_() - Static method in class fj.data.Tree
+
+
+ flatten :: Tree a -> [a] + flatten t = squish t [] +
+
+
flip(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Flips the arguments of this function.
+
+
flip() - Method in class fj.F2W
+
+
Flips the arguments of this function.
+
+
flip() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F2<A, B, C>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip2() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
Float_Boolean - Static variable in class fj.Primitive
+
+
A function that converts floats to booleans.
+
+
Float_Byte - Static variable in class fj.Primitive
+
+
A function that converts floats to bytes.
+
+
Float_Character - Static variable in class fj.Primitive
+
+
A function that converts floats to characters.
+
+
Float_Double - Static variable in class fj.Primitive
+
+
A function that converts floats to doubles.
+
+
Float_Integer - Static variable in class fj.Primitive
+
+
A function that converts floats to integers.
+
+
Float_Long - Static variable in class fj.Primitive
+
+
A function that converts floats to longs.
+
+
Float_Short - Static variable in class fj.Primitive
+
+
A function that converts floats to shorts.
+
+
floatEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for float.
+
+
floatEqual - Static variable in class fj.Equal
+
+
An equal instance for the float type.
+
+
floatHash - Static variable in class fj.Hash
+
+
A hash instance for the float type.
+
+
floatOrd - Static variable in class fj.Ord
+
+
An order instance for the float type.
+
+
floatShow - Static variable in class fj.Show
+
+
A show instance for the float type.
+
+
floatValue() - Method in class fj.data.Natural
+
+
Return the float value of this natural number.
+
+
fmap(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Lifts any function to a function on Callables.
+
+
fmap(F<A, B>) - Method in class fj.control.parallel.Promise
+
+
Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
+
+
fmap(F<A, B>) - Method in class fj.data.Tree
+
+
Maps the given function over this tree.
+
+
fmap(F<A, B>) - Static method in class fj.P1
+
+
Deprecated. +
As of release 4.5, use P1.map_(fj.F<A, B>)
+
+
+
fmap_(F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Promotes any function to a transformation between promises (covariant functor pattern).
+
+
fmap_() - Static method in class fj.data.Tree
+
+
Provides a transformation to lift any function so that it maps over Trees.
+
+
focus() - Method in class fj.data.TreeZipper
+
+
Returns the tree at the currently focused node.
+
+
focus() - Method in class fj.data.Zipper
+
+
Returns the focus element of this zipper.
+
+
fold(F<Trampoline.Normal<A>, R>, F<Trampoline.Codense<A>, R>) - Method in class fj.control.Trampoline
+
 
+
fold(F<P2<A, Iteratee.Input<E>>, Z>, F<F<Iteratee.Input<E>, Iteratee.IterV<E, A>>, Z>) - Method in class fj.data.Iteratee.IterV
+
 
+
Fold<S,A> - Class in fj.data.optic
+
+
A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
+
+
Fold() - Constructor for class fj.data.optic.Fold
+
 
+
fold(Monoid<A>) - Method in class fj.data.optic.Fold
+
+
combine all targets using a target's Monoid
+
+
fold(Monoid<A>) - Method in class fj.data.optic.PTraversal
+
+
combine all targets using a target's Monoid
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the left using the given function and the given initial value.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function and the given initial element.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldLeft(F2<A, Boolean, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldLeft(F2<B, P2<K, V>, B>, F2<B, HashArrayMappedTrie<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F2<B, P2<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a left fold.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft() - Static method in class fj.data.List
+
+
Provides a first-class version of foldLeft.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Seq
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft_(F<B, F<A, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldLeftOnNode(F2<B, Node<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Fold
+
+
map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.PTraversal
+
+
map each target to a Monoid and combine the results
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Traversal
+
 
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set using the given monoid.
+
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Tree
+
+
Folds this tree using the given monoid.
+
+
foldMap_(F<A, B>, Monoid<B>) - Static method in class fj.data.Tree
+
+
Provides a function that folds a tree with the given monoid.
+
+
foldMapRight(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set from the right using the given monoid.
+
+
foldMapTree(F<A, B>, Monoid<B>) - Static method in class fj.F1Functions
+
+
Returns a function that maps this function over a tree and folds it with the given monoid.
+
+
foldMapTree(Monoid<B>) - Method in class fj.F1W
+
+
Returns a function that maps this function over a tree and folds it with the given monoid.
+
+
foldRight(Strategy<Unit>, F<A, F<B, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a list in constant stack space.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function and the given initial value.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function and the given initial element.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldRight(F2<Boolean, A, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldRight(G, V, L) - Method in class fj.data.hlist.HList.HFoldr
+
+
Folds a non-empty heterogeneous list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a right fold.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Seq
+
 
+
foldRight(F<A, F<P1<B>, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight(F2<A, P1<B>, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight() - Static method in class fj.data.Stream
+
+
A first-class version of the foldRight function.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Zipper
+
+
Performs a right-fold reduction across this zipper.
+
+
foldRight1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F<A, F<B, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight1(F2<A, B, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight_(F<A, F<B, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldRightC(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list in O(1) stack space.
+
+
foldRightS(Strategy<Unit>, F<A, F<P1<B>, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a Stream in constant stack space.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
+
+
forall(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns true if this is a success or returns the result of the application of the given + function to the failing value.
+
+
forall(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns true if this is a failure or returns the result of the application of the given + function to the success value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<B, Unit>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<P2<K, V>, Unit>) - Method in class fj.data.HashMap
+
 
+
foreach(F<A, Unit>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreach(F<E, Unit>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreach(F<T, Unit>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<B>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<P2<K, V>>) - Method in class fj.data.HashMap
+
 
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreachDoEffect(Effect1<E>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreachDoEffect(Effect1<T>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
forever(Enumerator<A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
+
+
forever(Enumerator<A>, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
+
+
Four<V,A> - Class in fj.data.fingertrees
+
+
A four-element prefix or suffix of a finger tree.
+
+
four(A, A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of four elements.
+
+
from(Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Deprecated. +
As of release 4.5, use HashMap.iterableHashMap(Iterable)
+
+
+
from(Iterable<P2<K, V>>, Equal<K>, Hash<K>) - Static method in class fj.data.HashMap
+
+
Deprecated. +
As of release 4.5, use HashMap.iterableHashMap(fj.Equal<K>, fj.Hash<K>, java.lang.Iterable<fj.P2<K, V>>)
+
+
+
fromBigInt - Static variable in class fj.data.Natural
+
+
A function that returns the natural number equal to a given BigInteger
+
+
fromChar - Static variable in enum fj.Digit
+
+
First-class conversion from a character to a digit.
+
+
fromChar(char) - Static method in enum fj.Digit
+
+
Converts the given character in the given long value to a digit.
+
+
fromEither(F0<Either<Exception, A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a given Either value into the equivalent Callable.
+
+
fromEither() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an Either to a Callable.
+
+
fromF(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
fromForest(Stream<Tree<A>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the first element of the given forest.
+
+
fromFunction(F<Natural, A>) - Static method in class fj.data.Stream
+
+
Converts a function of natural numbers to a stream.
+
+
fromFunction(Enumerator<B>, F<B, A>, B) - Static method in class fj.data.Stream
+
+
Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
+
+
fromInt(int) - Static method in enum fj.Ordering
+
 
+
fromIterator(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
fromJavaList(List<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.List.Buffer
+
+
Constructs a buffer from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.NonEmptyList
+
+
Returns a potential non-empty list from the given list.
+
+
fromList(Ord<A>, List<A>) - Static method in class fj.data.Set
+
+
Deprecated. +
As of release 4.5, use Set.iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
+
+
+
fromLong - Static variable in enum fj.Digit
+
+
First-class conversion from a long to a digit.
+
+
fromLong(long) - Static method in enum fj.Digit
+
+
Converts the right-most digit in the given long value to a digit.
+
+
fromMap(Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMap(Equal<K>, Hash<K>, Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMutableMap(Ord<K>, Map<K, V>) - Static method in class fj.data.TreeMap
+
+
An immutable projection of the given mutable map.
+
+
fromNull(T) - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromNull() - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromOption(F0<Option<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns an optional value into a Callable.
+
+
fromOption() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an optional value to a Callable
+
+
fromSet(Set<A>) - Static method in class fj.data.HashSet
+
 
+
fromSome() - Static method in class fj.data.Option
+
+
Returns a function that takes an optional value to a value or errors if there is no value.
+
+
fromStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from character streams to lazy strings.
+
+
fromStream(Stream<Character>) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a stream of characters.
+
+
fromStream(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromStreamEnd(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromString(String) - Static method in class fj.data.List
+
+
Returns a list of characters from the given string.
+
+
fromString() - Static method in class fj.data.List
+
+
A first-class fromString.
+
+
fromString(String) - Static method in class fj.data.Option
+
+
Returns an optional non-empty string, or no value if the given string is empty.
+
+
fromString() - Static method in class fj.data.Option
+
+
Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
+
+
fromString(String) - Static method in class fj.data.Stream
+
+
Returns a stream of characters from the given string.
+
+
fromString() - Static method in class fj.function.Doubles
+
+
A function that converts strings to doubles.
+
+
fromString() - Static method in class fj.function.Integers
+
+
A function that converts strings to integers.
+
+
fromTree(Tree<A>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the root of the given tree.
+
+
fromTree() - Static method in class fj.data.TreeZipper
+
+
First-class conversion of a Tree to the corresponding tree zipper.
+
+
fromTry(Try0<A, ? extends IOException>) - Static method in class fj.data.IOFunctions
+
 
+
Function - Class in fj
+
+
Transformations on functions.
+
+
functionMonoid(Monoid<B>) - Static method in class fj.Monoid
+
+
A monoid for functions.
+
+
functionSemigroup(Semigroup<B>) - Static method in class fj.Semigroup
+
+
A semigroup for functions.
+
+
Future_P1() - Static method in class fj.data.Java
+
 
+
+ + + +

G

+
+
get(int) - Method in class fj.data.Array
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(int) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(K) - Method in class fj.data.HashMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.HashMap
+
+
A curried version of HashMap.get(Object).
+
+
get(S) - Method in class fj.data.optic.Getter
+
+
get the target of a Getter
+
+
get(S) - Method in class fj.data.optic.Iso
+
 
+
get(S) - Method in class fj.data.optic.Lens
+
 
+
get(S) - Method in class fj.data.optic.PIso
+
+
get the target of a PIso
+
+
get(S) - Method in class fj.data.optic.PLens
+
+
get the target of a PLens
+
+
get(K) - Method in class fj.data.TreeMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.TreeMap
+
+
Returns a first-class version of the get method for this TreeMap.
+
+
getAll(S) - Method in class fj.data.optic.Fold
+
+
get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
+
+
getAll(S) - Method in class fj.data.optic.PTraversal
+
+
get all the targets of a PTraversal
+
+
getBitSet() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
getChild(int) - Method in class fj.data.TreeZipper
+
+
Navigates to the given child of the current location, starting at index 0.
+
+
getContents() - Static method in class fj.data.IOFunctions
+
 
+
getContents() - Static method in class fj.data.IOW
+
 
+
getDelete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
+
+
getDirectionality - Static variable in class fj.function.Characters
+
 
+
getFunction() - Method in class fj.data.Reader
+
 
+
getLabel() - Method in class fj.data.TreeZipper
+
+
Returns the label at the current node.
+
+
getNumericValue - Static variable in class fj.function.Characters
+
 
+
getOption(S) - Method in class fj.data.optic.Optional
+
 
+
getOption(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.Prism
+
 
+
getOrModify(S) - Method in class fj.data.optic.Optional
+
 
+
getOrModify(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.Prism
+
 
+
gets(F<S, A>) - Static method in class fj.data.State
+
 
+
gets() - Method in class fj.data.State
+
 
+
getSeed() - Method in class fj.LcgRng
+
 
+
getSeq() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
Getter<S,A> - Class in fj.data.optic
+
+
A Getter can be seen as a glorified get method between a type S and a type A.
+
+
getter(F<S, A>) - Static method in class fj.data.optic.Getter
+
 
+
getType - Static variable in class fj.function.Characters
+
 
+
group(Equal<A>) - Method in class fj.data.List
+
+
Groups elements according to the given equality implementation by longest + sequence of equal elements.
+
+
groupBy(F<A, B>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.7, use List.groupBy(F, Ord)
+
+
+
groupBy(F<A, B>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap.
+
+
groupBy(F<A, B>, F<A, C>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.7, use List.groupBy(F, F, Ord)
+
+
+
groupBy(F<A, B>, F<A, C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, Monoid<C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, D, F2<C, D, D>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
+
+
gteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than or equal to zero.
+
+
gteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than or equal to zero.
+
+
gtZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than zero.
+
+
gtZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than zero.
+
+
+ + + +

H

+
+
hamtNode(HashArrayMappedTrie<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
hamtNodeShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hamtShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hAnd(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hardMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
+
+
hardMemo() - Method in class fj.P1
+
+
Returns a P1 that remembers its value.
+
+
hasChildren() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node has any child nodes.
+
+
hash(K) - Method in class fj.data.HashMap
+
+
Compute the hash of the given key value using the underlying hashing strategy.
+
+
hash(A) - Method in class fj.data.HashSet
+
+
Compute the hash of the given value using the underlying hashing strategy.
+
+
Hash<A> - Class in fj
+
+
Produces a hash code for an object which should attempt uniqueness.
+
+
hash(A) - Method in class fj.Hash
+
+
Compute the hash of the given value.
+
+
hash(F<A, Integer>) - Static method in class fj.Hash
+
+
Construct a hash with the given hash function.
+
+
HashArrayMappedTrie<K,V> - Class in fj.data.hamt
+
+
A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
+
+
hashCode() - Method in class fj.data.Array
+
 
+
hashCode() - Method in class fj.data.Either
+
 
+
hashCode() - Method in class fj.data.List
+
+
Compute the hash code from this list as a function of the hash codes of its members.
+
+
hashCode() - Method in class fj.data.Natural
+
 
+
hashCode() - Method in class fj.data.NonEmptyList
+
 
+
hashCode() - Method in class fj.data.Option
+
 
+
hashCode() - Method in class fj.data.Seq
+
 
+
hashCode() - Method in class fj.data.Set
+
 
+
hashCode() - Method in class fj.data.Stream
+
 
+
hashCode() - Method in class fj.data.Tree
+
 
+
hashCode() - Method in class fj.data.TreeMap
+
 
+
hashCode() - Method in class fj.data.TreeZipper
+
 
+
hashCode() - Method in class fj.data.Validation
+
 
+
hashCode() - Method in class fj.data.vector.V2
+
 
+
hashCode() - Method in class fj.data.vector.V3
+
 
+
hashCode() - Method in class fj.data.vector.V4
+
 
+
hashCode() - Method in class fj.data.vector.V5
+
 
+
hashCode() - Method in class fj.data.vector.V6
+
 
+
hashCode() - Method in class fj.data.vector.V7
+
 
+
hashCode() - Method in class fj.data.vector.V8
+
 
+
hashCode() - Method in class fj.data.Zipper
+
 
+
hashCode() - Method in class fj.P1
+
 
+
hashCode() - Method in class fj.P2
+
 
+
hashCode() - Method in class fj.P3
+
 
+
hashCode() - Method in class fj.P4
+
 
+
hashCode() - Method in class fj.P5
+
 
+
hashCode() - Method in class fj.P6
+
 
+
hashCode() - Method in class fj.P7
+
 
+
hashCode() - Method in class fj.P8
+
 
+
hashCode() - Method in class fj.parser.Result
+
 
+
hashEqualsOrd() - Static method in class fj.Ord
+
+
Deprecated. +
As of release 4.7.
+
+
+
HashMap<K,V> - Class in fj.data
+
+
A mutable hash map providing O(1) lookup.
+
+
HashMap(Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>, Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int, float) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
hashMap() - Static method in class fj.data.HashMap
+
+
Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
+
+
hashMap(Equal<K>, Hash<K>) - Static method in class fj.data.HashMap
+
+
Construct a hash map.
+
+
hashOrd() - Static method in class fj.Ord
+
+
Deprecated. +
As of release 4.7.
+
+
+
HashSet<A> - Class in fj.data
+
+
A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
+
+
HashSet(Equal<A>, Hash<A>) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int, float) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
hashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
hashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
HashSet_List() - Static method in class fj.data.Java
+
+
A function that converts hash sets to lists.
+
+
hCond(HPre.HFalse, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
hCond(HPre.HTrue, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
head() - Method in class fj.data.fingertrees.Deep
+
 
+
head() - Method in class fj.data.fingertrees.Empty
+
 
+
head() - Method in class fj.data.fingertrees.FingerTree
+
+
The first element of this tree.
+
+
head() - Method in class fj.data.fingertrees.Single
+
 
+
head() - Method in class fj.data.hlist.HList.HCons
+
 
+
head() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the head of the input
+
+
head() - Method in class fj.data.LazyString
+
+
Returns the first character of this string.
+
+
head() - Method in class fj.data.List
+
+
The first element of the linked list or fails for the empty list.
+
+
head() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons head.
+
+
head() - Method in class fj.data.NonEmptyList
+
+
The first element of this linked list.
+
+
head() - Method in class fj.data.Seq
+
+
The first element of this sequence.
+
+
head() - Method in class fj.data.Stream
+
+
The first element of the stream or fails for the empty stream.
+
+
head() - Method in class fj.data.vector.V2
+
+
Return the first element of this vector as a product-1.
+
+
head() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector, as a product-1.
+
+
head_() - Static method in class fj.data.List
+
+
First-class head function.
+
+
headOption() - Method in class fj.data.fingertrees.FingerTree
+
 
+
headOption() - Method in class fj.data.List
+
+
Returns the head of the list, if any.
+
+
headOption(S) - Method in class fj.data.optic.Fold
+
+
get the first target of a Fold
+
+
headOption(S) - Method in class fj.data.optic.PTraversal
+
+
get the first target of a PTraversal
+
+
headOption() - Method in class fj.data.Seq
+
 
+
hFalse() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents falsehood.
+
+
hFoldr() - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for the empty list.
+
+
hFoldr(PP, H) - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for a non-empty heterogeneous list
+
+
highSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
highSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
HList<A extends HList<A>> - Class in fj.data.hlist
+
+
Type-safe heterogeneous lists.
+
+
HList.Apply<F$,A,R> - Class in fj.data.hlist
+
+
Type-level function application operators.
+
+
HList.HAppend<A,B,C> - Class in fj.data.hlist
+
+
The concatenation of two heterogeneous lists.
+
+
HList.HCons<E,L extends HList<L>> - Class in fj.data.hlist
+
+
The nonempty list
+
+
HList.HFoldr<G,V,L,R> - Class in fj.data.hlist
+
+
The catamorphism over heterogeneous lists.
+
+
HList.HNil - Class in fj.data.hlist
+
+
The empty list
+
+
hListEqual - Static variable in class fj.Equal
+
+
An equal instance for the empty heterogeneous list.
+
+
hListEqual(Equal<E>, Equal<L>) - Static method in class fj.Equal
+
+
An equal instance for heterogeneous lists.
+
+
HListShow - Static variable in class fj.Show
+
+
A show instance for the empty heterogeneous Stream.
+
+
HListShow(Show<E>, Show<L>) - Static method in class fj.Show
+
+
A show instance for heterogeneous Streams.
+
+
HNat() - Constructor for class fj.data.hlist.HPre.HNat
+
 
+
hOr(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
HPre - Class in fj.data.hlist
+
+
A basic prelude of values lifted into the type system.
+
+
HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>> - Class in fj.data.hlist
+
+
Type-level integer arithmetic
+
+
HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean conjunction.
+
+
HPre.HBool - Class in fj.data.hlist
+
+
A type-level Boolean
+
+
HPre.HCond<T,X,Y,Z> - Class in fj.data.hlist
+
+
A type-level conditional.
+
+
HPre.HEq<X,Y,B extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level equality.
+
+
HPre.HFalse - Class in fj.data.hlist
+
+
Boolean false
+
+
HPre.HNat<A extends HPre.HNat<A>> - Class in fj.data.hlist
+
+
Type-level natural numbers.
+
+
HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean disjunction.
+
+
HPre.HSucc<N extends HPre.HNat<N>> - Class in fj.data.hlist
+
+
A natural number N + 1
+
+
HPre.HTrue - Class in fj.data.hlist
+
+
Boolean true
+
+
HPre.HZero - Class in fj.data.hlist
+
+
Type-level zero
+
+
hPred(HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hSucc(N) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hTrue() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents truth.
+
+
hZero() - Static method in class fj.data.hlist.HPre.HNat
+
 
+
+ + + +

I

+
+
id() - Static method in class fj.data.hlist.HList.Apply
+
+
Identity operator
+
+
id() - Static method in class fj.data.optic.Fold
+
 
+
id() - Static method in class fj.data.optic.Getter
+
 
+
id() - Static method in class fj.data.optic.Iso
+
+
create an Iso between any type and itself.
+
+
id() - Static method in class fj.data.optic.Lens
+
 
+
id() - Static method in class fj.data.optic.Optional
+
 
+
id() - Static method in class fj.data.optic.Prism
+
 
+
id() - Static method in class fj.data.optic.Setter
+
 
+
id() - Static method in class fj.data.optic.Traversal
+
 
+
identifierIgnorable(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identifierIgnorable(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identity() - Static method in class fj.Function
+
+
The identity transformation.
+
+
idStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs no evaluation of its argument.
+
+
if_ - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if" (reverse material implication).
+
+
iff - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if and only if" (biconditional, equivalence).
+
+
ignored() - Static method in class fj.data.optic.Optional
+
 
+
iif(boolean, F0<B>, F0<A>) - Static method in class fj.data.Either
+
+
If the condition satisfies, return the given A in left, otherwise, return the given B in right.
+
+
iif(F<A, Boolean>, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
+
+
iif(boolean, F0<A>) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif(boolean, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif() - Static method in class fj.data.Option
+
+
First-class version of the iif function.
+
+
immutable() - Method in class fj.data.Array
+
 
+
implies - Static variable in class fj.function.Booleans
+
+
Curried form of logical "only if" (material implication).
+
+
index(int) - Method in class fj.data.List
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index(int) - Method in class fj.data.Seq
+
+
Returns the element at the given index.
+
+
index(int) - Method in class fj.data.Stream
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index() - Method in class fj.data.Zipper
+
+
Returns the index of the focus.
+
+
indexOf(char) - Method in class fj.data.LazyString
+
+
Returns the first index of the given character in this lazy string, if present.
+
+
indexOf(LazyString) - Method in class fj.data.LazyString
+
+
Returns the first index of the given substring in this lazy string, if present.
+
+
indexOf(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the position of the first element matching the given predicate, if any.
+
+
inheritance() - Method in class fj.Class
+
+
Returns the inheritance hierarchy of this class.
+
+
init() - Method in class fj.data.fingertrees.Deep
+
 
+
init() - Method in class fj.data.fingertrees.Empty
+
 
+
init() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the last element.
+
+
init() - Method in class fj.data.fingertrees.Single
+
 
+
init() - Method in class fj.data.List
+
+
Returns all but the last element of this list.
+
+
init() - Method in class fj.data.Seq
+
+
The sequence without the last element.
+
+
init() - Static method in class fj.data.State
+
 
+
inits() - Method in class fj.data.List
+
+
Returns the list of initial segments of this list, shortest first.
+
+
inits() - Method in class fj.data.Stream
+
+
Returns a stream of all prefixes of this stream.
+
+
inject(C) - Method in class fj.P2
+
+
Replaces the first element of this product with the given value.
+
+
insert(int, A) - Method in class fj.data.Seq
+
+
Inserts the element at the given index.
+
+
insert(A) - Method in class fj.data.Set
+
+
Inserts the given element into this set.
+
+
insert() - Static method in class fj.data.Set
+
+
First-class insertion function.
+
+
insertBy(F<A, F<A, Ordering>>, A) - Method in class fj.data.List
+
+
Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
+
+
insertDownAt(int, Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree at the specified location in the current node's stream of children.
+
+
insertDownFirst(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the first child of the current node.
+
+
insertDownLast(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the last child of the current node.
+
+
insertLeft(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the left of the current position.
+
+
insertLeft(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the left of the focus, then moves the focus to the new element.
+
+
insertRight(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the right of the current position.
+
+
insertRight(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the right of the focus, then moves the focus to the new element.
+
+
intAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds integers.
+
+
intAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds integers.
+
+
Integer_Boolean - Static variable in class fj.Primitive
+
+
A function that converts integers to booleans.
+
+
Integer_Byte - Static variable in class fj.Primitive
+
+
A function that converts integers to bytes.
+
+
Integer_Character - Static variable in class fj.Primitive
+
+
A function that converts integers to characters.
+
+
Integer_Double - Static variable in class fj.Primitive
+
+
A function that converts integers to doubles.
+
+
Integer_Float - Static variable in class fj.Primitive
+
+
A function that converts integers to floats.
+
+
Integer_Long - Static variable in class fj.Primitive
+
+
A function that converts integers to longs.
+
+
Integer_Short - Static variable in class fj.Primitive
+
+
A function that converts integers to shorts.
+
+
Integers - Class in fj.function
+
+
Curried functions over Integers.
+
+
intEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for int.
+
+
intEqual - Static variable in class fj.Equal
+
+
An equal instance for the int type.
+
+
interact(F<LazyString, LazyString>) - Static method in class fj.data.IOFunctions
+
 
+
interact(F<LazyString, LazyString>) - Static method in class fj.data.IOW
+
 
+
interactWhile(F<String, Boolean>, F<String, String>) - Static method in class fj.data.IOFunctions
+
+
Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
+
+
intercalate(List<List<A>>) - Method in class fj.data.List
+
+
Intersperses this list through the given list then joins the results.
+
+
interfaceParameters() - Method in class fj.Class
+
+
Provides this class's interface type parameter information as a list of trees.
+
+
interleave(Stream<A>) - Method in class fj.data.Stream
+
+
Interleaves the given stream with this stream to produce a new stream.
+
+
intersect(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that do not occur in the given set.
+
+
intersect() - Static method in class fj.data.Set
+
+
A first class function for Set.intersect(Set).
+
+
intersperse(A) - Method in class fj.data.List
+
+
Intersperses the given argument between each element of this list.
+
+
intersperse(A) - Method in class fj.data.NonEmptyList
+
+
Intersperses the given argument between each element of this non empty list.
+
+
intersperse(A) - Method in class fj.data.Stream
+
+
Intersperses the given value between each two elements of the stream.
+
+
intHash - Static variable in class fj.Hash
+
+
A hash instance for the int type.
+
+
intMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of integers.
+
+
intMaxMonoid - Static variable in class fj.Monoid
+
+
A monoid for the maximum of two integers.
+
+
intMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of integers.
+
+
intMinMonoid - Static variable in class fj.Monoid
+
+
A monoid for the minimum of two integers.
+
+
intMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies integers.
+
+
intMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies integers.
+
+
intOrd - Static variable in class fj.Ord
+
+
An order instance for the int type.
+
+
intShow - Static variable in class fj.Show
+
+
A show instance for the int type.
+
+
intValue() - Method in class fj.data.Natural
+
+
Return the int value of this natural number.
+
+
IO<A> - Interface in fj.data
+
+
IO monad for processing files
+
+
io(Try0<A, ? extends IOException>) - Static method in class fj.Try
+
 
+
IOFunctions - Class in fj.data
+
+
IO monad for processing files, with main methods IOFunctions.enumFileLines(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.String, A>), + IOFunctions.enumFileChars(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.Character, A>) and IOFunctions.enumFileCharChunks(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<char[], A>) + (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee + without indirection in between).
+
+
ioMonoid(Monoid<A>) - Static method in class fj.Monoid
+
+
A monoid for IO values.
+
+
ioSemigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A semigroup for IO values.
+
+
ioUnit - Static variable in class fj.data.IOFunctions
+
 
+
IOW<A> - Class in fj.data
+
+
Created by MarkPerry on 9/06/2015.
+
+
is(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
alias for contramap
+
+
isChild() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is a child node of another node.
+
+
isDefined - Static variable in class fj.function.Characters
+
 
+
isDigit - Static variable in class fj.function.Characters
+
 
+
isEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.Array
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.fingertrees.FingerTree
+
+
Indicates whether this tree is empty.
+
+
isEmpty() - Method in class fj.data.hamt.BitSet
+
 
+
isEmpty() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns if the trie is empty.
+
+
isEmpty() - Method in class fj.data.HashMap
+
+
Determines if this hash map has any entries.
+
+
isEmpty() - Method in class fj.data.HashSet
+
+
Determines if this hash set contains any elements.
+
+
isEmpty() - Method in class fj.data.LazyString
+
+
Checks if this string is empty.
+
+
isEmpty() - Method in class fj.data.List.Buffer
+
+
Returns true if this buffer is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.List
+
+
Returns true if this list is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.PriorityQueue
+
+
Is the tree empty?
+
+
isEmpty() - Method in class fj.data.Seq
+
+
Checks if this is the empty sequence.
+
+
isEmpty() - Method in class fj.data.Set
+
 
+
isEmpty() - Method in class fj.data.Stream
+
+
Returns true if this stream is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.TreeMap
+
+
Determines if this tree map has any entries.
+
+
isEmpty - Static variable in class fj.function.Strings
+
+
A curried version of String.isEmpty().
+
+
isEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is empty.
+
+
isEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is empty.
+
+
isEqual(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isFail() - Method in class fj.data.Validation
+
+
Returns true if this is a failure, false otherwise.
+
+
isFirst() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the leftmost tree in the current forest.
+
+
isFulfilled() - Method in class fj.control.parallel.Promise
+
+
Returns true if this promise has been fulfilled.
+
+
isGreaterThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isGreaterThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is greater than the second given + argument, false otherwise.
+
+
isGreaterThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is greater than than the argument to this method.
+
+
isIdentifierIgnorable - Static variable in class fj.function.Characters
+
 
+
isISOControl - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isLast() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the rightmost tree in the current forest.
+
+
isLeaf() - Method in class fj.data.Tree
+
 
+
isLeaf() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the bottom of the tree.
+
+
isLeft() - Method in class fj.data.Either
+
+
Returns true if this either is a left, false otherwise.
+
+
isLessThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
+
Does the top of the queue have lower priority than k?
+
+
isLessThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than the second given argument, + false otherwise.
+
+
isLessThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is less than the argument to this method.
+
+
isLessThanOrEqualTo(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
+
+
isLetter - Static variable in class fj.function.Characters
+
 
+
isLetterOrDigit - Static variable in class fj.function.Characters
+
 
+
isLowerCase - Static variable in class fj.function.Characters
+
 
+
isMatching(S) - Method in class fj.data.optic.POptional
+
+
check if a POptional has a target
+
+
isMatching(S) - Method in class fj.data.optic.PPrism
+
+
check if a PPrism has a target
+
+
isMirrored - Static variable in class fj.function.Characters
+
 
+
isNewLine - Static variable in class fj.function.Characters
+
 
+
isNone() - Method in class fj.data.Option
+
+
Returns false if this optional value has a value, true otherwise.
+
+
isNone_() - Static method in class fj.data.Option
+
+
A first-class version of the isNone method.
+
+
isnot(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns inverse of contramap
+
+
isNotEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Array
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.List
+
+
Returns false if this list is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Seq
+
+
Checks if this sequence is not empty.
+
+
isNotEmpty() - Method in class fj.data.Stream
+
+
Returns false if this stream is empty, true otherwise.
+
+
isNotEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is not empty.
+
+
isNotEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is not empty.
+
+
isNotNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
+
+
isNotNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is neither null nor empty.
+
+
isNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
+
+
isNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is null or empty (String.isEmpty()).
+
+
Iso<S,A> - Class in fj.data.optic
+
+
PIso when S = T and A = B
+
+
Iso(PIso<S, S, A, A>) - Constructor for class fj.data.optic.Iso
+
 
+
iso(F<S, A>, F<A, S>) - Static method in class fj.data.optic.Iso
+
+
create an Iso using a pair of functions: one to get the target and one to get the source.
+
+
isoControl(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isoControl(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isPrefixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isRight() - Method in class fj.data.Either
+
+
Returns true if this either is a right, false otherwise.
+
+
isRoot() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the top of the tree.
+
+
isSet(int) - Method in class fj.data.hamt.BitSet
+
 
+
isSingle() - Method in class fj.data.List
+
+
True if and only if the list has one element.
+
+
isSome() - Method in class fj.data.Option
+
+
Returns true if this optional value has a value, false otherwise.
+
+
isSome_() - Static method in class fj.data.Option
+
+
A first-class version of the isSome method.
+
+
isSpaceChar - Static variable in class fj.function.Characters
+
 
+
isSuccess() - Method in class fj.data.Validation
+
+
Returns true if this is a success, false otherwise.
+
+
isSuffixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isTitleCase - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isUpperCase - Static variable in class fj.function.Characters
+
 
+
isWhitespace - Static variable in class fj.function.Characters
+
 
+
iterable(A) - Static method in class fj.data.IterableW
+
+
Returns an Iterable that completely preserves the argument.
+
+
iterable(F<A, B>) - Static method in class fj.data.IterableW
+
+
Wraps a given function's return value in a Iterable.
+
+
iterableArray(Iterable<A>) - Static method in class fj.data.Array
+
+
Takes the given iterable to an array.
+
+
iterableBuffer(Iterable<A>) - Static method in class fj.data.List.Buffer
+
+
Takes the given iterable to a buffer.
+
+
iterableDList(Iterable<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterable
+
+
iterableHashMap(Equal<K>, Hash<K>, Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashMap(Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashSet(Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableHashSet(Equal<A>, Hash<A>, Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in an Iterable.
+
+
iterableK() - Method in class fj.F1W
+
+
Promotes this function to return its value in an Iterable.
+
+
iterableList(Iterable<A>) - Static method in class fj.data.List
+
+
Takes the given iterable to a list.
+
+
iterableM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Iterables.
+
+
iterableM() - Method in class fj.F2W
+
+
Promotes this function to a function on Iterables.
+
+
iterableSeq(Iterable<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterable.
+
+
iterableSet(Ord<A>, Iterable<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterable as a set.
+
+
iterableStream(Iterable<A>) - Static method in class fj.data.Stream
+
+
Takes the given iterable to a stream.
+
+
iterableTreeMap(Ord<K>, Iterable<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
IterableW<A> - Class in fj.data
+
+
A wrapper for Iterable that equips it with some useful functions.
+
+
iterate(F<A, A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream constructed by applying the given iteration function starting at the given value.
+
+
iterate() - Static method in class fj.data.Stream
+
+
A first-class version of the iterate function.
+
+
Iteratee - Class in fj.data
+
 
+
Iteratee.Input<E> - Class in fj.data
+
+
The input to an iteratee.
+
+
Iteratee.IterV<E,A> - Class in fj.data
+
+
A pure iteratee computation which is either done or needs more input
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.List
+
+
Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.Stream
+
+
Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterator() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Array
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Either.LeftProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Either.RightProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.HashMap
+
+
Returns an iterator for this map's keys.
+
+
iterator() - Method in class fj.data.HashSet
+
+
Returns an iterator for this hash set.
+
+
iterator() - Method in class fj.data.IterableW
+
+
Returns an iterator for this iterable.
+
+
iterator() - Method in class fj.data.List.Buffer
+
+
Returns an iterator for this buffer.
+
+
iterator() - Method in class fj.data.List
+
+
Returns an iterator for this list.
+
+
iterator() - Method in class fj.data.NonEmptyList
+
+
Returns an iterator for this non-empty list.
+
+
iterator() - Method in class fj.data.Option
+
+
Returns an iterator for this optional value.
+
+
iterator() - Method in class fj.data.Seq
+
+
Returns an iterator for this seq.
+
+
iterator() - Method in class fj.data.Set
+
+
Returns an iterator over this set.
+
+
iterator() - Method in class fj.data.Stream
+
+
Returns an iterator for this stream.
+
+
iterator() - Method in class fj.data.Tree
+
+
Returns an iterator for this tree.
+
+
iterator() - Method in class fj.data.TreeMap
+
+
Returns an iterator for this map's key-value pairs.
+
+
iterator() - Method in class fj.data.TreeZipper
+
+
Returns an iterator of all the positions of this TreeZipper.
+
+
iterator() - Method in class fj.data.Validation.FailProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Validation
+
+
Returns an iterator for this validation.
+
+
iterator() - Method in class fj.data.vector.V2
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V3
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V4
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V5
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V6
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V7
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V8
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.Zipper
+
+
Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
+
+
iterator() - Method in class fj.parser.Result
+
+
Returns an iterator over the parse value.
+
+
iteratorArray(Iterator<A>) - Static method in class fj.data.Array
+
+
Creates an Array from the iterator.
+
+
iteratorDList(Iterator<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterator
+
+
iteratorHashMap(Equal<K>, Hash<K>, Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashMap(Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashSet(Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorHashSet(Equal<A>, Hash<A>, Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorList(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
iteratorSeq(Iterator<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterator.
+
+
iteratorSet(Ord<A>, Iterator<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
iteratorStream(Iterator<A>) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements in the Iterator.
+
+
iteratorTreeMap(Ord<K>, Iterator<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
+ + + +

J

+
+
Java - Class in fj.data
+
+
Functions that convert between types from the core Java API.
+
+
javaIdentifierPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
javaIdentifierStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
JavaList_List() - Static method in class fj.data.Java
+
 
+
JavaList_List(List<A>) - Static method in class fj.data.Java
+
 
+
join(DB<DB<A>>) - Static method in class fj.control.db.DB
+
+
Removes one layer of monadic structure.
+
+
join(Callable<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Joins a Callable of a Callable with a bind operation.
+
+
join(Promise<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a promise of a promise into just a promise.
+
+
join(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a product of a promise into just a promise.
+
+
join(Array<Array<A>>) - Static method in class fj.data.Array
+
+
Joins the given array of arrays using a bind operation.
+
+
join() - Static method in class fj.data.Array
+
+
A first-class version of join
+
+
join(IO<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
join(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Joins an Iterable of Iterables into a single Iterable.
+
+
join() - Static method in class fj.data.IterableW
+
+
Returns a function that joins an Iterable of Iterables into a single Iterable.
+
+
join(List<List<A>>) - Static method in class fj.data.List
+
+
Joins the given list of lists using a bind operation.
+
+
join() - Static method in class fj.data.List
+
+
A first-class version of join
+
+
join(NonEmptyList<NonEmptyList<A>>) - Static method in class fj.data.NonEmptyList
+
+
Concatenate (join) a non empty list of non empty lists.
+
+
join(Option<Option<A>>) - Static method in class fj.data.Option
+
+
Joins the given optional value of optional value using a bind operation.
+
+
join() - Static method in class fj.data.Option
+
+
First-class join function.
+
+
join(Ord<A>, Set<Set<A>>) - Static method in class fj.data.Set
+
+
Join a set of sets into a single set.
+
+
join(Stream<Stream<A>>) - Static method in class fj.data.Stream
+
+
Joins the given stream of streams by concatenation.
+
+
join() - Static method in class fj.data.Stream
+
+
A first-class version of join
+
+
join(F<B, F<B, A>>) - Static method in class fj.Function
+
+
Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
+
+
join(Iterable<A>, A) - Method in class fj.Monoid
+
+
Intersperses the given value between each two elements of the iterable, and sums the result.
+
+
join(P1<P1<A>>) - Static method in class fj.P1
+
+
Joins a P1 of a P1 with a bind operation.
+
+
joinLeft(Either<Either<A, B>, B>) - Static method in class fj.data.Either
+
+
Joins an either through left.
+
+
joinRight(Either<A, Either<A, B>>) - Static method in class fj.data.Either
+
+
Joins an either through right.
+
+
JUList_List() - Static method in class fj.data.Java
+
+
Deprecated. +
As of 4.3, use Java.JavaList_List()
+
+
+
+ + + +

K

+
+
keys() - Method in class fj.data.HashMap
+
+
Returns all key entries in this hash map.
+
+
keys() - Method in class fj.data.TreeMap
+
+
Returns all keys in this tree map.
+
+
+ + + +

L

+
+
last() - Method in class fj.data.fingertrees.Deep
+
 
+
last() - Method in class fj.data.fingertrees.Empty
+
 
+
last() - Method in class fj.data.fingertrees.FingerTree
+
+
The last element of this tree.
+
+
last() - Method in class fj.data.fingertrees.Single
+
 
+
last() - Method in class fj.data.List
+
+
Returns the last element of this list.
+
+
last() - Method in class fj.data.Seq
+
+
The last element of this sequence.
+
+
last() - Method in class fj.data.Stream
+
+
Get the last element of this stream.
+
+
lastChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the last child of the current location.
+
+
lastOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the last available value.
+
+
lastOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the last available value.
+
+
lastSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "last" (right-hand side) value.
+
+
later(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation with caching.
+
+
lazy(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<A, Unit>) - Static method in class fj.Effect
+
 
+
lazy(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a product-1.
+
+
lazy() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a product-1.
+
+
lazy(A) - Method in class fj.F1W
+
+
Partial application.
+
+
lazy(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
+
+
lazy(F0<A>, F0<B>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>, F0<H>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>, F<Unit, H>) - Static method in class fj.P
+
 
+
lazyProduct(F0<P2<A, B>>) - Static method in class fj.P
+
 
+
lazySafe(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazySafe(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
LazyString - Class in fj.data
+
+
A lazy (non-evaluated) immutable character string.
+
+
lazyStringShow - Static variable in class fj.Show
+
+
A show instance for lazy strings.
+
+
LcgRng - Class in fj
+
+
Created by MarkPerry on 7/07/2014.
+
+
LcgRng() - Constructor for class fj.LcgRng
+
 
+
LcgRng(long) - Constructor for class fj.LcgRng
+
 
+
leaf(A) - Static method in class fj.data.Tree
+
+
Creates a nullary tree.
+
+
left() - Method in class fj.data.Either
+
+
Projects this either as a left.
+
+
left(A) - Static method in class fj.data.Either
+
+
Construct a left value of either.
+
+
left(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
left() - Method in class fj.data.TreeZipper
+
+
Navigates to the left sibling of the current location.
+
+
left_() - Static method in class fj.data.Either
+
+
A function that constructs a left value of either.
+
+
left_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the left() function.
+
+
leftMap_() - Static method in class fj.data.Either
+
 
+
lefts(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the left values in the given list.
+
+
lefts() - Method in class fj.data.TreeZipper
+
+
Returns the left siblings of the currently focused node.
+
+
lefts() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the left of focus.
+
+
length() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.Array
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.fingertrees.Deep
+
 
+
length() - Method in class fj.data.fingertrees.Digit
+
 
+
length() - Method in class fj.data.fingertrees.Empty
+
 
+
length() - Method in class fj.data.fingertrees.FingerTree
+
 
+
length() - Method in class fj.data.fingertrees.Four
+
 
+
length() - Method in class fj.data.fingertrees.Node
+
 
+
length() - Method in class fj.data.fingertrees.Node2
+
 
+
length() - Method in class fj.data.fingertrees.Node3
+
 
+
length() - Method in class fj.data.fingertrees.One
+
 
+
length() - Method in class fj.data.fingertrees.Single
+
 
+
length() - Method in class fj.data.fingertrees.Three
+
 
+
length() - Method in class fj.data.fingertrees.Two
+
 
+
length() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the number of elements in the trie.
+
+
length() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that counts and consumes the elements of the input
+
+
length() - Method in class fj.data.LazyString
+
+
The length of the lazy string.
+
+
length() - Method in class fj.data.List
+
+
The length of this list.
+
+
length() - Method in class fj.data.NonEmptyList
+
+
The length of this list.
+
+
length() - Method in class fj.data.Option
+
+
Returns the length of this optional value; 1 if there is a value, 0 otherwise.
+
+
length() - Method in class fj.data.Seq
+
+
Returns the number of elements in this sequence.
+
+
length() - Method in class fj.data.Stream
+
+
The length of this stream.
+
+
length() - Method in class fj.data.Tree
+
 
+
length() - Method in class fj.data.Zipper
+
+
Returns the length of this zipper.
+
+
length - Static variable in class fj.function.Strings
+
+
A curried version of String.length().
+
+
length_() - Static method in class fj.data.List
+
+
First-class length.
+
+
Lens<S,A> - Class in fj.data.optic
+
+
PLens with a monomorphic set function
+
+
Lens(PLens<S, S, A, A>) - Constructor for class fj.data.optic.Lens
+
 
+
lens(F<S, A>, F<A, F<S, S>>) - Static method in class fj.data.optic.Lens
+
+
create a Lens using a pair of functions: one to get the target, one to set the target.
+
+
levels() - Method in class fj.data.Tree
+
+
Provides a stream of the elements of the tree at each level, in level order.
+
+
lift(IO<A>) - Static method in class fj.data.IOW
+
 
+
lift(F<A, B>) - Static method in class fj.F1W
+
+
Lifts the function into the fully featured function wrapper
+
+
lift(F2<A, B, C>) - Static method in class fj.F2W
+
+
Lifts the function into the fully featured function wrapper
+
+
lift(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Promotes a function of arity-2 to a higher-order function.
+
+
lift() - Method in class fj.Semigroup
+
+
Lifts the semigroup to obtain a trivial monoid.
+
+
liftM(F<A, B>) - Static method in class fj.control.db.DB
+
+
Promotes any given function so that it transforms between values in the database.
+
+
liftM(F<A, B>, Measured<V, B>) - Static method in class fj.data.fingertrees.Node
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Promotes a function of arity-2 to a function on callables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Promise
+
+
Promotes a function of arity-2 to a function on promises.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.Trampoline
+
+
Promotes the given function of arity-2 to a function on Trampolines.
+
+
liftM2(IO<A>, IO<B>, F2<A, B, C>) - Static method in class fj.data.IOFunctions
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Promotes a function of arity-2 to a function on iterables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.List
+
+
Promotes the given function of arity-2 to a function on lists.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.Option
+
+
Promotes a function of arity-2 so that it operates over options.
+
+
liftM2(Option<B>, F2<A, B, C>) - Method in class fj.data.Option
+
+
Lift the function of arity-2 through options.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.P1
+
+
Promotes a function of arity-2 to a function on P1s.
+
+
liftM2(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
 
+
lineReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with lines read from a BufferedReader.
+
+
lines() - Method in class fj.data.LazyString
+
+
Splits this lazy string into lines.
+
+
lines(String) - Static method in class fj.function.Strings
+
 
+
lines() - Static method in class fj.function.Strings
+
 
+
lines_() - Static method in class fj.data.LazyString
+
 
+
lineSeparator - Static variable in class fj.function.Strings
+
 
+
LinkedBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts linked blocking queues to lists.
+
+
LinkedHashSet_List() - Static method in class fj.data.Java
+
+
A function that converts linked hash sets to lists.
+
+
LinkedList_List() - Static method in class fj.data.Java
+
+
A function that converts linked lists to lists.
+
+
list() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the input elements and returns them as a list in reverse order, + so that the last line is the first element.
+
+
List<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list.
+
+
list(B, F<A, F<List<A>, B>>) - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.uncons(fj.F2<A, fj.data.List<A>, B>, B)
+
+
+
list(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
list(Iterable<A>) - Static method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.iterableList(Iterable)
+
+
+
list(Iterator<A>) - Static method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.iteratorList(Iterator)
+
+
+
List.Buffer<A> - Class in fj.data
+
+
A mutable, singly linked list.
+
+
List.Optic - Class in fj.data
+
+
Optic factory methods for a List
+
+
List.Unsafe - Class in fj.data
+
 
+
List_Array() - Static method in class fj.data.Conversions
+
+
A function that converts lists to arrays.
+
+
List_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to array blocking queue.
+
+
List_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to array lists.
+
+
List_BitSet - Static variable in class fj.data.Java
+
+
A function that converts lists to bit sets.
+
+
List_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to concurrent linked queues.
+
+
List_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array lists.
+
+
List_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array sets.
+
+
List_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to delay queues.
+
+
List_Either() - Static method in class fj.data.Conversions
+
+
A function that converts lists to eithers.
+
+
List_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts lists to array enum sets.
+
+
List_HashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to hash sets.
+
+
List_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to linked blocking queues.
+
+
List_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to linked hash sets.
+
+
List_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts lists to linked lists.
+
+
List_Option() - Static method in class fj.data.Conversions
+
+
A function that converts lists to options.
+
+
List_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority blocking queues.
+
+
List_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority queues.
+
+
List_Stack() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts lists to streams.
+
+
List_String - Static variable in class fj.data.Conversions
+
+
A function that converts lists to strings.
+
+
List_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string buffers.
+
+
List_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string builders.
+
+
List_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to synchronous queues.
+
+
List_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Vector() - Static method in class fj.data.Java
+
+
A function that converts lists to vectors.
+
+
listBitSet(List<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
listDList(List<A>) - Static method in class fj.data.DList
+
+
Creates a DList from a List
+
+
listEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the List type.
+
+
listHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the List type.
+
+
listK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a List.
+
+
listK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a List.
+
+
listM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Lists.
+
+
listM() - Method in class fj.F2W
+
+
Promotes this function to a function on Lists.
+
+
listMonoid() - Static method in class fj.Monoid
+
+
A monoid for lists.
+
+
listOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the List type.
+
+
listSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for lists.
+
+
listSeq(List<A>) - Static method in class fj.data.Seq
+
+
Deprecated. +
As of release 4.5, use Seq.iterableSeq(java.lang.Iterable<A>)
+
+
+
listShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
log() - Method in class fj.data.Writer
+
 
+
Long_Boolean - Static variable in class fj.Primitive
+
+
A function that converts longs to booleans.
+
+
Long_Byte - Static variable in class fj.Primitive
+
+
A function that converts longs to bytes.
+
+
Long_Character - Static variable in class fj.Primitive
+
+
A function that converts longs to characters.
+
+
Long_Double - Static variable in class fj.Primitive
+
+
A function that converts longs to doubles.
+
+
Long_Float - Static variable in class fj.Primitive
+
+
A function that converts longs to floats.
+
+
Long_Integer - Static variable in class fj.Primitive
+
+
A function that converts longs to integers.
+
+
Long_Short - Static variable in class fj.Primitive
+
+
A function that converts longs to shorts.
+
+
longAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds longs.
+
+
longAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds longs.
+
+
longBitSet(long) - Static method in class fj.data.hamt.BitSet
+
 
+
longEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for long.
+
+
longEqual - Static variable in class fj.Equal
+
+
An equal instance for the long type.
+
+
longHash - Static variable in class fj.Hash
+
+
A hash instance for the long type.
+
+
longMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of longs.
+
+
longMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of longs.
+
+
longMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies longs.
+
+
longMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies longs.
+
+
longOrd - Static variable in class fj.Ord
+
+
An order instance for the long type.
+
+
Longs - Class in fj.function
+
+
Curried functions over Longs.
+
+
longShow - Static variable in class fj.Show
+
+
A show instance for the long type.
+
+
longValue() - Method in class fj.data.hamt.BitSet
+
 
+
longValue() - Method in class fj.data.Natural
+
+
Return the long value of this natural number.
+
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Deep
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Digit
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Empty
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.FingerTree
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Four
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node2
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node3
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.One
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Single
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Three
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Two
+
 
+
lookup(Equal<A>, List<P2<A, B>>, A) - Static method in class fj.data.List
+
+
Returns an associated value with the given key in the list of pairs.
+
+
lookup(Equal<A>) - Static method in class fj.data.List
+
+
Returns a partially applied version of List.lookup(Equal, List, Object).
+
+
lookup(A) - Method in class fj.data.Set
+
+
Find element equal to the given one.
+
+
lookupGE(A) - Method in class fj.data.Set
+
+
Find smallest element greater or equal to the given one.
+
+
lookupGT(A) - Method in class fj.data.Set
+
+
Find smallest element greater than the given one.
+
+
lookupLE(A) - Method in class fj.data.Set
+
+
Find largest element smaller or equal to the given one.
+
+
lookupLT(A) - Method in class fj.data.Set
+
+
Find largest element smaller than the given one.
+
+
lower(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lower(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lowSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lowSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than or equal to zero.
+
+
lteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than or equal to zero.
+
+
ltZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than zero.
+
+
ltZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than zero.
+
+
+ + + +

M

+
+
MakeTree<V,A> - Class in fj.data.fingertrees
+
+
A builder of trees and tree components, supplied with a particular monoid and measuring function.
+
+
map(F<A, B>) - Method in class fj.control.db.DB
+
+
Map a function over the result of this action.
+
+
map(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's domain (Invariant Functor pattern).
+
+
map(F<A, B>) - Method in class fj.control.Trampoline
+
+
Maps the given function across the result of this trampoline.
+
+
map(F<A, B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Maps the given function across this array.
+
+
map(F<A, B>) - Method in class fj.data.Array
+
+
Maps the given function across this array.
+
+
map() - Static method in class fj.data.Array
+
+
First-class map function for Arrays.
+
+
map(F<A, X>) - Method in class fj.data.Either.LeftProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<B, X>) - Method in class fj.data.Either.RightProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<A, B>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Deep
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Digit
+
+
Maps a function across the elements of this digit, measuring with the given measurement.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Empty
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Maps the given function across this tree, measuring with the given Measured instance.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Node
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Single
+
 
+
map(F<K, A>, F<V, B>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<K, A>, F<V, B>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>) - Method in class fj.data.HashMap
+
 
+
map(IO<A>, F<A, B>) - Static method in class fj.data.IOFunctions
+
 
+
map(F<A, B>) - Method in class fj.data.IOW
+
 
+
map(F<A, B>) - Method in class fj.data.IterableW
+
+
Maps a given function across the wrapped Iterable.
+
+
map() - Static method in class fj.data.IterableW
+
+
Returns a function that promotes any function so that it operates on Iterables.
+
+
map(F<Character, Character>) - Method in class fj.data.LazyString
+
 
+
map(F<A, B>) - Method in class fj.data.List
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.Option
+
+
Maps the given function across this optional value.
+
+
map() - Static method in class fj.data.Option
+
+
A first-class map function.
+
+
map(F<A, B>) - Method in class fj.data.PriorityQueue
+
+
Maps the values in each node with function f.
+
+
map(F<B, C>) - Method in class fj.data.Reader
+
 
+
map(F<A, B>) - Method in class fj.data.Seq
+
 
+
map(Ord<B>, F<A, B>) - Method in class fj.data.Set
+
+
Maps the given function across this set.
+
+
map(F<A, B>) - Method in class fj.data.State
+
 
+
map(F<A, B>) - Method in class fj.data.Stream
+
+
Maps the given function across this stream.
+
+
map(F<V, W>) - Method in class fj.data.TreeMap
+
+
Maps the given function across the values of this TreeMap.
+
+
map(F<A, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function across this zipper (covariant functor pattern).
+
+
map(F<E, A>) - Method in class fj.data.Validation.FailProjection
+
+
Maps the given function across the failing side of this validation.
+
+
map(F<T, A>) - Method in class fj.data.Validation
+
+
Maps the given function across the success side of this validation.
+
+
map(F<A, B>) - Method in class fj.data.vector.V2
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V3
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V4
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V5
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V6
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V7
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V8
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.Writer
+
 
+
map(F<A, B>) - Method in class fj.data.Zipper
+
+
Maps the given function across the elements of this zipper (covariant functor pattern).
+
+
map(F<A, B>, F<B, C>) - Static method in class fj.F1Functions
+
 
+
map(F<B, C>) - Method in class fj.F1W
+
 
+
map(F2<A, B, C>, F<C, Z>) - Static method in class fj.F2Functions
+
 
+
map(F<C, Z>) - Method in class fj.F2W
+
 
+
map(F<A, B>) - Method in class fj.P1
+
+
Map the element of the product.
+
+
map(F<A, B>, P2<A, A>) - Static method in class fj.P2
+
+
Maps the given function across both the elements of the given product.
+
+
map(F<A, B>) - Method in class fj.parser.Parser
+
+
Maps the given result type across this parser.
+
+
map1(F<A, X>) - Method in class fj.P2
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P3
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P4
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P5
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P6
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P7
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P8
+
+
Map the first element of the product.
+
+
map1_(F<A, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the first element of a product.
+
+
map2(F<B, X>) - Method in class fj.P2
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P3
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P4
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P5
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P6
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P7
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P8
+
+
Map the second element of the product.
+
+
map2_(F<B, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the second element of a product.
+
+
map3(F<C, X>) - Method in class fj.P3
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P4
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P5
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P6
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P7
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P8
+
+
Map the third element of the product.
+
+
map4(F<D, X>) - Method in class fj.P4
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P5
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P6
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P7
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P8
+
+
Map the fourth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P5
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P6
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P7
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P8
+
+
Map the fifth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P6
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P7
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P8
+
+
Map the sixth element of the product.
+
+
map7(F<G, X>) - Method in class fj.P7
+
+
Map the seventh element of the product.
+
+
map7(F<G, X>) - Method in class fj.P8
+
+
Map the seventh element of the product.
+
+
map8(F<H, X>) - Method in class fj.P8
+
+
Map the eighth element of the product.
+
+
map_() - Static method in class fj.control.Trampoline
+
 
+
map_() - Static method in class fj.data.List
+
+
Provides a first-class version of map()
+
+
map_() - Static method in class fj.data.Stream
+
+
Provides a first-class version of the map function.
+
+
map_(F<A, B>) - Static method in class fj.P1
+
+
Promote any function to a transformation between P1s.
+
+
mapArray(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Array.
+
+
mapArray() - Method in class fj.F1W
+
+
Promotes this function to map over a Array.
+
+
mapBoth(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over both elements of a pair.
+
+
mapBoth() - Method in class fj.F1W
+
+
Promotes this function to map over both elements of a pair.
+
+
mapError(F<E, K>) - Method in class fj.parser.Parser
+
+
Maps the given function across this parser's error.
+
+
mapFail(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the failure side of a Validation.
+
+
mapFail() - Method in class fj.F1W
+
+
Promotes this function to map over the failure side of a Validation.
+
+
mapFst(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the first element of a pair.
+
+
mapFst() - Method in class fj.F1W
+
+
Promotes this function to map over the first element of a pair.
+
+
mapIterable(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over Iterables.
+
+
mapIterable() - Method in class fj.F1W
+
+
Promotes this function to map over Iterables.
+
+
mapJ(F<A, B>, SynchronousQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a SynchronousQueue.
+
+
mapJ(F<A, B>, PriorityBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a PriorityBlockingQueue.
+
+
mapJ(F<A, B>, LinkedBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a LinkedBlockingQueue.
+
+
mapJ(F<A, B>, CopyOnWriteArraySet<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a CopyOnWriteArraySet.
+
+
mapJ(F<A, B>, CopyOnWriteArrayList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a CopyOnWriteArrayList.
+
+
mapJ(F<A, B>, ConcurrentLinkedQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a ConcurrentLinkedQueue.
+
+
mapJ(F<A, B>, ArrayBlockingQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over an ArrayBlockingQueue.
+
+
mapJ(F<A, B>, TreeSet<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a TreeSet.
+
+
mapJ(F<A, B>, PriorityQueue<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a PriorityQueue.
+
+
mapJ(F<A, B>, LinkedList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over a LinkedList.
+
+
mapJ(F<A, B>, ArrayList<A>) - Static method in class fj.F1Functions
+
+
Maps this function over an ArrayList.
+
+
mapJ(SynchronousQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a SynchronousQueue.
+
+
mapJ(PriorityBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a PriorityBlockingQueue.
+
+
mapJ(LinkedBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a LinkedBlockingQueue.
+
+
mapJ(CopyOnWriteArraySet<A>) - Method in class fj.F1W
+
+
Maps this function over a CopyOnWriteArraySet.
+
+
mapJ(CopyOnWriteArrayList<A>) - Method in class fj.F1W
+
+
Maps this function over a CopyOnWriteArrayList.
+
+
mapJ(ConcurrentLinkedQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a ConcurrentLinkedQueue.
+
+
mapJ(ArrayBlockingQueue<A>) - Method in class fj.F1W
+
+
Maps this function over an ArrayBlockingQueue.
+
+
mapJ(TreeSet<A>) - Method in class fj.F1W
+
+
Maps this function over a TreeSet.
+
+
mapJ(PriorityQueue<A>) - Method in class fj.F1W
+
+
Maps this function over a PriorityQueue.
+
+
mapJ(LinkedList<A>) - Method in class fj.F1W
+
+
Maps this function over a LinkedList.
+
+
mapJ(ArrayList<A>) - Method in class fj.F1W
+
+
Maps this function over an ArrayList.
+
+
mapKeys(F<K, A>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
mapKeys(F<K, A>) - Method in class fj.data.HashMap
+
 
+
mapLeft(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the left side of an Either.
+
+
mapLeft() - Method in class fj.F1W
+
+
Promotes this function to map over the left side of an Either.
+
+
mapList() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a List inside a promise.
+
+
mapList(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a List.
+
+
mapList() - Method in class fj.F1W
+
+
Promotes this function to map over a List.
+
+
mapM(List<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
+
+
mapM(Stream<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
+
+
mapM(P1<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Maps a concurrent function over a Product-1 inside a Promise.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.List
+
+
Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
+
+
mapMOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Option monad.
+
+
mapMTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Trampoline monad.
+
+
mapNel(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a NonEmptyList.
+
+
mapNel() - Method in class fj.F1W
+
+
Promotes this function to map over a NonEmptyList.
+
+
mapOption(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over an optional value.
+
+
mapOption() - Method in class fj.F1W
+
+
Promotes this function to map over an optional value.
+
+
mapP1(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a product-1.
+
+
mapP1() - Method in class fj.F1W
+
+
Promotes this function to map over a product-1.
+
+
mapPromise(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Promise.
+
+
mapPromise() - Method in class fj.F1W
+
+
Promotes this function to map over a Promise.
+
+
mapRest(F<I, J>) - Method in class fj.parser.Result
+
+
Maps the given function across the remainder of the parse input.
+
+
mapRest() - Method in class fj.parser.Result
+
+
First-class function mapping across the remainder of the parse input.
+
+
mapRight(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the right side of an Either.
+
+
mapRight() - Method in class fj.F1W
+
+
Promotes this function to map over the right side of an Either.
+
+
mapSet(F<A, B>, Ord<B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Set.
+
+
mapSet(Ord<B>) - Method in class fj.F1W
+
+
Promotes this function to map over a Set.
+
+
mapSnd(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the second element of a pair.
+
+
mapSnd() - Method in class fj.F1W
+
+
Promotes this function to map over the second element of a pair.
+
+
mapState(F<P2<S, A>, P2<S, B>>) - Method in class fj.data.State
+
 
+
mapStream() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a Stream inside a promise.
+
+
mapStream(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Stream.
+
+
mapStream() - Method in class fj.F1W
+
+
Promotes this function to map over a Stream.
+
+
mapSuccess(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over the success side of a Validation.
+
+
mapSuccess() - Method in class fj.F1W
+
+
Promotes this function to map over the success side of a Validation.
+
+
mapTails(F<NonEmptyList<A>, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across the tails of this list (comonad pattern).
+
+
mapTree(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Tree.
+
+
mapTree() - Method in class fj.F1W
+
+
Promotes this function to map over a Tree.
+
+
mapTreeZipper(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a TreeZipper.
+
+
mapTreeZipper() - Method in class fj.F1W
+
+
Promotes this function to map over a TreeZipper.
+
+
mapValue(F<A, B>) - Method in class fj.parser.Result
+
+
Maps the given function across the parse value.
+
+
mapValue() - Method in class fj.parser.Result
+
+
First-class function mapping across the parse value.
+
+
mapValues(F<V, B>) - Method in class fj.data.HashMap
+
 
+
mapZipper(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to map over a Zipper.
+
+
mapZipper() - Method in class fj.F1W
+
+
Promotes this function to map over a Zipper.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Deep
+
+
Pattern matching on the tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Digit
+
+
Structural pattern matching on digits.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Empty
+
+
Pattern matching on the structure of this tree.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Provides pattern matching on trees.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Four
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node2
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node3
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.One
+
 
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Single
+
+
Pattern matching on the structure of this tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Three
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Two
+
 
+
match(F<P2<K, V>, B>, F<HashArrayMappedTrie<K, V>, B>) - Method in class fj.data.hamt.Node
+
+
Performs a reduction on this Node using the given arguments.
+
+
matches(String) - Method in class fj.data.LazyString
+
+
Regular expression pattern matching.
+
+
matches - Static variable in class fj.function.Strings
+
+
A curried version of String.matches(String).
+
+
max() - Method in class fj.data.Enumerator
+
+
Returns the maximum value for this enumerator if there is one.
+
+
max() - Method in class fj.data.Set
+
 
+
max() - Method in class fj.data.TreeMap
+
+
Returns the maximum (key, value) pair in the tree if the tree is not empty.
+
+
max - Variable in class fj.Ord
+
+
A function that returns the greater of its two arguments.
+
+
max(A, A) - Method in class fj.Ord
+
+
Returns the greater of its two arguments.
+
+
MAX_BIT_INDEX - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_BIT_SIZE - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
maximum(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maximum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the maximum element in this non empty list according to the given ordering.
+
+
maximumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maxKey() - Method in class fj.data.TreeMap
+
+
Returns the maximum key in the tree if the tree is not empty.
+
+
maxMonoid(A) - Method in class fj.Ord
+
 
+
maxSemigroup() - Method in class fj.Ord
+
 
+
measure() - Method in class fj.data.fingertrees.Deep
+
+
Returns the sum of the measurements of this tree's elements, according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Digit
+
+
Returns the sum of the measurements of this digit according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Empty
+
+
Returns zero.
+
+
measure() - Method in class fj.data.fingertrees.FingerTree
+
+
Returns the sum of this tree's annotations.
+
+
measure() - Method in class fj.data.fingertrees.Measured
+
+
Returns the measuring function.
+
+
measure(A) - Method in class fj.data.fingertrees.Measured
+
+
Measures a given element.
+
+
measure() - Method in class fj.data.fingertrees.Node
+
 
+
measure() - Method in class fj.data.fingertrees.Single
+
+
Returns the annotation of this tree's single element.
+
+
measured() - Method in class fj.data.fingertrees.FingerTree
+
 
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Constructs a Measured instance for the element type, given a monoid and a measuring function.
+
+
Measured<V,A> - Class in fj.data.fingertrees
+
+
Determines how the elements of a tree are measured and how measures are summed.
+
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.Measured
+
 
+
member(A) - Method in class fj.data.Set
+
+
Checks if the given element is a member of this set.
+
+
member() - Static method in class fj.data.Set
+
+
First-class membership check.
+
+
memo() - Method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P1.weakMemo() instead.
+
+
+
memo(F<Unit, A>) - Static method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P.weakMemo(F0) instead.
+
+
+
memo(F0<A>) - Static method in class fj.P1
+
+
Deprecated. +
since 4.7. Use P.weakMemo(F0) instead.
+
+
+
memo() - Method in class fj.P2
+
+
Provides a memoising P2 that remembers its values.
+
+
memo() - Method in class fj.P3
+
+
Provides a memoising P3 that remembers its values.
+
+
memo() - Method in class fj.P4
+
+
Provides a memoising P4 that remembers its values.
+
+
memo() - Method in class fj.P5
+
+
Provides a memoising P5 that remembers its values.
+
+
memo() - Method in class fj.P6
+
+
Provides a memoising P6 that remembers its values.
+
+
memo() - Method in class fj.P7
+
+
Provides a memoising P7 that remembers its values.
+
+
memo() - Method in class fj.P8
+
+
Provides a memoising P8 that remembers its values.
+
+
mergeAll(List<Future<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Waits for every Future in a list to obtain a value, and collects those values in a list.
+
+
middle() - Method in class fj.data.fingertrees.Deep
+
+
Returns a finger tree of the inner nodes of this tree.
+
+
min() - Method in class fj.data.Enumerator
+
+
Returns the minimum value for this enumerator if there is one.
+
+
min() - Method in class fj.data.Set
+
 
+
min() - Method in class fj.data.TreeMap
+
+
Returns the minimum (key, value) pair in the tree if the tree is not empty.
+
+
min - Variable in class fj.Ord
+
+
A function that returns the lesser of its two arguments.
+
+
min(A, A) - Method in class fj.Ord
+
+
Returns the lesser of its two arguments.
+
+
MIN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
minimum(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minimum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the minimum element in this non empty list according to the given ordering.
+
+
minimumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minKey() - Method in class fj.data.TreeMap
+
+
Returns the minimum key in the tree if the tree is not empty.
+
+
minMonoid(A) - Method in class fj.Ord
+
 
+
minSemigroup() - Method in class fj.Ord
+
 
+
minus(Equal<A>, List<A>) - Method in class fj.data.List
+
+
Returns a new list of all the items in this list that do not appear in the given list.
+
+
minus(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that occur in the given set.
+
+
minus() - Static method in class fj.data.Set
+
+
A first class function for Set.minus(Set).
+
+
minus(Equal<A>, Stream<A>) - Method in class fj.data.Stream
+
+
Returns a new stream of all the items in this stream that do not appear in the given stream.
+
+
mirrored(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mirrored(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mkTree(Measured<V, A>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a builder of trees and tree components that annotates them using the given Measured instance.
+
+
mod - Static variable in class fj.data.Natural
+
+
A function that yields the remainder of division of its second argument by its first.
+
+
mod(Natural) - Method in class fj.data.Natural
+
+
Take the remainder of a natural number division.
+
+
mode(Ord<A>) - Method in class fj.data.List
+
+
Returns the most common element in this list.
+
+
modify(F<A, A>) - Method in class fj.data.optic.Lens
+
 
+
modify(F<A, A>) - Method in class fj.data.optic.Optional
+
 
+
modify(F<A, B>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens using a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PSetter
+
+
modify polymorphically the target of a PSetter with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with a function
+
+
modify(F<A, A>) - Method in class fj.data.optic.Setter
+
 
+
modify(F<S, S>) - Static method in class fj.data.State
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyLabel(F<A, A>) - Method in class fj.data.TreeZipper
+
+
Modifies the label at the current node with the given function.
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyOption(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function.
+
+
modifyOption(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function.
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTree(F<Tree<A>, Tree<A>>) - Method in class fj.data.TreeZipper
+
+
Modifies the current node with the given function.
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, A>>) - Method in class fj.data.optic.Traversal
+
 
+
monoid() - Method in class fj.data.fingertrees.Measured
+
+
Returns the monoid used to sum measures.
+
+
monoid() - Method in class fj.data.Writer
+
 
+
Monoid<A> - Class in fj
+
+
A monoid abstraction to be defined across types of the given type argument.
+
+
monoid(F<A, F<A, A>>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(F2<A, A, A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(Semigroup<A>, A) - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Monoid.monoidDef(Semigroup.Definition, Object) or Semigroup.monoid(Object) instead.
+
+
+
monoid(A) - Method in class fj.Semigroup
+
+
Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
+
+
Monoid.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Monoid: alternative minimal definition and overridable methods.
+
+
Monoid.Definition<A> - Interface in fj
+
+
Primitives functions of Monoid: minimal definition and overridable methods.
+
+
monoidDef(Monoid.Definition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Monoid.AltDefinition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Semigroup.Definition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
monoidDef(Semigroup.AltDefinition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
move(int) - Method in class fj.data.Zipper
+
+
Move the focus to the specified index.
+
+
move() - Static method in class fj.data.Zipper
+
+
A first-class version of the move function.
+
+
multiply - Static variable in class fj.data.Natural
+
+
A function that multiplies a natural number by another.
+
+
multiply(Natural) - Method in class fj.data.Natural
+
+
Multiply a natural number by another.
+
+
multiply - Static variable in class fj.function.BigIntegers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Doubles
+
+
Curried Double multiplication.
+
+
multiply - Static variable in class fj.function.Integers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Longs
+
+
Curried Long multiplication.
+
+
multiply(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply(int, A) - Method in class fj.Monoid
+
+
Returns a value summed n times (a + a + ...
+
+
multiply1p(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Ord.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Semigroup.Definition
+
 
+
multiply1p(int, A) - Method in class fj.Semigroup
+
+
Returns a value summed n + 1 times ( + a + a + ...
+
+
+ + + +

N

+
+
Natural - Class in fj.data
+
+
Represents a natural number (zero, one, two, etc.)
+
+
natural(BigInteger) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given BigInteger
+
+
natural(long) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given long
+
+
naturalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds natural numbers.
+
+
naturalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds natural numbers.
+
+
naturalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Natural
+
+
naturalEqual - Static variable in class fj.Equal
+
+
An equal instance for the Natural type.
+
+
naturalHash - Static variable in class fj.Hash
+
+
A hash instance for the Natural type.
+
+
naturalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of natural numbers.
+
+
naturalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of natural numbers.
+
+
naturalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies natural numbers.
+
+
naturalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies natural numbers.
+
+
naturalOrd - Static variable in class fj.Ord
+
+
An order instance for the Natural type.
+
+
naturalShow - Static variable in class fj.Show
+
+
A show instance for natural numbers.
+
+
negate - Static variable in class fj.function.BigIntegers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Doubles
+
+
Negation.
+
+
negate - Static variable in class fj.function.Integers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Longs
+
+
Negation.
+
+
nel(A, List<A>) - Static method in class fj.data.NonEmptyList
+
+
Return a non-empty list with the given head and tail.
+
+
nel(A, A...) - Static method in class fj.data.NonEmptyList
+
+
Constructs a non empty list from the given elements.
+
+
nel() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that puts an element into a non-empty list.
+
+
nel() - Method in class fj.data.Validation
+
+
Puts this validation's failing value in a non-empty list if there is one.
+
+
nelK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a NonEmptyList.
+
+
nelK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a NonEmptyList.
+
+
nelM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on non-empty lists.
+
+
nelM() - Method in class fj.F2W
+
+
Promotes this function to a function on non-empty lists.
+
+
next() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the next element in the list.
+
+
next_() - Static method in class fj.data.Zipper
+
+
First-class version of the next() function.
+
+
nextInt() - Method in class fj.LcgRng
+
 
+
nextInt() - Method in class fj.Rng
+
 
+
nextLong() - Method in class fj.LcgRng
+
 
+
nextLong() - Method in class fj.Rng
+
 
+
nextNatural() - Method in class fj.Rng
+
 
+
nif - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not if" (reverse nonimplication).
+
+
nil() - Static method in class fj.data.DList
+
+
A empty DList.
+
+
nil() - Static method in class fj.data.hlist.HList
+
+
Returns the empty list.
+
+
nil() - Static method in class fj.data.List
+
+
Returns an empty list.
+
+
nil() - Static method in class fj.data.List.Optic
+
+
Nil prism
+
+
nil() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nil_() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nimp - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not implies" (nonimplication).
+
+
Node<V,A> - Class in fj.data.fingertrees
+
+
An inner node of the 2-3 tree.
+
+
Node<K,V> - Class in fj.data.hamt
+
+
A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
+
+
Node(Either<P2<K, V>, HashArrayMappedTrie<K, V>>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(P2<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(HashArrayMappedTrie<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
node(A, P1<Stream<Tree<A>>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, Stream<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, List<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new n-ary given a root and a subforest of length n.
+
+
node() - Static method in class fj.data.Tree
+
+
First-class constructor of trees.
+
+
node2(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node.
+
+
node2(V2<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node
+
+
Node2<V,A> - Class in fj.data.fingertrees
+
+
A two-element inner tree node.
+
+
node3(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node.
+
+
node3(V3<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node
+
+
Node3<V,A> - Class in fj.data.fingertrees
+
+
A three-element inner tree node.
+
+
nodeMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for nodes.
+
+
nodeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
none() - Static method in class fj.data.Option
+
+
Constructs an optional value that has no value.
+
+
none() - Static method in class fj.data.Option.Optic
+
+
None prism
+
+
none_() - Static method in class fj.data.Option
+
 
+
NonEmptyList<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list with total head and tail.
+
+
nonEmptyListEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the NonEmptyList type.
+
+
nonEmptyListHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the NonEmptyList type.
+
+
nonEmptyListOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the NonEmptyList type.
+
+
nonEmptyListSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for non-empty lists.
+
+
nonEmptyListShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the NonEmptyList type.
+
+
nor - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not or".
+
+
normalise(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Normalises the given Callable by calling it and wrapping the result in a new Callable.
+
+
normalise() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the normalise function.
+
+
not() - Method in class fj.data.hamt.BitSet
+
 
+
not() - Method in class fj.Equal
+
+
An equal instance, which reverts equality for self
+
+
not - Static variable in class fj.function.Booleans
+
+
Logical negation.
+
+
not(F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
Negates the given predicate.
+
+
not(F0<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
not(E) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
notEq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are not equal, false otherwise.
+
+
now(A) - Static method in class fj.data.Eval
+
+
Constructs an eager evaluation by wrapping the given value.
+
+
nub() - Method in class fj.data.List
+
+
Removes duplicates according to object equality.
+
+
nub(Equal<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given equality.
+
+
nub(Ord<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given ordering.
+
+
nullable(F<A, B>) - Static method in class fj.Function
+
+
Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
+
+
nullablefindFirst(List<X>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value in the given list of optional values.
+
+
nullableVisitor(List<F<A, B>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
+
+
+ + + +

O

+
+
o(F<A, B>, F<C, A>) - Static method in class fj.F1Functions
+
+
Function composition
+
+
o(F<A, B>) - Static method in class fj.F1Functions
+
+
First-class function composition
+
+
o(F<C, A>) - Method in class fj.F1W
+
+
Function composition
+
+
o() - Method in class fj.F1W
+
+
First-class function composition
+
+
obtain() - Static method in class fj.control.parallel.Strategy
+
+
Returns a function which returns a product-1 which waits for the given Future to obtain a value.
+
+
obtain(Future<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a product-1 that waits for the given future to obtain a value.
+
+
on(F<B, A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<A, B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<T, E>) - Method in class fj.data.Validation.FailProjection
+
+
The failing value or the application of the given function to the success value.
+
+
on(F<E, T>) - Method in class fj.data.Validation
+
+
The success value or the application of the given function to the failing value.
+
+
on(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Begin definition of an equal instance.
+
+
on(F<A, B>, F<B, F<B, C>>) - Static method in class fj.F1Functions
+
+
Applies this function over the arguments of another function.
+
+
on(F<A, B>) - Static method in class fj.F1Functions
+
+
Applies this function over the arguments of another function.
+
+
on(F<B, F<B, C>>) - Method in class fj.F1W
+
+
Applies this function over the arguments of another function.
+
+
on() - Method in class fj.F1W
+
+
Applies this function over the arguments of another function.
+
+
on(F<A, F<A, C>>, F<B, A>) - Static method in class fj.Function
+
+
Applies a given function over the arguments of another function of arity-2.
+
+
on(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Begin definition of an ord instance.
+
+
one(A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of one element.
+
+
One<V,A> - Class in fj.data.fingertrees
+
+
A single-element prefix or suffix of a finger tree.
+
+
ONE - Static variable in class fj.data.Natural
+
+
The natural number one
+
+
onFail(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
+
+
onFail() - Method in class fj.F1W
+
+
Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
+
+
onLeft(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the left side of a given Either, or this function applied to the right side.
+
+
onLeft() - Method in class fj.F1W
+
+
Returns a function that returns the left side of a given Either, or this function applied to the right side.
+
+
onRight(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the right side of a given Either, or this function applied to the left side.
+
+
onRight() - Method in class fj.F1W
+
+
Returns a function that returns the right side of a given Either, or this function applied to the left side.
+
+
onSuccess(F<A, B>) - Static method in class fj.F1Functions
+
+
Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
+
+
onSuccess() - Method in class fj.F1W
+
+
Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
+
+
option(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into an optional value.
+
+
option() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an optional value.
+
+
Option<A> - Class in fj.data
+
+
An optional value that may be none (no value) or some (a value).
+
+
option(B, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
option(F0<B>, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
Option.Optic - Class in fj.data
+
 
+
option_(B, F<A, B>) - Static method in class fj.data.Option
+
+
First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
+
+
Option_Array() - Static method in class fj.data.Conversions
+
+
A function that converts options to arrays.
+
+
Option_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to array blocking queues.
+
+
Option_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to array lists.
+
+
Option_BitSet - Static variable in class fj.data.Java
+
+
A function that converts options to bit sets.
+
+
Option_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts options to concurrent linked queues.
+
+
Option_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array lists.
+
+
Option_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array sets.
+
+
Option_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts options to delay queues.
+
+
Option_Either() - Static method in class fj.data.Conversions
+
+
A function that converts options to eithers.
+
+
Option_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts options to enum sets.
+
+
Option_HashSet() - Static method in class fj.data.Java
+
+
A function that converts options to hash sets.
+
+
Option_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to linked blocking queues.
+
+
Option_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts options to linked hash sets.
+
+
Option_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts options to linked lists.
+
+
Option_List() - Static method in class fj.data.Conversions
+
+
A function that converts options to lists.
+
+
Option_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority blocking queues.
+
+
Option_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority queues.
+
+
Option_PriorityQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_PriorityQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_Stack() - Static method in class fj.data.Java
+
+
A function that converts options to stacks.
+
+
Option_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts options to streams.
+
+
Option_String - Static variable in class fj.data.Conversions
+
+
A function that converts options to strings.
+
+
Option_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts options to string buffers.
+
+
Option_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts options to string builders.
+
+
Option_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to synchronous queues.
+
+
Option_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts options to tree sets.
+
+
Option_Vector() - Static method in class fj.data.Java
+
+
A function that converts options to vectors.
+
+
Optional<S,A> - Class in fj.data.optic
+
+
POptional restricted to monomorphic update
+
+
Optional(POptional<S, S, A, A>) - Constructor for class fj.data.optic.Optional
+
 
+
optional(F<S, Option<A>>, F<A, F<S, S>>) - Static method in class fj.data.optic.Optional
+
 
+
optionEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Option type.
+
+
optionHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Option type.
+
+
optionK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in an Option.
+
+
optionK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in an Option.
+
+
optionM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Options.
+
+
optionM() - Method in class fj.F2W
+
+
Promotes this function to a function on Options.
+
+
optionMonoid(Semigroup<A>) - Static method in class fj.Monoid
+
+
Lift a Semigroup<A> for A to a Monoid<Option<A>>, using Option.none() as zero.
+
+
optionMonoid() - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Monoid.firstOptionMonoid().
+
+
+
optionOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Option type.
+
+
optionSemigroup() - Static method in class fj.Semigroup
+
+
Deprecated. +
since 4.7. Use Semigroup.firstOptionSemigroup().
+
+
+
optionShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Option type.
+
+
or(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
or - Static variable in class fj.function.Booleans
+
+
Curried form of logical "inclusive or" (disjunction).
+
+
or(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns composed predicate using disjunction
+
+
or(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given list is true.
+
+
or(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given stream is true.
+
+
or(F0<Parser<I, A, E>>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(F0<Parser<I, A, E>>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
orAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
orAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given Stream of predicates
+
+
ord() - Method in class fj.data.Set
+
+
Returns the order of this Set.
+
+
ord(Ord<A>) - Static method in class fj.data.Zipper
+
+
An Ord instance for Zippers.
+
+
Ord<A> - Class in fj
+
+
Tests for ordering between two objects.
+
+
ord() - Method in interface fj.Ord.Definition
+
+
Build an ord instance from this definition.
+
+
ord(F<A, F<A, Ordering>>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
ord(F2<A, A, Ordering>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
Ord.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Ord: alternative minimal definition and overridable methods.
+
+
Ord.Definition<A> - Interface in fj
+
+
Primitives functions of Ord: minimal definition and overridable methods.
+
+
ordDef(Ord.Definition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
ordDef(Ord.AltDefinition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
order() - Method in class fj.data.Enumerator
+
+
Returns the ordering for the enumerator.
+
+
Ordering - Enum in fj
+
+
The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
+
+
orderingEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Ordering.
+
+
orderingOrd - Static variable in class fj.Ord
+
+
An order instance for the Ordering type.
+
+
ordMaxMonoid(Ord<A>, A) - Static method in class fj.Monoid
+
+
Deprecated. +
since 4.7. Use Ord.maxMonoid(Object)
+
+
+
orElse(F0<Option<A>>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orElse(Option<A>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orFail(F0<E>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orFail(E) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orHead(F0<A>) - Method in class fj.data.List
+
+
Returns the head of this list if there is one or the given argument if this list is empty.
+
+
orHead(F0<A>) - Method in class fj.data.Stream
+
+
Returns the head of this stream if there is one or the given argument if this stream is empty.
+
+
orSome(F0<A>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSome(A) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSuccess(F0<T>) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orSuccess(T) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orTail(F0<List<A>>) - Method in class fj.data.List
+
+
Returns the tail of this list if there is one or the given argument if this list is empty.
+
+
orTail(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Returns the tail of this stream if there is one or the given argument if this stream is empty.
+
+
orValue(F0<A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(A) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(F0<B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the given argument.
+
+
+ + + +

P

+
+
p(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
p() - Method in class fj.data.TreeZipper
+
+
Returns the product-4 representation of this zipper.
+
+
p(P2<A, A>) - Static method in class fj.data.vector.V2
+
+
Creates a vector-2 from a homogeneous product-2.
+
+
p() - Method in class fj.data.vector.V2
+
+
Returns a homogeneous product-2 equivalent to this vector.
+
+
p(P3<A, A, A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a homogeneous product-3.
+
+
p() - Method in class fj.data.vector.V3
+
+
Returns a homogeneous product-3 equivalent to this vector.
+
+
p(P4<A, A, A, A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a homogeneous product-4.
+
+
p() - Method in class fj.data.vector.V4
+
+
Returns a homogeneous product-4 equivalent to this vector.
+
+
p(P5<A, A, A, A, A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a homogeneous product-5.
+
+
p() - Method in class fj.data.vector.V5
+
+
Returns a homogeneous product-5 equivalent to this vector.
+
+
p(P6<A, A, A, A, A, A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a homogeneous product-6.
+
+
p() - Method in class fj.data.vector.V6
+
+
Returns a homogeneous product-6 equivalent to this vector.
+
+
p(P7<A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a homogeneous product-7.
+
+
p() - Method in class fj.data.vector.V7
+
+
Returns a homogeneous product-7 equivalent to this vector.
+
+
p(P8<A, A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a homogeneous product-8.
+
+
p() - Method in class fj.data.vector.V8
+
+
Returns a homogeneous product-8 equivalent to this vector.
+
+
p() - Method in class fj.data.Zipper
+
+
Returns the product-3 representation of this Zipper.
+
+
P - Class in fj
+
+
Functions across products.
+
+
p(A) - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
p(A, B) - Static method in class fj.P
+
+
A function that puts elements in a product-2.
+
+
p(A, B, C) - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
p(A, B, C, D) - Static method in class fj.P
+
+
A function that puts elements in a product-4.
+
+
p(A, B, C, D, E) - Static method in class fj.P
+
+
A function that puts elements in a product-5.
+
+
p(A, B, C, D, E, F$) - Static method in class fj.P
+
+
A function that puts elements in a product-6.
+
+
p(A, B, C, D, E, F$, G) - Static method in class fj.P
+
+
A function that puts elements in a product-7.
+
+
p(A, B, C, D, E, F$, G, H) - Static method in class fj.P
+
+
A function that puts elements in a product-8.
+
+
p1() - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
P1<A> - Class in fj
+
 
+
P1() - Constructor for class fj.P1
+
 
+
P1_Callable() - Static method in class fj.data.Java
+
 
+
p1Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a product-1.
+
+
p1Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a product-1.
+
+
p1Ord(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for a product-1.
+
+
p1Semigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for unary products.
+
+
p1Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for the tuple-1 type.
+
+
p1ShowEager(Show<A>) - Static method in class fj.Show
+
 
+
p1ShowLazy(Show<A>) - Static method in class fj.Show
+
 
+
p2() - Static method in class fj.P
+
+
A function that puts an element in a product-2.
+
+
P2<A,B> - Class in fj
+
+
A product-2.
+
+
P2() - Constructor for class fj.P2
+
 
+
P2.Optic - Class in fj
+
+
Optic factory methods for a P2
+
+
p2Equal(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for a product-2.
+
+
p2Hash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for a product-2.
+
+
p2MapShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type in the style of a mapping from A to B.
+
+
p2Node(P2<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
p2Ord(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for a product-2, with the first factor considered most significant.
+
+
p2Ord1(Ord<A>) - Static method in class fj.Ord
+
 
+
p2Ord2(Ord<B>) - Static method in class fj.Ord
+
 
+
p2Semigroup(Semigroup<A>, Semigroup<B>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for binary products.
+
+
p2Show(Show<A>, Show<B>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p2Show(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p3() - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
P3<A,B,C> - Class in fj
+
+
A product-3.
+
+
P3() - Constructor for class fj.P3
+
 
+
p3Equal(Equal<A>, Equal<B>, Equal<C>) - Static method in class fj.Equal
+
+
An equal instance for a product-3.
+
+
p3Hash(Hash<A>, Hash<B>, Hash<C>) - Static method in class fj.Hash
+
+
A hash instance for a product-3.
+
+
p3Ord(Ord<A>, Ord<B>, Ord<C>) - Static method in class fj.Ord
+
+
An order instance for a product-3, with the first factor considered most significant.
+
+
p3Show(Show<A>, Show<B>, Show<C>) - Static method in class fj.Show
+
+
A show instance for the tuple-3 type.
+
+
p4() - Static method in class fj.P
+
+
A function that puts an element in a product-4.
+
+
P4<A,B,C,D> - Class in fj
+
+
A product-4.
+
+
P4() - Constructor for class fj.P4
+
 
+
p4Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>) - Static method in class fj.Equal
+
+
An equal instance for a product-4.
+
+
p4Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>) - Static method in class fj.Hash
+
+
A hash instance for a product-4.
+
+
p4Show(Show<A>, Show<B>, Show<C>, Show<D>) - Static method in class fj.Show
+
+
A show instance for the tuple-4 type.
+
+
p5() - Static method in class fj.P
+
+
A function that puts an element in a product-5.
+
+
P5<A,B,C,D,E> - Class in fj
+
+
A product-5.
+
+
P5() - Constructor for class fj.P5
+
 
+
p5Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>) - Static method in class fj.Equal
+
+
An equal instance for a product-5.
+
+
p5Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>) - Static method in class fj.Hash
+
+
A hash instance for a product-5.
+
+
p5Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>) - Static method in class fj.Show
+
+
A show instance for the tuple-5 type.
+
+
p6() - Static method in class fj.P
+
+
A function that puts an element in a product-6.
+
+
P6<A,B,C,D,E,F> - Class in fj
+
+
A product-6.
+
+
P6() - Constructor for class fj.P6
+
 
+
p6Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>) - Static method in class fj.Equal
+
+
An equal instance for a product-6.
+
+
p6Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>) - Static method in class fj.Hash
+
+
A hash instance for a product-6.
+
+
p6Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>) - Static method in class fj.Show
+
+
A show instance for the tuple-6 type.
+
+
p7() - Static method in class fj.P
+
+
A function that puts an element in a product-7.
+
+
P7<A,B,C,D,E,F,G> - Class in fj
+
+
A product-7.
+
+
P7() - Constructor for class fj.P7
+
 
+
p7Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>) - Static method in class fj.Equal
+
+
An equal instance for a product-7.
+
+
p7Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>) - Static method in class fj.Hash
+
+
A hash instance for a product-7.
+
+
p7Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>) - Static method in class fj.Show
+
+
A show instance for the tuple-7 type.
+
+
p8() - Static method in class fj.P
+
+
A function that puts an element in a product-8.
+
+
P8<A,B,C,D,E,F,G,H> - Class in fj
+
+
A product-8.
+
+
P8() - Constructor for class fj.P8
+
 
+
p8Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>, Equal<H>) - Static method in class fj.Equal
+
+
An equal instance for a product-8.
+
+
p8Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>, Hash<H>) - Static method in class fj.Hash
+
+
A hash instance for a product-8.
+
+
p8Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>, Show<H>) - Static method in class fj.Show
+
+
A show instance for the tuple-8 type.
+
+
p_() - Static method in class fj.data.TreeZipper
+
+
A first-class function that returns the product-4 representation of a given zipper.
+
+
p_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to the equivalent product-2.
+
+
p_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to the equivalent product-3.
+
+
p_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to the equivalent product-4.
+
+
p_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to the equivalent product-5.
+
+
p_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to the equivalent product-6.
+
+
p_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to the equivalent product-7.
+
+
p_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to the equivalent product-8.
+
+
p_() - Static method in class fj.data.Zipper
+
+
A first-class function that yields the product-3 representation of a given Zipper.
+
+
par(P1<A>) - Method in class fj.control.parallel.Strategy
+
+
Apply the strategy to the given product-1.
+
+
parent() - Method in class fj.data.TreeZipper
+
+
Navigates to the parent of the current location.
+
+
parents() - Method in class fj.data.TreeZipper
+
+
Returns the parents of the currently focused node.
+
+
parExtend(Zipper<A>, F<Zipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given zipper in parallel.
+
+
parExtend(Tree<A>, F<Tree<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all subtrees of the given Tree in parallel.
+
+
parExtend(TreeZipper<A>, F<TreeZipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given TreeZipper in parallel.
+
+
parExtend(NonEmptyList<A>, F<NonEmptyList<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all sublists of the given NonEmptyList in parallel.
+
+
parFlatMap(List<A>, F<A, List<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a list-valued function across a list in parallel, concatenating the results into a new list.
+
+
parFlatMap(Stream<A>, F<A, Stream<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
+
+
parFlatMap(Array<A>, F<A, Array<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
+
+
parFlatMap(Iterable<A>, F<A, Iterable<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
+
+
parFlatMap(Strategy<List<B>>, F<A, List<B>>, List<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given list, using the given strategy, with a final join.
+
+
parFlatMap(Strategy<Array<B>>, F<A, Array<B>>, Array<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given array, using the given strategy, with a final join.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>, F<Stream<A>, P2<Stream<A>, Stream<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>, F<Iterable<A>, P2<Iterable<A>, Iterable<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
+
+
parList(List<P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Evaluates a list of product-1s in parallel.
+
+
parListChunk(Strategy<List<A>>, int, List<P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Sequentially evaluates chunks (sub-sequences) of a list in parallel.
+
+
parMap(List<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a list in parallel.
+
+
parMap(NonEmptyList<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a nonempty list in parallel.
+
+
parMap(Stream<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a Stream in parallel.
+
+
parMap(Iterable<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Iterable in parallel.
+
+
parMap(Array<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Array in parallel.
+
+
parMap(Zipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Zipper in parallel.
+
+
parMap(Tree<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Tree in parallel.
+
+
parMap(TreeZipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a TreeZipper in parallel.
+
+
parMap(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given list in parallel using this strategy.
+
+
parMap(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given array in parallel using this strategy.
+
+
parMap1(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over lists.
+
+
parMap1(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over arrays.
+
+
parMapArray() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an array in parallel.
+
+
parMapArray(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on arrays using this strategy.
+
+
parMapArray() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on arrays.
+
+
parMapArray1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on arrays (parallel array functor).
+
+
parMapIterable() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an iterable in parallel.
+
+
parMapList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a list in parallel.
+
+
parMapList(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on lists using this strategy.
+
+
parMapList() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on lists.
+
+
parMapList1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on lists (parallel list functor).
+
+
parMapStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a stream in parallel.
+
+
parMapTree() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps across a Tree in parallel.
+
+
ParModule - Class in fj.control.parallel
+
+
A module of higher-order concurrency features.
+
+
parModule(Strategy<Unit>) - Static method in class fj.control.parallel.ParModule
+
+
Constructor method for ParModule
+
+
parse(I) - Method in class fj.parser.Parser
+
+
Parses the input to produce a result or error.
+
+
parseByte - Static variable in class fj.data.Option
+
+
A function that parses a string to a byte.
+
+
parseByte - Static variable in class fj.data.Validation
+
+
A function that parses a string into a byte.
+
+
parseByte(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a byte.
+
+
parseDouble - Static variable in class fj.data.Option
+
+
A function that parses a string to a double.
+
+
parseDouble - Static variable in class fj.data.Validation
+
+
A function that parses a string into a double.
+
+
parseDouble(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a double.
+
+
parseFloat - Static variable in class fj.data.Option
+
+
A function that parses a string to a float.
+
+
parseFloat - Static variable in class fj.data.Validation
+
+
A function that parses a string into a float.
+
+
parseFloat(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a float.
+
+
parseInt - Static variable in class fj.data.Option
+
+
A function that parses a string to an integer.
+
+
parseInt - Static variable in class fj.data.Validation
+
+
A function that parses a string into an integer.
+
+
parseInt(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a integer.
+
+
parseLong - Static variable in class fj.data.Option
+
+
A function that parses a string to a long.
+
+
parseLong - Static variable in class fj.data.Validation
+
+
A function that parses a string into a long.
+
+
parseLong(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a long.
+
+
Parser<I,A,E> - Class in fj.parser
+
+
A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
+
+
parser(F<I, Validation<E, Result<I, A>>>) - Static method in class fj.parser.Parser
+
+
Returns a parser that computes using the given function.
+
+
Parser.CharsParser - Class in fj.parser
+
+
Parsers that accept Stream<Character> input.
+
+
Parser.StreamParser - Class in fj.parser
+
+
Parsers that accept Stream input.
+
+
parseShort - Static variable in class fj.data.Option
+
+
A function that parses a string to a short.
+
+
parseShort - Static variable in class fj.data.Validation
+
+
A function that parses a string into a short.
+
+
parseShort(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a short.
+
+
partialApply2(F<A, F<B, C>>, B) - Static method in class fj.Function
+
+
Partial application of the second argument to the supplied function to get a function of type + A -> C.
+
+
partialApply3(F<A, F<B, F<C, D>>>, C) - Static method in class fj.Function
+
+
Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
+
+
partialApply4(F<A, F<B, F<C, F<D, E>>>>, D) - Static method in class fj.Function
+
+
Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
+
+
partialApply5(F<A, F<B, F<C, F<D, F<E, F$>>>>>, E) - Static method in class fj.Function
+
+
Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
+
+
partialApply6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>, F$) - Static method in class fj.Function
+
+
Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
+
+
partialApply7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>, G) - Static method in class fj.Function
+
+
Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
+
+
partialApply8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>, H) - Static method in class fj.Function
+
+
Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
+
+
partition(int) - Method in class fj.data.List
+
+
Splits this list into lists of the given size.
+
+
partition(F<A, Boolean>) - Method in class fj.data.List
+
+
Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
+
+
partition(List<Validation<A, B>>) - Static method in class fj.data.Validation
+
+
Partitions the list into the list of fails and the list of successes
+
+
parZipArrayWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
+
+
parZipListWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
+
+
parZipWith(List<A>, List<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two lists together with a given function, in parallel.
+
+
parZipWith(Stream<A>, Stream<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two streams together with a given function, in parallel.
+
+
parZipWith(Array<A>, Array<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two arrays together with a given function, in parallel.
+
+
parZipWith(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two iterables together with a given function, in parallel.
+
+
parZipWith(F2<B, C, A>, List<B>, List<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two lists in parallel using a given function, with this strategy.
+
+
parZipWith(F2<B, C, A>, Array<B>, Array<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two arrays in parallel using a given function, with this strategy.
+
+
pCodiagonal() - Static method in class fj.data.optic.PSetter
+
 
+
pCodiagonal() - Static method in class fj.data.optic.PTraversal
+
 
+
peek() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that returns the first element of the input
+
+
pId() - Static method in class fj.data.optic.PIso
+
+
create a PIso between any type and itself.
+
+
pId() - Static method in class fj.data.optic.PLens
+
 
+
pId() - Static method in class fj.data.optic.POptional
+
 
+
pId() - Static method in class fj.data.optic.PPrism
+
 
+
pId() - Static method in class fj.data.optic.PSetter
+
 
+
pId() - Static method in class fj.data.optic.PTraversal
+
 
+
PIso<S,T,A,B> - Class in fj.data.optic
+
+
A PIso defines an isomorphism between types S, A and B, T:
+
+
pIso(F<S, A>, F<B, T>) - Static method in class fj.data.optic.PIso
+
+
create a PIso using a pair of functions: one to get the target and one to get the source.
+
+
PLens<S,T,A,B> - Class in fj.data.optic
+
+
A PLens can be seen as a pair of functions: + get: S => A i.e.
+
+
pLens(F<S, A>, F<B, F<S, T>>) - Static method in class fj.data.optic.PLens
+
+
create a PLens using a pair of functions: one to get the target, one to set the target.
+
+
plus() - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(long) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A, long) - Method in class fj.data.Enumerator
+
+
Moves a value along the enumerator a given number of times.
+
+
POptional<S,T,A,B> - Class in fj.data.optic
+
+
A POptional can be seen as a pair of functions: + getOrModify: S => T \/ A + set : (B, S) => T +
+
+
pOptional(F<S, Either<T, A>>, F<B, F<S, T>>) - Static method in class fj.data.optic.POptional
+
+
create a POptional using the canonical functions: getOrModify and set
+
+
positions() - Method in class fj.data.TreeZipper
+
+
Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern).
+
+
positions() - Method in class fj.data.Zipper
+
+
Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
+
+
power - Static variable in class fj.function.BigIntegers
+
+
Power.
+
+
power - Static variable in class fj.function.Doubles
+
+
Power.
+
+
power - Static variable in class fj.function.Integers
+
+
Power.
+
+
PPrism<S,T,A,B> - Class in fj.data.optic
+
+
A PPrism can be seen as a pair of functions: + getOrModify: S => T \/ A + reverseGet : B => T +
+
+
pPrism(F<S, Either<T, A>>, F<B, T>) - Static method in class fj.data.optic.PPrism
+
+
create a PPrism using the canonical functions: getOrModify and reverseGet
+
+
pred() - Method in class fj.data.Natural
+
+
Return the predecessor of this natural number
+
+
pred_() - Static method in class fj.data.Natural
+
+
First-class predecessor function.
+
+
predecessor() - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator in curried form.
+
+
predecessor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator.
+
+
prefix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the first few elements of this tree.
+
+
prepend(A) - Method in interface fj.Monoid.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.Definition
+
 
+
prepend(A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Semigroup.Definition
+
 
+
prependToList(List<A>) - Method in class fj.data.List.Buffer
+
+
Prepends the elements of this buffer to the given list.
+
+
previous() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the previous element in the list.
+
+
previous_() - Static method in class fj.data.Zipper
+
+
First-class version of the previous() function.
+
+
Primitive - Class in fj
+
+
Functions that convert between Java primitive types.
+
+
print(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream.
+
+
println(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream with a new line.
+
+
printlnE(A) - Method in class fj.Show
+
+
Prints the given argument to the standard error stream with a new line.
+
+
PriorityBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority blocking queues to lists.
+
+
PriorityQueue<K,A> - Class in fj.data
+
+
A priority queue implementation backed by a + FingerTree.
+
+
priorityQueue(Equal<K>, FingerTree<K, P2<K, A>>) - Static method in class fj.data.PriorityQueue
+
+
Creates a priority queue from a finger tree.
+
+
PriorityQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority queues to lists.
+
+
priorityQueueShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
Prism<S,A> - Class in fj.data.optic
+
+
PPrism restricted to monomorphic update
+
+
Prism(PPrism<S, S, A, A>) - Constructor for class fj.data.optic.Prism
+
 
+
prism(F<S, Option<A>>, F<A, S>) - Static method in class fj.data.optic.Prism
+
 
+
product(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a stream of natural numbers.
+
+
product(List<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a list of natural numbers.
+
+
product(Getter<S1, A1>) - Method in class fj.data.optic.Getter
+
+
pair two disjoint Getter
+
+
product(Iso<S1, A1>) - Method in class fj.data.optic.Iso
+
+
pair two disjoint Iso
+
+
product(PIso<S1, T1, A1, B1>) - Method in class fj.data.optic.PIso
+
+
pair two disjoint PIso
+
+
product(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Returns the product of a list of big integers.
+
+
product(List<Double>) - Static method in class fj.function.Doubles
+
+
Returns the product of a list of doubles.
+
+
product(List<Integer>) - Static method in class fj.function.Integers
+
+
Returns the product of a list of integers.
+
+
promise() - Method in class fj.control.parallel.Actor
+
+
Transforms this actor to an actor on promises.
+
+
promise(P1<A>) - Method in class fj.control.parallel.ParModule
+
+
Evaluates the given product concurrently and returns a Promise of the result.
+
+
promise() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that evaluates a given product concurrently and returns a Promise of the result.
+
+
promise(F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
promise(F2<A, B, C>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
Promise<A> - Class in fj.control.parallel
+
+
Represents a non-blocking future value.
+
+
promise(Strategy<Unit>, P1<A>) - Static method in class fj.control.parallel.Promise
+
+
Promises to provide the value of the given 1-product, in the future.
+
+
promise(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
Provides a first-class unit function for promises.
+
+
promise(Strategy<Unit>, Callable<A>) - Static method in class fj.control.parallel.Promise
+
+
Provides a promise to call the given Callable in the future.
+
+
promise(Strategy<Unit>, F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Transforms any function so that it returns a promise of a value instead of an actual value.
+
+
promiseK(F<A, B>, Strategy<Unit>) - Static method in class fj.F1Functions
+
+
Promotes this function to a concurrent function that returns a Promise of a value.
+
+
promiseK(Strategy<Unit>) - Method in class fj.F1W
+
+
Promotes this function to a concurrent function that returns a Promise of a value.
+
+
promiseM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Promises.
+
+
promiseM() - Method in class fj.F2W
+
+
Promotes this function to a function on Promises.
+
+
promisePure() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that promotes a given function to a concurrent function that returns a Promise.
+
+
PSetter<S,T,A,B> - Class in fj.data.optic
+
+
A PSetter is a generalisation of Functor map: + map: (A => B) => F[A] => F[B] + modify: (A => B) => S => T +
+
+
pSetter(F<F<A, B>, F<S, T>>) - Static method in class fj.data.optic.PSetter
+
 
+
pSome() - Static method in class fj.data.Option.Optic
+
+
Polymorphic Some prism
+
+
pTraversal() - Static method in class fj.data.List.Optic
+
+
Polymorphic traversal
+
+
PTraversal<S,T,A,B> - Class in fj.data.optic
+
+
A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
+
+
PTraversal() - Constructor for class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F3<B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F4<B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<B, B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pure() - Static method in class fj.control.Trampoline
+
 
+
pure(A) - Static method in class fj.control.Trampoline
+
+
Constructs a pure computation that results in the given value.
+
+
put(S) - Static method in class fj.data.State
+
 
+
+ + + +

Q

+
+
queueActor(Strategy<Unit>, Effect1<T>) - Static method in class fj.control.parallel.Actor
+
+
An Actor equipped with a queue and which is guaranteed to process one message at a time.
+
+
+ + + +

R

+
+
range(int, int) - Static method in class fj.data.Array
+
+
Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, int) - Method in class fj.data.hamt.BitSet
+
+
Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g.
+
+
range(int, int) - Static method in class fj.data.List
+
+
Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, long) - Static method in class fj.data.Stream
+
+
Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(Enumerator<A>, A, A) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
+
+
range(Enumerator<A>, A, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
+
+
range(int) - Static method in class fj.data.Stream
+
+
Returns an infinite stream of integers from the given from value (inclusive).
+
+
range(int, int) - Method in class fj.Rng
+
 
+
re() - Method in class fj.data.optic.PPrism
+
+
create a Getter from the modified target to the modified source of a PPrism
+
+
reader(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state reader given a connection URL.
+
+
reader(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new reader that reads the database via the given Connector.
+
+
Reader<A,B> - Class in fj.data
+
+
The Reader monad (also called the function monad, so equivalent to the idea of F).
+
+
Reader(F<A, B>) - Constructor for class fj.data.Reader
+
 
+
readerState() - Static method in class fj.data.IOFunctions
+
 
+
reduce(Either<A, A>) - Static method in class fj.data.Either
+
+
Takes an Either to its contained value within left or right.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
remainder - Static variable in class fj.function.BigIntegers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Doubles
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Integers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Longs
+
+
Remainder.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
+
+
repeat(A) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given element.
+
+
repeat() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser zero or many times.
+
+
repeat1() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser one or many times.
+
+
replace(F<A, Boolean>, A) - Method in class fj.data.Stream
+
+
Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
+
+
replace(A) - Method in class fj.data.Zipper
+
+
Replaces the element in focus with the given element.
+
+
replicate(int, A) - Static method in class fj.data.List
+
+
Returns a list of the given value replicated the given number of times.
+
+
replicateM(IO<A>, int) - Static method in class fj.data.IOFunctions
+
 
+
rest() - Method in class fj.parser.Result
+
+
The remainder of the parse input.
+
+
Result<I,A> - Class in fj.parser
+
+
A parse result made up of a value (A) and the remainder of the parse input (I).
+
+
result(I, A) - Static method in class fj.parser.Result
+
+
Construct a result with the given remainder of the parse input and parse value.
+
+
result() - Static method in class fj.parser.Result
+
+
First-class construction of a result.
+
+
resultEqual(Equal<A>, Equal<I>) - Static method in class fj.Equal
+
 
+
resultHash(Hash<A>, Hash<I>) - Static method in class fj.Hash
+
+
A hash instance for the Result type.
+
+
resultShow(Show<A>, Show<I>) - Static method in class fj.Show
+
+
A show instance for the Result type.
+
+
resume() - Method in class fj.control.Trampoline
+
+
Runs a single step of this computation.
+
+
resume_() - Static method in class fj.control.Trampoline
+
 
+
reverse() - Method in class fj.data.Array.ImmutableProjection
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.Array
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.LazyString
+
+
Returns the reverse of this string.
+
+
reverse() - Method in class fj.data.List
+
+
Reverse this list in constant stack space.
+
+
reverse() - Method in class fj.data.NonEmptyList
+
+
Reverse this non empty list in constant stack space.
+
+
reverse() - Method in class fj.data.optic.Iso
+
 
+
reverse() - Method in class fj.data.optic.PIso
+
+
reverse a PIso: the source becomes the target and the target becomes the source
+
+
reverse() - Method in class fj.data.Stream
+
+
Reverse this stream in constant stack space.
+
+
reverse() - Method in class fj.Ord
+
 
+
reverse() - Method in enum fj.Ordering
+
 
+
reverseBytes - Static variable in class fj.function.Characters
+
 
+
reverseGet(A) - Method in class fj.data.optic.Iso
+
 
+
reverseGet(B) - Method in class fj.data.optic.PIso
+
+
get the modified source of a PIso
+
+
reverseGet(B) - Method in class fj.data.optic.PPrism
+
+
get the modified source of a PPrism
+
+
reverseGet(A) - Method in class fj.data.optic.Prism
+
 
+
right() - Method in class fj.data.Either
+
+
Projects this either as a right.
+
+
right(B) - Static method in class fj.data.Either
+
+
Construct a right value of either.
+
+
right() - Method in class fj.data.TreeZipper
+
+
Navigates to the right sibling of the current location.
+
+
right_() - Static method in class fj.data.Either
+
+
A function that constructs a right value of either.
+
+
right_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the right() function.
+
+
rightMap_() - Static method in class fj.data.Either
+
 
+
rights(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the right values in the given list.
+
+
rights() - Method in class fj.data.TreeZipper
+
+
Returns the right siblings of the currently focused node.
+
+
rights() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the right of focus.
+
+
Rng - Class in fj
+
+
Created by MarkPerry on 7/07/2014.
+
+
Rng() - Constructor for class fj.Rng
+
 
+
root() - Method in class fj.data.Tree
+
+
Returns the root element of the tree.
+
+
root() - Method in class fj.data.TreeZipper
+
+
Navigates to the top-most parent of the current location.
+
+
root_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its root.
+
+
root_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the root function.
+
+
run(Connection) - Method in class fj.control.db.DB
+
+
Executes the database action, given a database connection.
+
+
run(DB<A>) - Method in class fj.control.db.DbState
+
+
Runs the given database action as a single transaction.
+
+
run() - Method in class fj.control.Trampoline
+
+
Runs this computation all the way to the end, in constant stack.
+
+
run() - Method in class fj.data.DList
+
+
Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
+
+
run() - Method in interface fj.data.IO
+
 
+
run() - Method in class fj.data.IOW
+
 
+
run() - Method in class fj.data.Iteratee.IterV
+
 
+
run() - Method in interface fj.data.SafeIO
+
 
+
run(S) - Method in class fj.data.State
+
 
+
run() - Method in class fj.data.Writer
+
 
+
runSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Run io, rethrowing any IOException wrapped in a RuntimeException
+
+
+ + + +

S

+
+
safe() - Method in class fj.data.IOW
+
 
+
SafeIO<A> - Interface in fj.data
+
+
Created by MarkPerry on 3/07/2014.
+
+
satisfy(F0<E>, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
satisfy(E, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
scanLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a fold left accummulating and returns an array of the intermediate results.
+
+
scanLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating and returns an array of the intermediate results.
+
+
scanLeft1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanLeft1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
second() - Method in class fj.data.optic.Getter
+
 
+
second() - Method in class fj.data.optic.Iso
+
 
+
second() - Method in class fj.data.optic.Optional
+
 
+
second() - Method in class fj.data.optic.PIso
+
 
+
second() - Method in class fj.data.optic.POptional
+
 
+
semigroup() - Method in class fj.Monoid
+
+
Returns a semigroup projection of this monoid.
+
+
Semigroup<A> - Class in fj
+
+
Implementations must satisfy the law of associativity: + + Associativity; forall x.
+
+
semigroup(F<A, F<A, A>>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
semigroup(F2<A, A, A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
Semigroup.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Semigroup: alternative minimal definition and overridable methods.
+
+
Semigroup.Definition<A> - Interface in fj
+
+
Primitives functions of Semigroup: minimal definition and overridable methods.
+
+
semigroupDef(Semigroup.Definition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
semigroupDef(Semigroup.AltDefinition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
Seq<A> - Class in fj.data
+
+
Provides an immutable finite sequence, implemented as a finger tree.
+
+
seq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given elements.
+
+
seq(List<A>) - Static method in class fj.data.Seq
+
+
Deprecated. +
As of release 4.5, use Seq.listSeq(List)
+
+
+
seqEqual(Equal<A>) - Static method in class fj.Equal
+
 
+
seqHash(Hash<A>) - Static method in class fj.Hash
+
 
+
seqShow(Show<A>) - Static method in class fj.Show
+
 
+
seqStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
+
+
sequence(List<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a List of Callables into a single Callable of a List.
+
+
sequence(List<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
List iteration inside a Promise.
+
+
sequence(Stream<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Stream iteration inside a Promise.
+
+
sequence(P1<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Traverses a product-1 inside a promise.
+
+
sequence(Strategy<Unit>, List<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a List of promises into a single promise of a List.
+
+
sequence(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a List.
+
+
sequence(Strategy<Unit>, Stream<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a Stream of promises into a single promise of a Stream.
+
+
sequence(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Transforms a product of a promise to a promise of a product.
+
+
sequence(Array<B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Array<B>) - Method in class fj.data.Array
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Either<X, B>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
sequence(Either<A, X>) - Method in class fj.data.Either.RightProjection
+
+
Anonymous bind through this projection.
+
+
sequence(List<IO<A>>) - Static method in class fj.data.IOFunctions
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
sequence(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
+
+
sequence(List<B>) - Method in class fj.data.List
+
+
Performs a bind across each list element, but ignores the element value each time.
+
+
sequence(Option<B>) - Method in class fj.data.Option
+
+
Performs a bind across the optional value, but ignores the element value in the function.
+
+
sequence(List<Option<A>>) - Static method in class fj.data.Option
+
+
Sequence through the option monad.
+
+
sequence(List<State<S, A>>) - Static method in class fj.data.State
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<B>) - Method in class fj.data.Stream
+
+
Performs a bind across each stream element, but ignores the element value each time.
+
+
sequence(IO<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Option<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Validation<A, T>) - Method in class fj.data.Validation.FailProjection
+
+
Performs a bind across the validation, but ignores the element value in the function.
+
+
sequence(Validation<E, A>) - Method in class fj.data.Validation
+
+
Anonymous bind through this validation.
+
+
sequence(Semigroup<E>, List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
+
+
sequence(List<P1<A>>) - Static method in class fj.P1
+
+
Turns a List of P1s into a single P1 of a List.
+
+
sequence(Stream<P1<A>>) - Static method in class fj.P1
+
+
Turns a stream of P1s into a single P1 of a stream.
+
+
sequence(Option<P1<A>>) - Static method in class fj.P1
+
+
Turns an optional P1 into a lazy option.
+
+
sequence(Array<P1<A>>) - Static method in class fj.P1
+
+
Turns an array of P1s into a single P1 of an array.
+
+
sequence(Parser<I, B, E>) - Method in class fj.parser.Parser
+
+
Binds anonymously, ignoring the result value.
+
+
sequence(List<Parser<I, A, E>>) - Static method in class fj.parser.Parser
+
+
Sequence the list of parsers through Parser.bind(fj.F<A, fj.parser.Parser<I, B, E>>).
+
+
sequence_() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the sequence method.
+
+
sequence_(List<F<B, A>>) - Static method in class fj.data.List
+
+
Turn a list of functions into a function returning a list.
+
+
sequence_(Stream<F<B, A>>) - Static method in class fj.data.Stream
+
+
Turn a stream of functions into a function returning a stream.
+
+
sequenceLeft(List<Either<A, X>>) - Static method in class fj.data.Either
+
+
Sequences through the left side of the either monad with a list of values.
+
+
sequenceList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a list inside a promise.
+
+
sequenceList() - Static method in class fj.P1
+
+
A first-class version of the sequence method for lists of P1s.
+
+
sequenceNonCumulative(List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values.
+
+
sequenceRight(List<Either<X, B>>) - Static method in class fj.data.Either
+
+
Sequences through the right side of the either monad with a list of values.
+
+
sequenceS(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a Stream.
+
+
sequenceStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a stream inside a promise.
+
+
sequenceW(Stream<F<Promise<A>, B>>) - Method in class fj.control.parallel.Promise
+
+
Applies a stream of comonadic functions to this promise, returning a stream of values.
+
+
sequenceW(Stream<F<Stream<A>, B>>) - Method in class fj.data.Stream
+
+
Applies a stream of comonadic functions to this stream, returning a stream of values.
+
+
sequenceW(List<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a list of comonadic functions to this product, returning a list of values.
+
+
sequenceW(Stream<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a stream of comonadic functions to this product, returning a stream of values.
+
+
sequenceWhile(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
sequenceWhileEager(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
set(int, A) - Method in class fj.data.Array
+
+
Sets the element at the given index to the given value.
+
+
set(int) - Method in class fj.data.hamt.BitSet
+
 
+
set(int, boolean) - Method in class fj.data.hamt.BitSet
+
 
+
set(K, V) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the key-value pair (k, v) to the trie.
+
+
set(List<P2<K, V>>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the product of key-value (k, v) pairs to the trie.
+
+
set(K, V) - Method in class fj.data.HashMap
+
+
Inserts the given key and value association into the hash map.
+
+
set(A) - Method in class fj.data.HashSet
+
+
Insert the given element into this hash set.
+
+
set(A) - Method in class fj.data.optic.Lens
+
 
+
set(A) - Method in class fj.data.optic.Optional
+
 
+
set(B) - Method in class fj.data.optic.PIso
+
+
set polymorphically the target of a PIso with a value
+
+
set(B) - Method in class fj.data.optic.PLens
+
+
set polymorphically the target of a PLens using a function
+
+
set(B) - Method in class fj.data.optic.POptional
+
+
get the modified source of a POptional
+
+
set(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value
+
+
set(B) - Method in class fj.data.optic.PSetter
+
+
set polymorphically the target of a PSetter with a value
+
+
set(B) - Method in class fj.data.optic.PTraversal
+
+
set polymorphically the target of a PTraversal with a value
+
+
set(A) - Method in class fj.data.optic.Setter
+
 
+
Set<A> - Class in fj.data
+
+
Provides an in-memory, immutable set, implemented as a red/black tree.
+
+
set(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Constructs a set from the given elements.
+
+
set(Ord<A>, List<A>) - Static method in class fj.data.Set
+
+
Deprecated. +
As of release 4.5, use Set.iterableSet(fj.Ord<A>, java.lang.Iterable<A>)
+
+
+
set(K, V) - Method in class fj.data.TreeMap
+
+
Inserts the given key and value association into the tree map.
+
+
setEqual(Equal<A>) - Static method in class fj.Equal
+
+
Equal instance for sets.
+
+
setHash(Hash<A>) - Static method in class fj.Hash
+
 
+
setK(F<A, B>, Ord<B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Set.
+
+
setK(Ord<B>) - Method in class fj.F1W
+
+
Promotes this function to return its value in a Set.
+
+
setLabel(A) - Method in class fj.data.TreeZipper
+
+
Replaces the label of the current node with the given value.
+
+
setM(F2<A, B, C>, Ord<C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Sets.
+
+
setM(Ord<C>) - Method in class fj.F2W
+
+
Promotes this function to a function on Sets.
+
+
setMax(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given maximum value.
+
+
setMin(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given minimum value.
+
+
setMonoid(Ord<A>) - Static method in class fj.Monoid
+
+
A monoid for sets.
+
+
setOption(B) - Method in class fj.data.optic.POptional
+
+
set polymorphically the target of a POptional with a value.
+
+
setOption(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value.
+
+
setOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Set type.
+
+
setSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for sets.
+
+
setShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Set type.
+
+
Setter<S,A> - Class in fj.data.optic
+
+
PSetter with a monomorphic modify function
+
+
Setter(PSetter<S, S, A, A>) - Constructor for class fj.data.optic.Setter
+
 
+
setter(F<F<A, A>, F<S, S>>) - Static method in class fj.data.optic.Setter
+
+
alias for PSetter constructor with a monomorphic modify function
+
+
setTree(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Replaces the current node with the given tree.
+
+
shiftLeft(int) - Method in class fj.data.hamt.BitSet
+
 
+
shiftRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
Short_Boolean - Static variable in class fj.Primitive
+
+
A function that converts shorts to booleans.
+
+
Short_Byte - Static variable in class fj.Primitive
+
+
A function that converts shorts to bytes.
+
+
Short_Character - Static variable in class fj.Primitive
+
+
A function that converts shorts to characters.
+
+
Short_Double - Static variable in class fj.Primitive
+
+
A function that converts shorts to doubles.
+
+
Short_Float - Static variable in class fj.Primitive
+
+
A function that converts shorts to floats.
+
+
Short_Integer - Static variable in class fj.Primitive
+
+
A function that converts shorts to integers.
+
+
Short_Long - Static variable in class fj.Primitive
+
+
A function that converts shorts to longs.
+
+
shortEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for short.
+
+
shortEqual - Static variable in class fj.Equal
+
+
An equal instance for the short type.
+
+
shortHash - Static variable in class fj.Hash
+
+
A hash instance for the short type.
+
+
shortOrd - Static variable in class fj.Ord
+
+
An order instance for the short type.
+
+
shortShow - Static variable in class fj.Show
+
+
A show instance for the short type.
+
+
show() - Method in class fj.data.hlist.HPre.HNat
+
 
+
show() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
show() - Method in class fj.data.hlist.HPre.HZero
+
 
+
show(Show<A>) - Static method in class fj.data.TreeZipper
+
+
A Show instance for tree zippers.
+
+
show(Show<A>) - Static method in class fj.data.Zipper
+
+
A Show instance for Zippers.
+
+
Show<A> - Class in fj
+
+
Renders an object for display.
+
+
show(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
show(F<A, Stream<Character>>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
show2D(Show<A>) - Static method in class fj.data.Tree
+
+
Provides a show instance that draws a 2-dimensional representation of a tree.
+
+
show_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
showl(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
showS(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument as a String.
+
+
showS(F<A, String>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
showS_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
simpleThreadStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
+
+
single(A) - Static method in class fj.data.Array
+
+
Constructs a singleton array.
+
+
single(A) - Static method in class fj.data.DList
+
+
Produces a DList with one element.
+
+
single(A) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a singleton tree.
+
+
Single<V,A> - Class in fj.data.fingertrees
+
+
A tree with a single element.
+
+
single(E) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of a single element.
+
+
single(A) - Static method in class fj.data.List
+
+
Returns a list of one element containing the given value.
+
+
single(A) - Static method in class fj.data.Seq
+
+
A singleton sequence.
+
+
single(Ord<A>, A) - Static method in class fj.data.Set
+
+
Returns a set with a single element.
+
+
single(A) - Static method in class fj.data.Stream
+
+
Returns a stream of one element containing the given value.
+
+
single() - Static method in class fj.data.Stream
+
+
Returns a function that yields a stream containing its argument.
+
+
single(A) - Static method in class fj.data.Zipper
+
+
Creates a new zipper with a single element.
+
+
SIZE - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
size() - Method in class fj.data.HashMap
+
+
Returns the number of entries in this hash map.
+
+
size() - Method in class fj.data.HashSet
+
+
Returns the number of entries in this hash set.
+
+
size() - Method in class fj.data.Set
+
+
Returns the size of this set.
+
+
size() - Method in class fj.data.TreeMap
+
+
Returns the number of entries in this tree map.
+
+
snoc(A) - Method in class fj.data.DList
+
+
Appends a single element on the end of the DList to produce a new DList.
+
+
snoc(A) - Method in class fj.data.fingertrees.Deep
+
 
+
snoc(A) - Method in class fj.data.fingertrees.Empty
+
 
+
snoc(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the last element.
+
+
snoc(A) - Method in class fj.data.fingertrees.Single
+
 
+
snoc(A) - Method in class fj.data.List.Buffer
+
+
Appends (snoc) the given element to this buffer to produce a new buffer.
+
+
snoc(A) - Method in class fj.data.List
+
+
Appends (snoc) the given element to this list to produce a new list.
+
+
snoc(A) - Method in class fj.data.NonEmptyList
+
+
Appends (snoc) the given element to this non empty list to produce a new non empty list.
+
+
snoc(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the end of this sequence.
+
+
snoc(A) - Method in class fj.data.Stream
+
+
Append the given element to this stream to product a new stream.
+
+
snoc(F0<A>) - Method in class fj.data.Stream
+
+
Append the given element to this stream to produce a new stream.
+
+
softMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
+
+
softMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a SoftReference
+
+
some() - Static method in class fj.data.Option.Optic
+
+
Monomorphic Some prism
+
+
some() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or fails if there is no value.
+
+
some(T) - Static method in class fj.data.Option
+
+
Constructs an optional value that has a value of the given argument.
+
+
some_() - Static method in class fj.data.Option
+
 
+
somes(List<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given list.
+
+
somes(Stream<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given stream.
+
+
sort(Ord<A>) - Method in class fj.data.List
+
+
Sorts this list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Sorts this non empty list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering.
+
+
sort(Ord<A>, Strategy<Unit>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
+
+
space(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
space(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
span(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
+
+
span(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
+
+
split(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
+
+
split(F<Character, Boolean>) - Method in class fj.data.LazyString
+
+
Splits this lazy string by characters matching the given predicate.
+
+
split(char) - Method in class fj.data.LazyString
+
+
Splits this lazy string by the given delimiter character.
+
+
split(int) - Method in class fj.data.Seq
+
+
Splits this sequence into a pair of sequences at the given position.
+
+
split(A) - Method in class fj.data.Set
+
+
Splits this set at the given element.
+
+
split(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
+
+
split(Ord<V>, K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
split(F<A, C>, F<B, D>) - Method in class fj.P2
+
+
Split this product between two argument functions and combine their output.
+
+
split1(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Like split, but returns the element where pred first holds separately.
+
+
split_(F<A, C>, F<B, D>) - Static method in class fj.P2
+
+
A first-class version of the split function.
+
+
splitAt(int) - Method in class fj.data.List
+
+
Splits this list into two lists at the given index.
+
+
splitLookup(K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
Stack_List() - Static method in class fj.data.Java
+
+
A function that converts stacks to lists.
+
+
startsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a prefix of this lazy string.
+
+
startsWith() - Static method in class fj.data.LazyString
+
+
First-class prefix check.
+
+
State<S,A> - Class in fj.data
+
+
Created by MarkPerry on 7/07/2014.
+
+
stdinBufferedReader - Static variable in class fj.data.IOFunctions
+
 
+
stdinReadLine() - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrint(String) - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrintln(String) - Static method in class fj.data.IOFunctions
+
 
+
str(String) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a String.
+
+
Strategy<A> - Class in fj.control.parallel
+
+
Functional-style parallel evaluation strategies.
+
+
strategy(F<P1<A>, P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Constructs a strategy from the given evaluation function.
+
+
Stream<A> - Class in fj.data
+
+
A lazy (not yet evaluated), immutable, singly linked list.
+
+
stream(B, F<A, F<P1<Stream<A>>, B>>) - Method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.uncons(B, fj.F<A, fj.F<fj.P1<fj.data.Stream<A>>, B>>)
+
+
+
stream(A...) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements.
+
+
stream(Iterable<A>) - Static method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.iterableStream(Iterable)
+
+
+
stream(Iterator<A>) - Static method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.5, use Stream.iteratorStream(Iterator)
+
+
+
Stream_Array() - Static method in class fj.data.Conversions
+
+
A function that converts streams to arrays.
+
+
Stream_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to array blocking queues.
+
+
Stream_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to array lists.
+
+
Stream_BitSet - Static variable in class fj.data.Java
+
+
A function that converts streams to bit sets.
+
+
Stream_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to concurrent linked queues.
+
+
Stream_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array lists.
+
+
Stream_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array sets.
+
+
Stream_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to delay queues.
+
+
Stream_Either() - Static method in class fj.data.Conversions
+
+
A function that converts streams to eithers.
+
+
Stream_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts streams to enum sets.
+
+
Stream_HashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to hash sets.
+
+
Stream_Iterable() - Static method in class fj.data.Java
+
+
A function that converts streams to iterable.
+
+
Stream_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to linked blocking queues.
+
+
Stream_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to linked hash sets.
+
+
Stream_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts streams to linked lists.
+
+
Stream_List() - Static method in class fj.data.Conversions
+
+
A function that converts streams to lists.
+
+
Stream_Option() - Static method in class fj.data.Conversions
+
+
A function that converts streams to options.
+
+
Stream_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority blocking queues.
+
+
Stream_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority queues.
+
+
Stream_Stack() - Static method in class fj.data.Java
+
+
A function that converts streams to stacks.
+
+
Stream_String - Static variable in class fj.data.Conversions
+
+
A function that converts streams to strings.
+
+
Stream_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string buffers.
+
+
Stream_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string builders.
+
+
Stream_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to synchronous queues.
+
+
Stream_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts streams to tree sets.
+
+
Stream_Vector() - Static method in class fj.data.Java
+
+
A function that converts streams to vectors.
+
+
streamBitSet(Stream<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
streamEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Stream type.
+
+
streamHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Stream type.
+
+
streamK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result in a Stream.
+
+
streamK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result in a Stream.
+
+
streamM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Streams.
+
+
streamM() - Method in class fj.F2W
+
+
Promotes this function to a function on Streams.
+
+
streamMonoid() - Static method in class fj.Monoid
+
+
A monoid for streams.
+
+
streamOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Stream type.
+
+
streamSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for streams.
+
+
streamShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow(Show<A>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow_(Show<A>, String, String, String) - Static method in class fj.Show
+
+
Returns the transformation equivalent for the stream show.
+
+
string(F0<E>, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
string(E, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
String_Array - Static variable in class fj.data.Conversions
+
+
A function that converts strings to arrays.
+
+
String_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to array blocking queues.
+
+
String_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to array lists.
+
+
String_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to concurrent linked queues.
+
+
String_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array lists.
+
+
String_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array sets.
+
+
String_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string to eithers.
+
+
String_HashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to hash sets.
+
+
String_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to linked blocking queues.
+
+
String_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to linked hash sets.
+
+
String_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts strings to linked lists.
+
+
String_List - Static variable in class fj.data.Conversions
+
+
A function that converts strings to lists.
+
+
String_Option - Static variable in class fj.data.Conversions
+
+
A function that converts strings to options.
+
+
String_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority blocking queues.
+
+
String_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority queues.
+
+
String_Stack - Static variable in class fj.data.Java
+
+
A function that converts strings to stacks.
+
+
String_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts strings to streams.
+
+
String_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string buffers.
+
+
String_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string builders.
+
+
String_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to synchronous queues.
+
+
String_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts strings to tree sets.
+
+
String_Vector - Static variable in class fj.data.Java
+
+
A function that converts strings to vectors.
+
+
stringBitSet(String) - Static method in class fj.data.hamt.BitSet
+
 
+
StringBuffer_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to arrays.
+
+
StringBuffer_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to array blocking queues.
+
+
StringBuffer_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to array lists.
+
+
StringBuffer_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to concurrent linked queues.
+
+
StringBuffer_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array lists.
+
+
StringBuffer_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array sets.
+
+
StringBuffer_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string buffers to eithers.
+
+
StringBuffer_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to hash sets.
+
+
StringBuffer_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked blocking queues.
+
+
StringBuffer_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked hash sets.
+
+
StringBuffer_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked lists.
+
+
StringBuffer_List - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to lists.
+
+
StringBuffer_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to options.
+
+
StringBuffer_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority blocking queues.
+
+
StringBuffer_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority queues.
+
+
StringBuffer_Stack - Static variable in class fj.data.Java
+
+
A function that converts string buffers to stacks.
+
+
StringBuffer_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to streams.
+
+
StringBuffer_String - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to strings.
+
+
StringBuffer_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to string builders.
+
+
StringBuffer_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to synchronous queues.
+
+
StringBuffer_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to tree sets.
+
+
StringBuffer_Vector - Static variable in class fj.data.Java
+
+
A function that converts string buffers to vectors.
+
+
stringBufferEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuffer type.
+
+
stringBufferHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuffer type.
+
+
stringBufferMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string buffers.
+
+
stringBufferOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBufferSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string buffers.
+
+
stringBufferShow - Static variable in class fj.Show
+
+
A show instance for the StringBuffer type.
+
+
StringBuilder_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to arrays.
+
+
StringBuilder_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to array blocking queues.
+
+
StringBuilder_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to array lists.
+
+
StringBuilder_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to concurrent linked queues.
+
+
StringBuilder_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array lists.
+
+
StringBuilder_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array sets.
+
+
StringBuilder_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string builders to eithers.
+
+
StringBuilder_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to hash sets.
+
+
StringBuilder_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked blocking queues.
+
+
StringBuilder_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked hash sets.
+
+
StringBuilder_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked lists.
+
+
StringBuilder_List - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to lists.
+
+
StringBuilder_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to options.
+
+
StringBuilder_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority blocking queues.
+
+
StringBuilder_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority queues.
+
+
StringBuilder_Stack - Static variable in class fj.data.Java
+
+
A function that converts string builders to stacks.
+
+
StringBuilder_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to streams.
+
+
StringBuilder_String - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to strings.
+
+
StringBuilder_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to string buffers.
+
+
StringBuilder_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to synchronous queues.
+
+
StringBuilder_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to tree sets.
+
+
StringBuilder_Vector - Static variable in class fj.data.Java
+
+
A function that converts string builders to vectors.
+
+
stringBuilderEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuilder type.
+
+
stringBuilderHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuilder type.
+
+
stringBuilderMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string builders.
+
+
stringBuilderOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBuilderSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string builders.
+
+
stringBuilderShow - Static variable in class fj.Show
+
+
A show instance for the StringBuilder type.
+
+
stringEqual - Static variable in class fj.Equal
+
+
An equal instance for the String type.
+
+
stringHash - Static variable in class fj.Hash
+
+
A hash instance for the String type.
+
+
stringLogger() - Static method in class fj.data.Writer
+
 
+
stringMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends strings.
+
+
stringOrd - Static variable in class fj.Ord
+
+
An order instance for the String type.
+
+
Strings - Class in fj.function
+
+
Curried string functions.
+
+
stringSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends strings.
+
+
stringShow - Static variable in class fj.Show
+
+
A show instance for the String type.
+
+
subForest() - Method in class fj.data.Tree
+
+
Returns a stream of the tree's subtrees.
+
+
subForest_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its subforest.
+
+
sublists() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the sublists of this list.
+
+
subSequence(int, int) - Method in class fj.data.LazyString
+
+
Gets the specified subsequence of this lazy string.
+
+
subsetOf(Set<A>) - Method in class fj.data.Set
+
+
Returns true if this set is a subset of the given set.
+
+
substreams() - Method in class fj.data.Stream
+
+
Returns a stream of all infixes of this stream.
+
+
subtract - Static variable in class fj.data.Natural
+
+
A function that subtracts its first argument from its second.
+
+
subtract(Natural) - Method in class fj.data.Natural
+
+
Subtract a natural number from another.
+
+
subtract - Static variable in class fj.function.BigIntegers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Doubles
+
+
Curried Double subtraction.
+
+
subtract - Static variable in class fj.function.Integers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Longs
+
+
Curried Long subtraction.
+
+
succ() - Method in class fj.data.Natural
+
+
Return the successor of this natural number
+
+
succ_() - Static method in class fj.data.Natural
+
+
First-class successor function.
+
+
success() - Method in class fj.data.Validation
+
+
Returns the success value, or throws an error if there is no success value.
+
+
success(T) - Static method in class fj.data.Validation
+
+
Returns a succeeding validation containing the given value.
+
+
successE(F0<String>) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successE(String) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successes(List<Validation<?, A>>) - Static method in class fj.data.Validation
+
 
+
successK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function so that it returns its result on the success side of an Validation.
+
+
successK() - Method in class fj.F1W
+
+
Promotes this function so that it returns its result on the success side of an Validation.
+
+
successor() - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator in curried form.
+
+
successor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator.
+
+
suffix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the last few elements of this tree.
+
+
sum(V, V) - Method in class fj.data.fingertrees.Measured
+
+
Sums the given measurements with the monoid.
+
+
sum() - Method in class fj.data.hlist.HPre.HAdd
+
 
+
sum(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Sums a stream of natural numbers.
+
+
sum(List<Natural>) - Static method in class fj.data.Natural
+
+
Sums a list of natural numbers.
+
+
sum(Fold<S1, A>) - Method in class fj.data.optic.Fold
+
+
join two Fold with the same target
+
+
sum(Getter<S1, A>) - Method in class fj.data.optic.Getter
+
+
join two Getter with the same target
+
+
sum(Lens<S1, A>) - Method in class fj.data.optic.Lens
+
+
join two Lens with the same target
+
+
sum(Optional<S1, A>) - Method in class fj.data.optic.Optional
+
+
join two Optional with the same target
+
+
sum(PLens<S1, T1, A, B>) - Method in class fj.data.optic.PLens
+
+
join two PLens with the same target
+
+
sum(POptional<S1, T1, A, B>) - Method in class fj.data.optic.POptional
+
+
join two POptional with the same target
+
+
sum(PSetter<S1, T1, A, B>) - Method in class fj.data.optic.PSetter
+
+
join two PSetter with the same target
+
+
sum(PTraversal<S1, T1, A, B>) - Method in class fj.data.optic.PTraversal
+
+
join two PTraversal with the same target
+
+
sum(Setter<S1, A>) - Method in class fj.data.optic.Setter
+
+
join two Setter with the same target
+
+
sum(Traversal<S1, A>) - Method in class fj.data.optic.Traversal
+
+
join two Traversal with the same target
+
+
sum(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Sums a list of big integers.
+
+
sum(List<Double>) - Static method in class fj.function.Doubles
+
+
Sums a list of doubles.
+
+
sum(List<Integer>) - Static method in class fj.function.Integers
+
+
Sums a list of integers.
+
+
sum(F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, A) - Method in class fj.Monoid
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Monoid
+
+
Returns a function that sums the given value according to this monoid.
+
+
sum() - Method in class fj.Monoid
+
+
Returns a function that sums according to this monoid.
+
+
sum(A, F0<Stream<A>>) - Method in interface fj.Semigroup.Definition
+
 
+
sum(A, A) - Method in class fj.Semigroup
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Semigroup
+
+
Returns a function that sums the given value according to this semigroup.
+
+
sum() - Method in class fj.Semigroup
+
+
Returns a function that sums according to this semigroup.
+
+
sumLeft(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumLeftS() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumNel(NonEmptyList<A>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold.
+
+
sumRight(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with right-fold.
+
+
sumStream(A, F0<Stream<A>>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold, shortcutting the computation as early as possible.
+
+
superclassParameters() - Method in class fj.Class
+
+
Provides this class's superclass type parameter information as a Tree of the type expression.
+
+
suspend(F0<Trampoline<A>>) - Static method in class fj.control.Trampoline
+
+
Suspends the given computation in a thunk.
+
+
suspend(P1<Trampoline<A>>) - Static method in class fj.control.Trampoline
+
+
Suspends the given computation in a thunk.
+
+
suspend_() - Static method in class fj.control.Trampoline
+
 
+
swap() - Method in class fj.data.Either
+
+
If this is a left, then return the left value in right, or vice versa.
+
+
swap() - Method in class fj.P2
+
+
Swaps the elements around in this product.
+
+
swap_() - Static method in class fj.P2
+
+
Returns a curried form of P2.swap().
+
+
SynchronousQueue_List() - Static method in class fj.data.Java
+
+
A function that converts synchronous queues to lists.
+
+
+ + + +

T

+
+
tail() - Method in class fj.data.fingertrees.Deep
+
 
+
tail() - Method in class fj.data.fingertrees.Empty
+
 
+
tail() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the first element.
+
+
tail() - Method in class fj.data.fingertrees.Single
+
 
+
tail() - Method in class fj.data.hlist.HList.HCons
+
 
+
tail() - Method in class fj.data.LazyString
+
+
Returns all but the first character of this string.
+
+
tail() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons tail.
+
+
tail() - Method in class fj.data.List
+
+
The list without the first element or fails for the empty list.
+
+
tail() - Method in class fj.data.NonEmptyList
+
+
This list without the first element.
+
+
tail() - Method in class fj.data.Seq
+
+
The sequence without the first element.
+
+
tail() - Method in class fj.data.Stream
+
+
The stream without the first element or fails for the empty stream.
+
+
tail() - Method in class fj.data.vector.V3
+
+
Returns all but the first element of this vector, as a vector-2.
+
+
tail() - Method in class fj.data.vector.V4
+
+
Returns all but the first element of this vector, as a vector-3.
+
+
tail() - Method in class fj.data.vector.V5
+
+
Returns all but the first element of this vector, as a vector-4.
+
+
tail() - Method in class fj.data.vector.V6
+
+
Returns all but the first element of this vector, as a vector-5.
+
+
tail() - Method in class fj.data.vector.V7
+
+
Returns all but the first element of this vector, as a vector-6.
+
+
tail() - Method in class fj.data.vector.V8
+
+
Returns all but the first element of this vector, as a vector-7.
+
+
tail_() - Static method in class fj.data.List
+
+
First-class tail function.
+
+
tailOption() - Method in class fj.data.List
+
+
Reutrns the tail of the list, if any.
+
+
tails() - Method in class fj.data.List
+
+
Returns the list of final segments of this list, longest first.
+
+
tails() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the tails of this list.
+
+
tails() - Method in class fj.data.Stream
+
+
Returns a stream of the suffixes of this stream.
+
+
take(int) - Method in class fj.data.List
+
+
Takes the given number of elements from the head of this list if they are available.
+
+
take() - Static method in class fj.data.List
+
+
Provides a first-class version of take.
+
+
take(int) - Method in class fj.data.Seq
+
+
Takes the given number of elements from the head of this sequence if they are available.
+
+
take(int) - Method in class fj.data.Stream
+
+
Returns the first n elements from the head of this stream.
+
+
takeLower(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeUpper(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns the first elements of the head of this list that match the given predicate function.
+
+
takeWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the first elements of the head of this stream that match the given predicate function.
+
+
tell(W) - Method in class fj.data.Writer
+
 
+
then(F<A, B>, Equal<B>) - Method in interface fj.Equal.Definition
+
+
Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
+
+
then(F<A, B>, Ord<B>) - Method in interface fj.Ord.Definition
+
+
Refine this ord definition: compares using self and if objects are equal compares using given Ord.
+
+
three(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of three elements.
+
+
Three<V,A> - Class in fj.data.fingertrees
+
+
A three-element prefix or suffix of a finger tree.
+
+
titleCase(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
titleCase(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
to(Actor<A>) - Method in class fj.control.parallel.Promise
+
+
Promises to send a value to the given actor in the future.
+
+
toArray() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.HashMap
+
 
+
toArray() - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray(Class<A[]>) - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray() - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray() - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element array if this is a failing value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.Validation
+
+
Returns a single element array if this is a success value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.vector.V2
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V3
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V4
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V5
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V6
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V7
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V8
+
+
Returns an array with the elements of this vector.
+
+
toArrayObject() - Method in class fj.data.List
+
 
+
toBoolean(char) - Static method in class fj.data.hamt.BitSet
+
 
+
toBoolean(int) - Static method in class fj.data.hamt.BitSet
+
 
+
toChar - Static variable in enum fj.Digit
+
+
First-class conversion from a digit to a character.
+
+
toChar() - Method in enum fj.Digit
+
+
Converts this digit to a character.
+
+
toCollection() - Method in class fj.data.Array.ImmutableProjection
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Array
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Either.LeftProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.Either.RightProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.HashMap
+
+
Projects an immutable collection of this hash map.
+
+
toCollection() - Method in class fj.data.HashSet
+
+
Projects an immutable collection of this hash set.
+
+
toCollection() - Method in class fj.data.List.Buffer
+
+
Projects an immutable collection of this buffer.
+
+
toCollection() - Method in class fj.data.List
+
+
Projects an immutable collection of this list.
+
+
toCollection() - Method in class fj.data.NonEmptyList
+
+
Projects an immutable collection of this non-empty list.
+
+
toCollection() - Method in class fj.data.Option
+
+
Projects an immutable collection of this optional value.
+
+
toCollection() - Method in class fj.data.Stream
+
+
Projects an immutable collection of this stream.
+
+
toCollection() - Method in class fj.data.Tree
+
+
Projects an immutable collection of this tree.
+
+
toComparator() - Method in class fj.Ord
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node2
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node3
+
 
+
toEither(F0<X>) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Array
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.List
+
+
Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither(X) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither() - Static method in class fj.data.Option
+
+
A first-class version of the toEither method.
+
+
toEither(F0<X>) - Method in class fj.data.Stream
+
+
Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
+
+
toEither() - Method in class fj.data.Validation
+
+
Returns an either projection of this validation.
+
+
toForest() - Method in class fj.data.TreeZipper
+
+
Returns the forest containing this location.
+
+
toFunction() - Method in class fj.data.Stream
+
+
Converts this stream to a function of natural numbers.
+
+
toInt(boolean) - Static method in class fj.data.hamt.BitSet
+
 
+
toInt() - Method in enum fj.Ordering
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HNat
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HZero
+
 
+
toJavaArray() - Method in class fj.data.Array
+
+
Deprecated. +
As of release 4.6, use Array.array(Class).
+
+
+
toJavaArray() - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.6, use List.array(Class).
+
+
+
toJavaArray() - Method in class fj.data.Stream
+
+
Deprecated. +
As of release 4.6, use Stream.array(Class).
+
+
+
toJavaHashSet() - Method in class fj.data.Set
+
+
Returns a java.util.HashSet representation of this set.
+
+
toJavaList() - Method in class fj.data.Array
+
+
Returns a java.util.ArrayList projection of this array.
+
+
toJavaList() - Method in class fj.data.DList
+
+
Converts the DList to a standard java.util.List.
+
+
toJavaList() - Method in class fj.data.HashSet
+
 
+
toJavaList() - Method in class fj.data.List
+
 
+
toJavaList() - Method in class fj.data.Seq
+
+
Converts the sequence to a java.util.List
+
+
toJavaList() - Method in class fj.data.Set
+
+
Returns a java.util.List representation of this set.
+
+
toJavaList() - Method in class fj.data.Stream
+
+
Returns a java.util.List projection of this stream.
+
+
toJavaSet() - Method in class fj.data.HashSet
+
 
+
toJavaSet() - Method in class fj.data.Set
+
+
Returns a java.util.Set representation of this set.
+
+
toJavaTreeSet() - Method in class fj.data.Set
+
+
Returns a java.util.TreeSet representation of this set.
+
+
toList() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a list projection of this array.
+
+
toList() - Method in class fj.data.Array
+
+
Returns a list projection of this array.
+
+
toList() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.hamt.BitSet
+
 
+
toList(Ord<K>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the list of key-value pairs, ordered by key.
+
+
toList() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a list of key-value pairs.
+
+
toList() - Method in class fj.data.HashMap
+
 
+
toList() - Method in class fj.data.HashSet
+
+
Returns a list projection of this hash set.
+
+
toList() - Method in class fj.data.List.Buffer
+
+
Returns an immutable list projection of this buffer.
+
+
toList() - Method in class fj.data.NonEmptyList
+
+
Returns a List projection of this list.
+
+
toList() - Method in class fj.data.Option
+
+
Returns a list projection of this optional value.
+
+
toList() - Method in class fj.data.PriorityQueue
+
+
Returns a list of products with priority k and value a.
+
+
toList() - Method in class fj.data.Seq
+
+
Converts this sequence to a List
+
+
toList() - Method in class fj.data.Set
+
+
Returns a list representation of this set.
+
+
toList() - Method in class fj.data.Stream
+
+
Returns a list projection of this stream.
+
+
toList() - Method in class fj.data.TreeMap
+
 
+
toList() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element list if this is a failing value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Validation
+
+
Returns a single element list if this is a success value, otherwise an empty list.
+
+
toList_() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that takes a non-empty list to a list.
+
+
toListReverse() - Method in class fj.data.Set
+
+
Returns a list representation of this set in reverse order.
+
+
toListReverse() - Method in class fj.data.TreeMap
+
 
+
toLong - Static variable in enum fj.Digit
+
+
First-class conversion from digit to a long.
+
+
toLong() - Method in enum fj.Digit
+
+
Converts this digit to a long.
+
+
toLowerCase - Static variable in class fj.function.Characters
+
 
+
toMap() - Method in class fj.data.HashMap
+
 
+
toMutableMap() - Method in class fj.data.TreeMap
+
+
A mutable map projection of this tree map.
+
+
toNonEmptyList() - Method in class fj.data.vector.V2
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V3
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V4
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V5
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V6
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V7
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V8
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNull() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or if there is no value, returns null.
+
+
toOption() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an option projection of this array; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Array
+
+
Returns an option projection of this array; None if empty, or the first element in + Some.
+
+
toOption() - Method in class fj.data.Either.LeftProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.Either.RightProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.HashMap
+
 
+
toOption() - Method in class fj.data.List
+
+
Deprecated. +
As of release 4.5, use List.headOption()
+
+
+
toOption() - Method in class fj.data.Stream
+
+
Returns an option projection of this stream; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value in Some if there is one, otherwise None.
+
+
toOption() - Method in class fj.data.Validation
+
+
Returns the success value in Some if there is one, otherwise None.
+
+
top() - Method in class fj.data.PriorityQueue
+
+
If the tree is not empty, returns the node with highest priority otherwise returns nothing.
+
+
topDequeue() - Method in class fj.data.PriorityQueue
+
+
Returns a tuple of the node with the highest priority and the rest of the priority queue.
+
+
topN() - Method in class fj.data.PriorityQueue
+
+
Returns all the elements of the queue with the highest (same) priority.
+
+
toSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
+
+
toSafeValidation(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toStandardList() - Method in class fj.data.IterableW
+
+
Returns a java.util.List implementation for this iterable.
+
+
toStream() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a stream projection of this array.
+
+
toStream() - Method in class fj.data.Array
+
+
Returns a stream projection of this array.
+
+
toStream() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream(A) - Method in class fj.data.Enumerator
+
+
Returns a stream of the values from this enumerator, starting at the given value, counting up.
+
+
toStream() - Method in class fj.data.fingertrees.Deep
+
 
+
toStream() - Method in class fj.data.fingertrees.Digit
+
 
+
toStream() - Method in class fj.data.fingertrees.Empty
+
 
+
toStream() - Method in class fj.data.fingertrees.FingerTree
+
 
+
toStream() - Method in class fj.data.fingertrees.Four
+
 
+
toStream() - Method in class fj.data.fingertrees.Node
+
 
+
toStream() - Method in class fj.data.fingertrees.Node2
+
 
+
toStream() - Method in class fj.data.fingertrees.Node3
+
 
+
toStream() - Method in class fj.data.fingertrees.One
+
 
+
toStream() - Method in class fj.data.fingertrees.Single
+
 
+
toStream() - Method in class fj.data.fingertrees.Three
+
 
+
toStream() - Method in class fj.data.fingertrees.Two
+
 
+
toStream() - Method in class fj.data.hamt.BitSet
+
+
Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
+
+
toStream() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a stream of key-value pairs.
+
+
toStream() - Method in class fj.data.hamt.Node
+
 
+
toStream() - Method in class fj.data.HashMap
+
 
+
toStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to streams.
+
+
toStream() - Method in class fj.data.LazyString
+
+
Gives a stream representation of this lazy string.
+
+
toStream() - Method in class fj.data.List
+
+
Returns a stream projection of this list.
+
+
toStream() - Method in class fj.data.Option
+
+
Returns a stream projection of this optional value.
+
+
toStream() - Method in class fj.data.PriorityQueue
+
+
Returns a stream of products with priority k and value a.
+
+
toStream() - Method in class fj.data.Seq
+
+
Converts this sequence to a Stream
+
+
toStream() - Method in class fj.data.Set
+
+
Returns a stream representation of this set.
+
+
toStream() - Method in class fj.data.TreeMap
+
 
+
toStream() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element stream if this is a failing value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.Validation
+
+
Returns a single element stream if this is a success value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.vector.V2
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V3
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V4
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V5
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V6
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V7
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V8
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.Zipper
+
+
Returns the Stream representation of this zipper.
+
+
toStream_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to a stream of its elements.
+
+
toStreamReverse() - Method in class fj.data.Set
+
+
Returns a stream representation of this set in reverse order.
+
+
toStreamReverse() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Array
+
 
+
toString() - Method in class fj.data.Either
+
 
+
toString() - Method in class fj.data.fingertrees.Deep
+
 
+
toString() - Method in class fj.data.fingertrees.Digit
+
 
+
toString() - Method in class fj.data.fingertrees.Empty
+
 
+
toString() - Method in class fj.data.fingertrees.Four
+
 
+
toString() - Method in class fj.data.fingertrees.Node2
+
 
+
toString() - Method in class fj.data.fingertrees.Node3
+
 
+
toString() - Method in class fj.data.fingertrees.One
+
 
+
toString() - Method in class fj.data.fingertrees.Single
+
 
+
toString() - Method in class fj.data.fingertrees.Three
+
 
+
toString() - Method in class fj.data.fingertrees.Two
+
 
+
toString() - Method in class fj.data.hamt.BitSet
+
 
+
toString() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
toString() - Method in class fj.data.hamt.Node
+
 
+
toString - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to String.
+
+
toString() - Method in class fj.data.LazyString
+
 
+
toString() - Method in class fj.data.List
+
+
Obtain a string representation of this list using the toString implementations of the members.
+
+
toString() - Method in class fj.data.Natural
+
 
+
toString() - Method in class fj.data.NonEmptyList
+
 
+
toString() - Method in class fj.data.Option
+
 
+
toString() - Method in class fj.data.PriorityQueue
+
 
+
toString() - Method in class fj.data.Seq
+
 
+
toString() - Method in class fj.data.Set
+
 
+
toString() - Method in class fj.data.Stream
+
 
+
toString() - Method in class fj.data.Tree
+
 
+
toString() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Validation
+
 
+
toString - Static variable in class fj.function.Characters
+
 
+
toString() - Method in class fj.P1
+
 
+
toString() - Method in class fj.P2
+
 
+
toString() - Method in class fj.P3
+
 
+
toString() - Method in class fj.P4
+
 
+
toString() - Method in class fj.P5
+
 
+
toString() - Method in class fj.P6
+
 
+
toString() - Method in class fj.P7
+
 
+
toString() - Method in class fj.P8
+
 
+
toString() - Method in class fj.parser.Result
+
 
+
toString() - Method in class fj.Unit
+
 
+
toStringEager() - Method in class fj.data.LazyString
+
+
Returns the String representation of this lazy string.
+
+
toStringEager() - Method in class fj.data.Stream
+
 
+
toStringLazy() - Method in class fj.data.LazyString
+
 
+
toStringLazy() - Method in class fj.data.Stream
+
 
+
toTitleCase - Static variable in class fj.function.Characters
+
 
+
toTree() - Method in class fj.data.fingertrees.Digit
+
+
Returns the tree representation of this digit.
+
+
toTree() - Method in class fj.data.TreeZipper
+
+
Returns the tree containing this location.
+
+
toTry(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toUpperCase - Static variable in class fj.function.Characters
+
 
+
toValidation(X) - Method in class fj.data.Option
+
 
+
toVector() - Method in class fj.data.fingertrees.Node2
+
 
+
toVector() - Method in class fj.data.fingertrees.Node3
+
 
+
toZipper() - Method in class fj.data.IterableW
+
 
+
Trampoline<A> - Class in fj.control
+
+
A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
+
+
Trampoline() - Constructor for class fj.control.Trampoline
+
 
+
traversal() - Static method in class fj.data.List.Optic
+
+
Monomorphic traversal
+
+
Traversal<S,A> - Class in fj.data.optic
+
 
+
Traversal(PTraversal<S, S, A, A>) - Constructor for class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F3<A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F4<A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<A, A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traverse(List<A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
+
Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
+
+
traverseEither(F<A, Either<E, B>>) - Method in class fj.data.List
+
+
Traverse through the List with given function.
+
+
traverseEither(F<A, Either<L, B>>) - Method in class fj.data.Option
+
 
+
traverseEither(F<A, Either<X, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Either
+
+
traverseEither(F<B, Either<X, C>>) - Method in class fj.P2
+
 
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.List
+
 
+
traverseIO(F<A, IO<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
traverseIO(F<B, IO<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with a function that has IO effect
+
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.List
+
 
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Option
+
 
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Stream
+
+
Traversable instance of Stream for IO.
+
+
traverseIO(F<T, IO<C>>) - Method in class fj.data.Validation
+
 
+
traverseIO(F<B, IO<C>>) - Method in class fj.P2
+
 
+
traverseIOLeft(F<A, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for IO.
+
+
traverseIORight(F<B, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for IO.
+
+
traverseList(F<A, List<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<B, List<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.List
+
 
+
traverseList(F<A, List<B>>) - Method in class fj.data.Option
+
 
+
traverseList(F<T, List<C>>) - Method in class fj.data.Validation
+
 
+
traverseList(F<A, List<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for List
+
+
traverseList(F<B, List<C>>) - Method in class fj.P2
+
 
+
traverseListLeft(F<A, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for List.
+
+
traverseListRight(F<B, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for List.
+
+
traverseOption(F<A, Option<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseOption(F<B, Option<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Traverses through the List with the given function
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Option
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Stream
+
+
Traversable instance of Stream for Option.
+
+
traverseOption(F<T, Option<C>>) - Method in class fj.data.Validation
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Option
+
+
traverseOption(F<B, Option<C>>) - Method in class fj.P2
+
 
+
traverseOptionLeft(F<A, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Option.
+
+
traverseOptionRight(F<B, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Option.
+
+
traverseP1(F<B, P1<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.List
+
 
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.Option
+
 
+
traverseP1(F<T, P1<C>>) - Method in class fj.data.Validation
+
 
+
traversePromise(F<A, Promise<B>>) - Method in class fj.data.List
+
 
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.Option
+
 
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Option
+
 
+
traverseSet() - Method in class fj.data.Option
+
 
+
traverseStream(F<A, Stream<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseStream(F<B, Stream<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.List
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.Option
+
 
+
traverseStream(F<T, Stream<C>>) - Method in class fj.data.Validation
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Stream
+
+
traverseStream(F<B, Stream<C>>) - Method in class fj.P2
+
 
+
traverseStreamLeft(F<A, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Stream.
+
+
traverseStreamRight(F<B, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Stream.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
 
+
traverseV2(F<A, V2<B>>) - Method in class fj.data.List
+
 
+
traverseValidation(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.List
+
 
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.data.Option
+
 
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Validation
+
+
Tree<A> - Class in fj.data
+
+
Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
+
+
treeEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Tree type.
+
+
treeHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Tree type.
+
+
treeK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Tree.
+
+
treeK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a Tree.
+
+
treeM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to a function on Trees.
+
+
treeM() - Method in class fj.F2W
+
+
Promotes this function to a function on Trees.
+
+
TreeMap<K,V> - Class in fj.data
+
+
An immutable, in-memory map, backed by a red-black tree.
+
+
treeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
treeMap(Ord<K>, List<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Deprecated. +
As of release 4.5, use TreeMap.iterableTreeMap(Ord, Iterable)
+
+
+
treeMapEqual(Equal<K>, Equal<V>) - Static method in class fj.Equal
+
 
+
treeMapHash(Hash<K>, Hash<V>) - Static method in class fj.Hash
+
 
+
treeMapShow(Show<K>, Show<V>) - Static method in class fj.Show
+
+
A show instance for the TreeMap type.
+
+
TreeSet_List() - Static method in class fj.data.Java
+
+
A function that converts tree sets to lists.
+
+
treeShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Tree type.
+
+
TreeZipper<A> - Class in fj.data
+
+
Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.
+
+
treeZipper(Tree<A>, Stream<Tree<A>>, Stream<Tree<A>>, Stream<P3<Stream<Tree<A>>, A, Stream<Tree<A>>>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
+
+
treeZipper() - Static method in class fj.data.TreeZipper
+
+
First-class constructor for tree zippers.
+
+
treeZipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the TreeZipper type.
+
+
treeZipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the TreeZipper type.
+
+
treeZipperK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a TreeZipper.
+
+
treeZipperK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a TreeZipper.
+
+
TRUE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
Try - Class in fj
+
+
Created by mperry on 24/07/2014.
+
+
Try0<A,Z extends java.lang.Exception> - Interface in fj.function
+
+
A product of A which may throw an Exception.
+
+
Try1<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function from A to B that may throw an Exception.
+
+
Try2<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-2 from A and B to C that may throw an Exception.
+
+
Try3<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-3 from A, B and C to D that may throw an Exception.
+
+
Try4<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
+
+
Try5<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
+
+
Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
+
+
Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
+
+
Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
+
+
Try_F(Try1<A, B, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_F() - Static method in class fj.data.Conversions
+
 
+
Try_IO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_IO() - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO() - Static method in class fj.data.Conversions
+
 
+
TryEffect - Class in fj
+
+
Created by mperry on 29/08/2014.
+
+
TryEffect0<Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect1<A,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect2<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect3<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect4<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
+
Created by mperry on 28/08/2014.
+
+
TryEffect_P(TryEffect0<E>) - Static method in class fj.data.Conversions
+
 
+
tryNext() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the next element, or throws an error if there are no more elements.
+
+
tryPrevious() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the previous element, or throws an error if there are no more elements.
+
+
tuple(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Uncurries this function to a function on tuples.
+
+
tuple() - Method in class fj.F2W
+
+
Uncurries this function to a function on tuples.
+
+
tuple(F<A, F<B, C>>) - Static method in class fj.P2
+
+
Transforms a curried function of arity-2 to a function of a product-2
+
+
tuple(F2<A, B, C>) - Static method in class fj.P2
+
+
Transforms an uncurried function of arity-2 to a function of a product-2
+
+
two(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of two elements.
+
+
Two<V,A> - Class in fj.data.fingertrees
+
+
A two-element prefix or suffix of a finger tree.
+
+
typeParameterTree(Type) - Static method in class fj.Class
+
+
Provides type parameter information as a Tree of the type expression.
+
+
+ + + +

U

+
+
uncons(B, F2<A, FingerTree<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Performs a reduction on this finger tree using the given arguments.
+
+
uncons(F2<A, List<A>, B>, B) - Method in class fj.data.List
+
 
+
uncons(B, F<A, F<P1<Stream<A>>, B>>) - Method in class fj.data.Stream
+
+
Performs a reduction on this stream using the given arguments.
+
+
uncurryF2() - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF2(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF3() - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF3(F<A, F<B, F<C, D>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF4() - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF4(F<A, F<B, F<C, F<D, E>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF5() - Static method in class fj.Function
+
+
Uncurry a function of arity-5.
+
+
uncurryF5(F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6() - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF7() - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF8() - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
uncurryF8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
undefined() - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.List
+
+
Unfolds across the given function starting at the given value to produce a list.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.Stream
+
+
Unfolds across the given function starting at the given value to produce a stream.
+
+
unfoldTree(F<B, P2<A, P1<Stream<B>>>>) - Static method in class fj.data.Tree
+
+
Builds a tree from a seed value.
+
+
unicodeIdentiferPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
unicodeIdentiferStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
union(Set<A>) - Method in class fj.data.Set
+
+
Add all the elements of the given set to this set.
+
+
union() - Static method in class fj.data.Set
+
+
A first class function for Set.union(Set).
+
+
union(TreeMap<K, V>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
union(Iterable<P2<K, V>>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
unit(A) - Static method in class fj.control.db.DB
+
+
Constructs a database action that returns the given value completely intact.
+
+
unit(A) - Static method in class fj.data.IOFunctions
+
 
+
unit(F<A, B>) - Static method in class fj.data.Reader
+
 
+
unit(F<S, P2<S, A>>) - Static method in class fj.data.State
+
 
+
unit(A, W, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(A, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(B) - Static method in class fj.data.Writer
+
 
+
Unit - Class in fj
+
+
The unit type which has only one value.
+
+
unit() - Static method in class fj.Unit
+
+
The only value of the unit type.
+
+
unitMonoid - Static variable in class fj.Monoid
+
+
A monoid for the Unit value.
+
+
unitOrd - Static variable in class fj.Ord
+
+
An order instance for the Unit type.
+
+
units(F<S, S>) - Static method in class fj.data.State
+
 
+
unitSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup for the Unit value.
+
+
unless(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
unlines(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by newlines.
+
+
unlines(List<String>) - Static method in class fj.function.Strings
+
 
+
unlines() - Static method in class fj.function.Strings
+
 
+
unlines_() - Static method in class fj.data.LazyString
+
 
+
unlineShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for streams that splits into lines.
+
+
unqueue(B, F2<P2<K, A>, PriorityQueue<K, A>, B>) - Method in class fj.data.PriorityQueue
+
+
Performs a reduction on this priority queue using the given arguments.
+
+
Unsafe() - Constructor for class fj.data.List.Unsafe
+
 
+
untuple(F<P2<A, B>, C>) - Static method in class fj.P2
+
+
Transforms a function of a product-2 to an uncurried function or arity-2.
+
+
unwords(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by spaces.
+
+
unzip(Array<P2<A, B>>) - Static method in class fj.data.Array
+
+
Transforms an array of pairs into an array of first components and an array of second components.
+
+
unzip(List<P2<A, B>>) - Static method in class fj.data.List
+
+
Transforms a list of pairs into a list of first components and a list of second components.
+
+
unzip(NonEmptyList<P2<A, B>>) - Static method in class fj.data.NonEmptyList
+
+
Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
+
+
unzip(Stream<P2<A, B>>) - Static method in class fj.data.Stream
+
+
Transforms a stream of pairs into a stream of first components and a stream of second components.
+
+
update(int, A) - Method in class fj.data.Seq
+
+
Replace the element at the given index with the supplied value.
+
+
update(A, F<A, A>) - Method in class fj.data.Set
+
+
Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
+
+
update(K, F<V, V>) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it.
+
+
update(K, F<V, V>, V) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
+
+
upper(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
upper(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
+ + + +

V

+
+
v() - Method in class fj.data.hlist.HPre.HAnd
+
 
+
v() - Method in class fj.data.hlist.HPre.HCond
+
 
+
v() - Method in class fj.data.hlist.HPre.HEq
+
 
+
v() - Method in class fj.data.hlist.HPre.HOr
+
 
+
V - Class in fj.data.vector
+
+
Functions across vectors.
+
+
v(A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(A, A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v(P1<A>, P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v2() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-2.
+
+
V2<A> - Class in fj.data.vector
+
+
A vector-2.
+
+
v2Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-2.
+
+
v2Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-2.
+
+
v2Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-2.
+
+
v3() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-3.
+
+
V3<A> - Class in fj.data.vector
+
+
A vector-3.
+
+
v3Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-3.
+
+
v3Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-3.
+
+
v3Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-3.
+
+
v4() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-4.
+
+
V4<A> - Class in fj.data.vector
+
+
A vector-4.
+
+
v4Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-4.
+
+
v4Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-4.
+
+
v4Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-4.
+
+
v5() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-5.
+
+
V5<A> - Class in fj.data.vector
+
+
A vector-5.
+
+
v5Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-5.
+
+
v5Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-5.
+
+
v5Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-5.
+
+
V6<A> - Class in fj.data.vector
+
+
A vector-6.
+
+
v6Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-6.
+
+
v6Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-6.
+
+
v6Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-6.
+
+
V7<A> - Class in fj.data.vector
+
+
A vector-7.
+
+
v7Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-7.
+
+
v7Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-7.
+
+
v7Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-7.
+
+
V8<A> - Class in fj.data.vector
+
+
A vector-8.
+
+
v8Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-8.
+
+
v8Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-8.
+
+
v8Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-8.
+
+
Validation<E,T> - Class in fj.data
+
+
Isomorphic to Either but has renamed functions and represents failure on the left and success on the right.
+
+
Validation(Either<E, T>) - Constructor for class fj.data.Validation
+
 
+
validation() - Method in class fj.data.Validation.FailProjection
+
+
Returns the underlying validation.
+
+
validation(F<E, X>, F<T, X>) - Method in class fj.data.Validation
+
+
The catamorphism for validation.
+
+
validation(Either<E, T>) - Static method in class fj.data.Validation
+
+
Construct a validation using the given either value.
+
+
validation() - Static method in class fj.data.Validation
+
+
Returns a function that constructs a validation with an either.
+
+
Validation.FailProjection<E,T> - Class in fj.data
+
+
A failing projection of a validation.
+
+
validationEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Validation type.
+
+
validationHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Validation type.
+
+
validationOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Validation type.
+
+
validationShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Validation type.
+
+
value() - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Eval
+
+
Evaluates the computation and return its result.
+
+
value() - Method in class fj.data.fingertrees.One
+
+
Returns the single element in this digit.
+
+
value() - Method in class fj.data.fingertrees.Single
+
+
Returns the single element of this tree.
+
+
value() - Method in class fj.data.Writer
+
 
+
value(A) - Static method in class fj.parser.Parser
+
+
Constructs a parser that always returns the given value.
+
+
value() - Method in class fj.parser.Result
+
+
The parsed value.
+
+
valueE(F0<String>) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(String) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Either.RightProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueE(String) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueOf(String) - Static method in enum fj.Digit
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum fj.Ordering
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Method in class fj.data.fingertrees.Four
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Three
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Two
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.HashMap
+
+
Returns all values in this hash map.
+
+
values() - Method in class fj.data.TreeMap
+
+
Returns all values in this tree map.
+
+
values() - Static method in enum fj.Digit
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum fj.Ordering
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
vary(F<? super A, ? extends B>) - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
vary() - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
Vector_List() - Static method in class fj.data.Java
+
+
A function that converts vectors to lists.
+
+
Visitor - Class in fj.function
+
+
The essence of the visitor design pattern expressed polymorphically.
+
+
visitor(List<F<A, Option<B>>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
+
+
Void - Class in fj
+
+
A logically uninhabited data type.
+
+
voided(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
vzip(V2<A>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V3<A>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V4<A>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V5<A>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V6<A>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V7<A>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V8<A>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
+ + + +

W

+
+
weakMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
+
+
weakMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a WeakReference
+
+
when(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
whitespace(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
whitespace(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
withs(F<S, S>) - Method in class fj.data.State
+
 
+
words() - Method in class fj.data.LazyString
+
+
Splits this lazy string into words by spaces.
+
+
wrap() - Static method in class fj.data.Array
+
+
First-class wrapper function for arrays.
+
+
wrap(Iterable<A>) - Static method in class fj.data.IterableW
+
+
Wraps the given iterable.
+
+
wrap() - Static method in class fj.data.IterableW
+
+
Provides a function that wraps the given iterable.
+
+
writer(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state writer given a connection URL.
+
+
writer(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new writer that writes the database via the given Connector.
+
+
Writer<W,A> - Class in fj.data
+
+
Created by MarkPerry on 7/07/2014.
+
+
writerEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
 
+
+ + + +

X

+
+
xmap(F<P1<A>, P1<B>>, F<P1<B>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given bijective transformation across this strategy (Exponential Functor pattern).
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.data.Enumerator
+
+
Invariant functor map over this enumerator.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Monoid
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xmap(F<I, Z>, F<Z, I>) - Method in class fj.parser.Parser
+
+
Maps the parse input type through an invariant functor.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Semigroup
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xor(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
xor - Static variable in class fj.function.Booleans
+
+
Curried form of logical xor (nonequivalence).
+
+
xor(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using exclusive disjunction
+
+
+ + + +

Z

+
+
zapp(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
+
+
zapp(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
+
+
zero() - Method in class fj.data.fingertrees.Measured
+
+
Returns the identity measurement for the monoid.
+
+
ZERO - Static variable in class fj.data.Natural
+
+
The natural number zero
+
+
zero() - Method in class fj.Monoid
+
+
The zero value for this monoid.
+
+
zip(Array<B>) - Method in class fj.data.Array
+
+
Zips this array with the given array to produce an array of pairs.
+
+
zip(Iterable<B>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable to produce a iterable of pairs.
+
+
zip(List<B>) - Method in class fj.data.List
+
+
Zips this list with the given list to produce a list of pairs.
+
+
zip() - Static method in class fj.data.List
+
+
The first-class version of the zip function.
+
+
zip(NonEmptyList<B>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list to produce a list of pairs.
+
+
zip(Stream<B>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream to produce a stream of pairs.
+
+
zip(V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zipArrayM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
+
+
zipArrayM() - Method in class fj.F2W
+
+
Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
+
+
zipIndex() - Method in class fj.data.Array
+
+
Zips this array with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.IterableW
+
+
Zips this iterable with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.List
+
+
Zips this list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.Stream
+
+
Zips this stream with the index of its element as a pair.
+
+
zipIterableM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two iterables, applying the function lock-step over both iterables.
+
+
zipIterableM() - Method in class fj.F2W
+
+
Promotes this function to zip two iterables, applying the function lock-step over both iterables.
+
+
zipListM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two lists, applying the function lock-step over both lists.
+
+
zipListM() - Method in class fj.F2W
+
+
Promotes this function to zip two lists, applying the function lock-step over both lists.
+
+
zipNelM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
+
+
zipNelM() - Method in class fj.F2W
+
+
Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
+
+
Zipper<A> - Class in fj.data
+
+
Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream.
+
+
zipper(Stream<A>, A, Stream<A>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper with the given streams before and after the focus, and the given focused item.
+
+
zipper(P3<Stream<A>, A, Stream<A>>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper from the given triple.
+
+
zipper() - Static method in class fj.data.Zipper
+
+
First-class constructor of zippers.
+
+
zipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Zipper type.
+
+
zipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Zipper type.
+
+
zipperK(F<A, B>) - Static method in class fj.F1Functions
+
+
Promotes this function to return its value in a Zipper.
+
+
zipperK() - Method in class fj.F1W
+
+
Promotes this function to return its value in a Zipper.
+
+
zipSetM(F2<A, B, C>, Ord<C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two sets, applying the function lock-step over both sets.
+
+
zipSetM(Ord<C>) - Method in class fj.F2W
+
+
Promotes this function to zip two sets, applying the function lock-step over both sets.
+
+
zipStreamM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two streams, applying the function lock-step over both streams.
+
+
zipStreamM() - Method in class fj.F2W
+
+
Promotes this function to zip two streams, applying the function lock-step over both streams.
+
+
zipTreeM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two trees, applying the function lock-step over both trees.
+
+
zipTreeM() - Method in class fj.F2W
+
+
Promotes this function to zip two trees, applying the function lock-step over both trees.
+
+
zipTreeZipperM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
+
+
zipTreeZipperM() - Method in class fj.F2W
+
+
Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
+
+
zipWith(Trampoline<B>, F2<A, B, C>) - Method in class fj.control.Trampoline
+
+
Combines two trampolines so they run cooperatively.
+
+
zipWith(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Iterable<B>, F<A, F<B, C>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(Iterable<B>, F2<A, B, C>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith() - Static method in class fj.data.List
+
+
Provides a first-class version of zipWith
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Partially-applied version of zipWith.
+
+
zipWith() - Static method in class fj.data.Stream
+
+
A first-class version of the zipWith function.
+
+
zipWith(Tree<B>, F2<A, B, C>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(Tree<B>, F<A, F<B, C>>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(TreeZipper<B>, F2<A, B, C>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(TreeZipper<B>, F<A, F<B, C>>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(F<A, F<B, C>>, V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(Zipper<B>, F2<A, B, C>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWith(Zipper<B>, F<A, F<B, C>>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWithFocus() - Method in class fj.data.TreeZipper
+
+
Zips the nodes in this zipper with a boolean that indicates whether that node has focus.
+
+
zipWithFocus() - Method in class fj.data.Zipper
+
+
Zips the elements of this zipper with a boolean that indicates whether that element has focus.
+
+
zipZipperM(F2<A, B, C>) - Static method in class fj.F2Functions
+
+
Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
+
+
zipZipperM() - Method in class fj.F2W
+
+
Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
+
+
+ + + +

_

+
+
_1() - Method in class fj.data.$
+
 
+
_1() - Method in class fj.data.vector.V2
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.P1
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P2
+
+
Access the first element of the product.
+
+
_1() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_1() - Method in class fj.P3
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P4
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P5
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P6
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P7
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P8
+
+
Access the first element of the product.
+
+
_1_() - Method in class fj.P2
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P3
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P4
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P5
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P6
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P7
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P8
+
+
Returns the 1-product projection over the first element.
+
+
_1p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _1.
+
+
_2() - Method in class fj.data.vector.V2
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V3
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V4
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V5
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V6
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V7
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V8
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.P2
+
+
Access the second element of the product.
+
+
_2() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_2() - Method in class fj.P3
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P4
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P5
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P6
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P7
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P8
+
+
Access the second element of the product.
+
+
_2_() - Method in class fj.P2
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P3
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P4
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P5
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P6
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P7
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P8
+
+
Returns the 1-product projection over the second element.
+
+
_2p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _2.
+
+
_3() - Method in class fj.data.vector.V3
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V4
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V5
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V6
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V7
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V8
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.P3
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P4
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P5
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P6
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P7
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P8
+
+
Access the third element of the product.
+
+
_3_() - Method in class fj.P3
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P4
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P5
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P6
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P7
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P8
+
+
Returns the 1-product projection over the third element.
+
+
_4() - Method in class fj.data.vector.V4
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V5
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V6
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V7
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V8
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.P4
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P5
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P6
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P7
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P8
+
+
Access the fourth element of the product.
+
+
_4_() - Method in class fj.P4
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fourth element.
+
+
_5() - Method in class fj.data.vector.V5
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V6
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V7
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V8
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.P5
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P6
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P7
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P8
+
+
Access the fifth element of the product.
+
+
_5_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fifth element.
+
+
_6() - Method in class fj.data.vector.V6
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V7
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V8
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.P6
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P7
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P8
+
+
Access the sixth element of the product.
+
+
_6_() - Method in class fj.P6
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P7
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P8
+
+
Returns the 1-product projection over the sixth element.
+
+
_7() - Method in class fj.data.vector.V7
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.data.vector.V8
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.P7
+
+
Access the seventh element of the product.
+
+
_7() - Method in class fj.P8
+
+
Access the seventh element of the product.
+
+
_7_() - Method in class fj.P7
+
+
Returns the 1-product projection over the seventh element.
+
+
_7_() - Method in class fj.P8
+
+
Returns the 1-product projection over the seventh element.
+
+
_8() - Method in class fj.data.vector.V8
+
+
Returns the eighth element of this vector.
+
+
_8() - Method in class fj.P8
+
+
Access the eighth element of the product.
+
+
_8_() - Method in class fj.P8
+
+
Returns the 1-product projection over the eighth element.
+
+
__(B) - Static method in class fj.data.$
+
+
Returns a function that given an argument, returns a function that ignores its argument.
+
+
__1() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.P1
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P2
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P3
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P4
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P5
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P6
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P7
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P8
+
+
Returns a function that returns the first element of a product.
+
+
__2() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.P2
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P3
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P4
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P5
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P6
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P7
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P8
+
+
Returns a function that returns the second element of a product.
+
+
__3() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.P3
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P4
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P5
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P6
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P7
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P8
+
+
Returns a function that returns the third element of a product.
+
+
__4() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.P4
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P5
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P6
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P7
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P8
+
+
Returns a function that returns the fourth element of a product.
+
+
__5() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.P5
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P6
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P7
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P8
+
+
Returns a function that returns the fifth element of a product.
+
+
__6() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.P6
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P7
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P8
+
+
Returns a function that returns the sixth element of a product.
+
+
__7() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.P7
+
+
Returns a function that returns the seventh element of a product.
+
+
__7() - Static method in class fj.P8
+
+
Returns a function that returns the seventh element of a product.
+
+
__8() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the eighth element of a vector.
+
+
__8() - Static method in class fj.P8
+
+
Returns a function that returns the eighth element of a product.
+
+
+$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _ 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/index.html b/javadoc/4.8.1/functionaljava/index.html new file mode 100644 index 0000000..2dd8d8a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/index.html @@ -0,0 +1,75 @@ + + + + + +core 4.8.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/4.8.1/functionaljava/overview-frame.html b/javadoc/4.8.1/functionaljava/overview-frame.html new file mode 100644 index 0000000..dfd7132 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/overview-frame.html @@ -0,0 +1,32 @@ + + + + + +Overview List (core 4.8.1 API) + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/4.8.1/functionaljava/overview-summary.html b/javadoc/4.8.1/functionaljava/overview-summary.html new file mode 100644 index 0000000..6fb131f --- /dev/null +++ b/javadoc/4.8.1/functionaljava/overview-summary.html @@ -0,0 +1,205 @@ + + + + + +Overview (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

core 4.8.1 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj +
Types that set the premise for the existence of Functional Java.
+
fj.control +
Functional control abstractions.
+
fj.control.db +
Abstractions for JDBC connections.
+
fj.control.parallel +
Parallelization strategies.
+
fj.data +
Common algebraic data types.
+
fj.data.fingertrees +
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
fj.data.hamt 
fj.data.hlist +
Type-safe, extensible, heterogeneous lists
+
fj.data.optic +
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
fj.data.vector +
Fixed-length vectors
+
fj.function +
A prelude of commonly used first-class functions
+
fj.parser +
Parser combinators.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/overview-tree.html b/javadoc/4.8.1/functionaljava/overview-tree.html new file mode 100644 index 0000000..4519e2c --- /dev/null +++ b/javadoc/4.8.1/functionaljava/overview-tree.html @@ -0,0 +1,446 @@ + + + + + +Class Hierarchy (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/package-list b/javadoc/4.8.1/functionaljava/package-list new file mode 100644 index 0000000..1ef325a --- /dev/null +++ b/javadoc/4.8.1/functionaljava/package-list @@ -0,0 +1,12 @@ +fj +fj.control +fj.control.db +fj.control.parallel +fj.data +fj.data.fingertrees +fj.data.hamt +fj.data.hlist +fj.data.optic +fj.data.vector +fj.function +fj.parser diff --git a/javadoc/4.8.1/functionaljava/script.js b/javadoc/4.8.1/functionaljava/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/4.8.1/functionaljava/serialized-form.html b/javadoc/4.8.1/functionaljava/serialized-form.html new file mode 100644 index 0000000..fc35054 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/serialized-form.html @@ -0,0 +1,150 @@ + + + + + +Serialized Form (core 4.8.1 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+
    +
  • +

    Package fj.data

    +
      +
    • + + +

      Class fj.data.Natural extends java.lang.Number implements Serializable

      +
      +
      serialVersionUID:
      +
      -588673650944359682L
      +
      +
        +
      • +

        Serialized Fields

        +
          +
        • +

          value

          +
          java.math.BigInteger value
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/4.8.1/functionaljava/stylesheet.css b/javadoc/4.8.1/functionaljava/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/4.8.1/functionaljava/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} From 23760c83a5a34e222165ce1a98d0ed661e4c6cab Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Giraudeau Date: Mon, 8 Oct 2018 18:39:52 +0200 Subject: [PATCH 06/10] Publish of Github pages from Gradle. --- docs.html | 11 +++++++++++ download.html | 2 +- feed.xml | 4 ++-- quickstart.html | 18 +++++++++--------- 4 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs.html b/docs.html index d5eba1d..385a9bd 100644 --- a/docs.html +++ b/docs.html @@ -101,6 +101,17 @@

Release Notes

Javadoc

+
+

4.8.1

+
+ +
+

4.8

diff --git a/download.html b/download.html index cf1239b..0d78f6d 100644 --- a/download.html +++ b/download.html @@ -87,7 +87,7 @@

Build System

Release Notes

-

The current stable release of Functional Java is 4.8. Release notes for each release are available below:

+

The current stable release of Functional Java is 4.8.1. Release notes for each release are available below:

    diff --git a/feed.xml b/feed.xml index 8872e73..f127e9e 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - Aug 18, 2018 11:51:14 PM - Aug 18, 2018 11:51:14 PM + 08-Oct-2018 18:24:18 + 08-Oct-2018 18:24:18 diff --git a/quickstart.html b/quickstart.html index 63a24c6..530ae88 100644 --- a/quickstart.html +++ b/quickstart.html @@ -67,7 +67,7 @@

    Quickstart

    -

    The latest stable version as at July 2015 is 4.8. Here is how to quickly add the library to your project and get started.

    +

    The latest stable version as at July 2015 is 4.8.1. Here is how to quickly add the library to your project and get started.

    The Functional Java artifact is published to Maven Central using the group org.functionaljava with three published artifacts:

    @@ -90,10 +90,10 @@

    Gradle

    - 
    compile "org.functionaljava:functionaljava:4.8"
-compile "org.functionaljava:functionaljava-java8:4.8"
-compile "org.functionaljava:functionaljava-quickcheck:4.8"
-compile "org.functionaljava:functionaljava-java-core:4.8"
    + 
    compile "org.functionaljava:functionaljava:4.8.1"
+compile "org.functionaljava:functionaljava-java8:4.8.1"
+compile "org.functionaljava:functionaljava-quickcheck:4.8.1"
+compile "org.functionaljava:functionaljava-java-core:4.8.1"
    @@ -109,22 +109,22 @@

    Maven

    <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava</artifactId>
-    <version>4.8</version>
+    <version>4.8.1</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java8</artifactId>
-    <version>4.8</version>
+    <version>4.8.1</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-quickcheck</artifactId>
-    <version>4.8</version>
+    <version>4.8.1</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java-core</artifactId>
-    <version>4.8</version>
+    <version>4.8.1</version>
 </dependency>
From 4cdca8c71257576399e7ee916af6ba42d2f8692f Mon Sep 17 00:00:00 2001 From: Mark Perry Date: Sat, 19 Feb 2022 20:35:01 +1000 Subject: [PATCH 07/10] Added FJ 5.0 javadoc --- .../allclasses-frame.html | 18 + .../allclasses-noframe.html | 18 + .../constant-values.html | 119 + .../deprecated-list.html | 119 + .../fj/java/util/ListUtil.html | 332 + .../fj/java/util/package-frame.html | 19 + .../fj/java/util/package-summary.html | 137 + .../fj/java/util/package-tree.html | 128 + .../functionaljava-java-core/help-doc.html | 216 + .../functionaljava-java-core/index-all.html | 156 + .../5.0/functionaljava-java-core/index.html | 72 + .../overview-tree.html | 132 + .../5.0/functionaljava-java-core/package-list | 1 + .../5.0/functionaljava-java-core/script.js | 30 + .../functionaljava-java-core/stylesheet.css | 574 + .../allclasses-frame.html | 36 + .../allclasses-noframe.html | 36 + .../constant-values.html | 121 + .../deprecated-list.html | 121 + .../fj/data/test/PropertyAssert.html | 234 + .../fj/data/test/package-frame.html | 19 + .../fj/data/test/package-summary.html | 139 + .../fj/data/test/package-tree.html | 134 + .../fj/test/Arbitrary.html | 2671 +++ .../fj/test/Arg.html | 328 + .../fj/test/Bool.html | 374 + .../fj/test/CheckResult.html | 712 + .../fj/test/Cogen.html | 2005 ++ .../fj/test/Gen.html | 1486 ++ .../fj/test/Property.html | 2513 +++ .../fj/test/Rand.html | 434 + .../fj/test/Result.html | 609 + .../fj/test/Shrink.html | 1679 ++ .../fj/test/Variant.html | 269 + .../fj/test/package-frame.html | 29 + .../fj/test/package-summary.html | 224 + .../fj/test/package-tree.html | 144 + .../fj/test/reflect/Category.html | 222 + .../fj/test/reflect/Check.html | 496 + .../fj/test/reflect/CheckParams.html | 308 + .../fj/test/reflect/Main.html | 244 + .../fj/test/reflect/Name.html | 220 + .../fj/test/reflect/NoCheck.html | 165 + .../fj/test/reflect/package-frame.html | 27 + .../fj/test/reflect/package-summary.html | 226 + .../fj/test/reflect/package-tree.html | 142 + .../fj/test/runner/PropertyTestRunner.html | 328 + .../fj/test/runner/package-frame.html | 19 + .../fj/test/runner/package-summary.html | 139 + .../fj/test/runner/package-tree.html | 138 + .../functionaljava-quickcheck/help-doc.html | 222 + .../functionaljava-quickcheck/index-all.html | 2119 +++ .../5.0/functionaljava-quickcheck/index.html | 75 + .../overview-frame.html | 23 + .../overview-summary.html | 153 + .../overview-tree.html | 162 + .../functionaljava-quickcheck/package-list | 4 + .../5.0/functionaljava-quickcheck/script.js | 30 + .../functionaljava-quickcheck/stylesheet.css | 574 + .../5.0/functionaljava/allclasses-frame.html | 218 + .../functionaljava/allclasses-noframe.html | 218 + .../5.0/functionaljava/constant-values.html | 204 + .../5.0/functionaljava/deprecated-list.html | 121 + javadoc/5.0/functionaljava/fj/Bottom.html | 400 + .../functionaljava/fj/Bounded.Definition.html | 236 + javadoc/5.0/functionaljava/fj/Bounded.html | 300 + javadoc/5.0/functionaljava/fj/Class.html | 372 + javadoc/5.0/functionaljava/fj/Digit.html | 636 + javadoc/5.0/functionaljava/fj/Effect.html | 383 + .../fj/Equal.AltDefinition.html | 262 + .../functionaljava/fj/Equal.Definition.html | 290 + javadoc/5.0/functionaljava/fj/Equal.html | 1667 ++ javadoc/5.0/functionaljava/fj/F.html | 1686 ++ javadoc/5.0/functionaljava/fj/F0.html | 301 + javadoc/5.0/functionaljava/fj/F2.html | 776 + javadoc/5.0/functionaljava/fj/F3.html | 242 + javadoc/5.0/functionaljava/fj/F4.html | 245 + javadoc/5.0/functionaljava/fj/F5.html | 250 + javadoc/5.0/functionaljava/fj/F6.html | 253 + javadoc/5.0/functionaljava/fj/F7.html | 256 + javadoc/5.0/functionaljava/fj/F8.html | 260 + javadoc/5.0/functionaljava/fj/Function.html | 2161 +++ javadoc/5.0/functionaljava/fj/Hash.html | 1280 ++ javadoc/5.0/functionaljava/fj/LcgRng.html | 327 + .../fj/Monoid.AltDefinition.html | 262 + .../functionaljava/fj/Monoid.Definition.html | 328 + javadoc/5.0/functionaljava/fj/Monoid.html | 1343 ++ .../functionaljava/fj/Ord.AltDefinition.html | 297 + .../5.0/functionaljava/fj/Ord.Definition.html | 426 + javadoc/5.0/functionaljava/fj/Ord.html | 1409 ++ javadoc/5.0/functionaljava/fj/Ordering.html | 400 + javadoc/5.0/functionaljava/fj/P.html | 1072 ++ javadoc/5.0/functionaljava/fj/P1.html | 891 + javadoc/5.0/functionaljava/fj/P2.Optic.html | 290 + javadoc/5.0/functionaljava/fj/P2.html | 1078 ++ javadoc/5.0/functionaljava/fj/P3.html | 685 + javadoc/5.0/functionaljava/fj/P4.html | 745 + javadoc/5.0/functionaljava/fj/P5.html | 805 + javadoc/5.0/functionaljava/fj/P6.html | 865 + javadoc/5.0/functionaljava/fj/P7.html | 925 + javadoc/5.0/functionaljava/fj/P8.html | 983 + javadoc/5.0/functionaljava/fj/Primitive.html | 1120 ++ javadoc/5.0/functionaljava/fj/Rng.html | 313 + .../fj/Semigroup.AltDefinition.html | 262 + .../fj/Semigroup.Definition.html | 293 + javadoc/5.0/functionaljava/fj/Semigroup.html | 1313 ++ javadoc/5.0/functionaljava/fj/Show.html | 1775 ++ javadoc/5.0/functionaljava/fj/Try.html | 432 + javadoc/5.0/functionaljava/fj/TryEffect.html | 338 + javadoc/5.0/functionaljava/fj/Unit.html | 259 + javadoc/5.0/functionaljava/fj/Void.html | 238 + .../functionaljava/fj/control/Trampoline.html | 603 + .../fj/control/db/Connector.html | 274 + .../5.0/functionaljava/fj/control/db/DB.html | 458 + .../functionaljava/fj/control/db/DbState.html | 357 + .../fj/control/db/package-frame.html | 21 + .../fj/control/db/package-summary.html | 162 + .../fj/control/db/package-tree.html | 136 + .../fj/control/package-frame.html | 19 + .../fj/control/package-summary.html | 150 + .../fj/control/package-tree.html | 134 + .../fj/control/parallel/Actor.html | 370 + .../fj/control/parallel/Callables.html | 730 + .../fj/control/parallel/ParModule.html | 1411 ++ .../fj/control/parallel/Promise.html | 863 + .../fj/control/parallel/Strategy.html | 1117 ++ .../fj/control/parallel/package-frame.html | 23 + .../fj/control/parallel/package-summary.html | 174 + .../fj/control/parallel/package-tree.html | 138 + javadoc/5.0/functionaljava/fj/data/$.html | 306 + .../fj/data/Array.ImmutableProjection.html | 678 + javadoc/5.0/functionaljava/fj/data/Array.html | 1696 ++ .../functionaljava/fj/data/Collectors.html | 260 + .../functionaljava/fj/data/Conversions.html | 1606 ++ javadoc/5.0/functionaljava/fj/data/DList.html | 473 + .../fj/data/Either.LeftProjection.html | 817 + .../fj/data/Either.RightProjection.html | 828 + .../5.0/functionaljava/fj/data/Either.html | 1010 + .../fj/data/Either3.LeftProjection.html | 526 + .../fj/data/Either3.MiddleProjection.html | 526 + .../fj/data/Either3.RightProjection.html | 526 + .../5.0/functionaljava/fj/data/Either3.html | 690 + .../functionaljava/fj/data/Enumerator.html | 881 + javadoc/5.0/functionaljava/fj/data/Eval.html | 449 + .../5.0/functionaljava/fj/data/HashMap.html | 1071 ++ .../5.0/functionaljava/fj/data/HashSet.html | 804 + javadoc/5.0/functionaljava/fj/data/IO.html | 347 + .../functionaljava/fj/data/IOFunctions.html | 1010 + .../5.0/functionaljava/fj/data/IterableW.html | 850 + .../fj/data/Iteratee.Input.html | 293 + .../fj/data/Iteratee.IterV.html | 388 + .../5.0/functionaljava/fj/data/Iteratee.html | 221 + javadoc/5.0/functionaljava/fj/data/Java.html | 3623 ++++ javadoc/5.0/functionaljava/fj/data/Java8.html | 640 + .../functionaljava/fj/data/LazyString.html | 982 + .../functionaljava/fj/data/List.Buffer.html | 482 + .../functionaljava/fj/data/List.Optic.html | 322 + .../functionaljava/fj/data/List.Unsafe.html | 238 + javadoc/5.0/functionaljava/fj/data/List.html | 4096 ++++ .../5.0/functionaljava/fj/data/Natural.html | 929 + .../functionaljava/fj/data/NonEmptyList.html | 1040 + .../functionaljava/fj/data/Option.Optic.html | 273 + .../5.0/functionaljava/fj/data/Option.html | 2769 +++ .../functionaljava/fj/data/PriorityQueue.html | 643 + .../5.0/functionaljava/fj/data/Reader.html | 364 + .../5.0/functionaljava/fj/data/SafeIO.html | 265 + javadoc/5.0/functionaljava/fj/data/Seq.html | 1698 ++ javadoc/5.0/functionaljava/fj/data/Set.html | 1318 ++ javadoc/5.0/functionaljava/fj/data/State.html | 512 + .../5.0/functionaljava/fj/data/Stream.html | 3864 ++++ javadoc/5.0/functionaljava/fj/data/Tree.html | 908 + .../5.0/functionaljava/fj/data/TreeMap.html | 1013 + .../functionaljava/fj/data/TreeZipper.html | 1367 ++ .../fj/data/Validation.FailProjection.html | 677 + .../functionaljava/fj/data/Validation.html | 3041 +++ .../5.0/functionaljava/fj/data/Writer.html | 378 + .../5.0/functionaljava/fj/data/Zipper.html | 1285 ++ .../fj/data/fingertrees/Deep.html | 726 + .../fj/data/fingertrees/Digit.html | 479 + .../fj/data/fingertrees/Empty.html | 666 + .../fj/data/fingertrees/FingerTree.html | 869 + .../fj/data/fingertrees/Four.html | 418 + .../fj/data/fingertrees/MakeTree.html | 543 + .../fj/data/fingertrees/Measured.html | 389 + .../fj/data/fingertrees/Node.html | 398 + .../fj/data/fingertrees/Node2.html | 395 + .../fj/data/fingertrees/Node3.html | 395 + .../fj/data/fingertrees/One.html | 418 + .../fj/data/fingertrees/Single.html | 686 + .../fj/data/fingertrees/Three.html | 418 + .../fj/data/fingertrees/Two.html | 418 + .../fj/data/fingertrees/package-frame.html | 32 + .../fj/data/fingertrees/package-summary.html | 235 + .../fj/data/fingertrees/package-tree.html | 156 + .../functionaljava/fj/data/hamt/BitSet.html | 808 + .../fj/data/hamt/HashArrayMappedTrie.html | 608 + .../5.0/functionaljava/fj/data/hamt/Node.html | 355 + .../fj/data/hamt/package-frame.html | 21 + .../fj/data/hamt/package-summary.html | 156 + .../fj/data/hamt/package-tree.html | 136 + .../fj/data/hlist/HList.Apply.html | 391 + .../fj/data/hlist/HList.HAppend.html | 303 + .../fj/data/hlist/HList.HCons.html | 323 + .../fj/data/hlist/HList.HFoldr.html | 322 + .../fj/data/hlist/HList.HNil.html | 297 + .../functionaljava/fj/data/hlist/HList.html | 383 + .../fj/data/hlist/HPre.HAdd.html | 297 + .../fj/data/hlist/HPre.HAnd.html | 305 + .../fj/data/hlist/HPre.HBool.html | 203 + .../fj/data/hlist/HPre.HCond.html | 284 + .../fj/data/hlist/HPre.HEq.html | 322 + .../fj/data/hlist/HPre.HFalse.html | 204 + .../fj/data/hlist/HPre.HNat.html | 331 + .../fj/data/hlist/HPre.HOr.html | 305 + .../fj/data/hlist/HPre.HSucc.html | 276 + .../fj/data/hlist/HPre.HTrue.html | 204 + .../fj/data/hlist/HPre.HZero.html | 272 + .../functionaljava/fj/data/hlist/HPre.html | 343 + .../fj/data/hlist/package-frame.html | 36 + .../fj/data/hlist/package-summary.html | 252 + .../fj/data/hlist/package-tree.html | 160 + .../functionaljava/fj/data/optic/Fold.html | 523 + .../functionaljava/fj/data/optic/Getter.html | 456 + .../5.0/functionaljava/fj/data/optic/Iso.html | 623 + .../functionaljava/fj/data/optic/Lens.html | 769 + .../fj/data/optic/Optional.html | 816 + .../functionaljava/fj/data/optic/PIso.html | 843 + .../functionaljava/fj/data/optic/PLens.html | 729 + .../fj/data/optic/POptional.html | 789 + .../functionaljava/fj/data/optic/PPrism.html | 801 + .../functionaljava/fj/data/optic/PSetter.html | 425 + .../fj/data/optic/PTraversal.html | 907 + .../functionaljava/fj/data/optic/Prism.html | 521 + .../functionaljava/fj/data/optic/Setter.html | 418 + .../fj/data/optic/Traversal.html | 722 + .../fj/data/optic/package-frame.html | 32 + .../fj/data/optic/package-summary.html | 246 + .../fj/data/optic/package-tree.html | 165 + .../functionaljava/fj/data/package-frame.html | 69 + .../fj/data/package-summary.html | 424 + .../functionaljava/fj/data/package-tree.html | 199 + .../5.0/functionaljava/fj/data/vector/V.html | 546 + .../5.0/functionaljava/fj/data/vector/V2.html | 646 + .../5.0/functionaljava/fj/data/vector/V3.html | 731 + .../5.0/functionaljava/fj/data/vector/V4.html | 771 + .../5.0/functionaljava/fj/data/vector/V5.html | 811 + .../5.0/functionaljava/fj/data/vector/V6.html | 851 + .../5.0/functionaljava/fj/data/vector/V7.html | 891 + .../5.0/functionaljava/fj/data/vector/V8.html | 931 + .../fj/data/vector/package-frame.html | 26 + .../fj/data/vector/package-summary.html | 192 + .../fj/data/vector/package-tree.html | 141 + .../fj/function/BigIntegers.html | 401 + .../functionaljava/fj/function/Booleans.html | 774 + .../fj/function/Characters.html | 562 + .../functionaljava/fj/function/Doubles.html | 501 + .../functionaljava/fj/function/Effect0.html | 270 + .../functionaljava/fj/function/Effect1.html | 413 + .../functionaljava/fj/function/Effect2.html | 268 + .../functionaljava/fj/function/Effect3.html | 224 + .../functionaljava/fj/function/Effect4.html | 226 + .../functionaljava/fj/function/Effect5.html | 228 + .../functionaljava/fj/function/Effect6.html | 230 + .../functionaljava/fj/function/Effect7.html | 232 + .../functionaljava/fj/function/Effect8.html | 234 + .../functionaljava/fj/function/Integers.html | 501 + .../5.0/functionaljava/fj/function/Longs.html | 405 + .../functionaljava/fj/function/Strings.html | 479 + .../5.0/functionaljava/fj/function/Try0.html | 286 + .../5.0/functionaljava/fj/function/Try1.html | 232 + .../5.0/functionaljava/fj/function/Try2.html | 234 + .../5.0/functionaljava/fj/function/Try3.html | 236 + .../5.0/functionaljava/fj/function/Try4.html | 238 + .../5.0/functionaljava/fj/function/Try5.html | 240 + .../5.0/functionaljava/fj/function/Try6.html | 242 + .../5.0/functionaljava/fj/function/Try7.html | 244 + .../5.0/functionaljava/fj/function/Try8.html | 246 + .../fj/function/TryEffect0.html | 275 + .../fj/function/TryEffect1.html | 225 + .../fj/function/TryEffect2.html | 227 + .../fj/function/TryEffect3.html | 229 + .../fj/function/TryEffect4.html | 231 + .../fj/function/TryEffect5.html | 233 + .../fj/function/TryEffect6.html | 235 + .../fj/function/TryEffect7.html | 237 + .../fj/function/TryEffect8.html | 239 + .../functionaljava/fj/function/Visitor.html | 392 + .../fj/function/package-frame.html | 56 + .../fj/function/package-summary.html | 329 + .../fj/function/package-tree.html | 179 + .../5.0/functionaljava/fj/package-frame.html | 72 + .../functionaljava/fj/package-summary.html | 454 + .../5.0/functionaljava/fj/package-tree.html | 227 + .../fj/parser/Parser.CharsParser.html | 1502 ++ .../fj/parser/Parser.StreamParser.html | 330 + .../5.0/functionaljava/fj/parser/Parser.html | 948 + .../5.0/functionaljava/fj/parser/Result.html | 523 + .../fj/parser/package-frame.html | 22 + .../fj/parser/package-summary.html | 169 + .../fj/parser/package-tree.html | 137 + javadoc/5.0/functionaljava/help-doc.html | 222 + javadoc/5.0/functionaljava/index-all.html | 15867 ++++++++++++++++ javadoc/5.0/functionaljava/index.html | 75 + .../5.0/functionaljava/overview-frame.html | 31 + .../5.0/functionaljava/overview-summary.html | 204 + javadoc/5.0/functionaljava/overview-tree.html | 452 + javadoc/5.0/functionaljava/package-list | 12 + javadoc/5.0/functionaljava/script.js | 30 + .../5.0/functionaljava/serialized-form.html | 149 + javadoc/5.0/functionaljava/stylesheet.css | 574 + 310 files changed, 176823 insertions(+) create mode 100644 javadoc/5.0/functionaljava-java-core/allclasses-frame.html create mode 100644 javadoc/5.0/functionaljava-java-core/allclasses-noframe.html create mode 100644 javadoc/5.0/functionaljava-java-core/constant-values.html create mode 100644 javadoc/5.0/functionaljava-java-core/deprecated-list.html create mode 100644 javadoc/5.0/functionaljava-java-core/fj/java/util/ListUtil.html create mode 100644 javadoc/5.0/functionaljava-java-core/fj/java/util/package-frame.html create mode 100644 javadoc/5.0/functionaljava-java-core/fj/java/util/package-summary.html create mode 100644 javadoc/5.0/functionaljava-java-core/fj/java/util/package-tree.html create mode 100644 javadoc/5.0/functionaljava-java-core/help-doc.html create mode 100644 javadoc/5.0/functionaljava-java-core/index-all.html create mode 100644 javadoc/5.0/functionaljava-java-core/index.html create mode 100644 javadoc/5.0/functionaljava-java-core/overview-tree.html create mode 100644 javadoc/5.0/functionaljava-java-core/package-list create mode 100644 javadoc/5.0/functionaljava-java-core/script.js create mode 100644 javadoc/5.0/functionaljava-java-core/stylesheet.css create mode 100644 javadoc/5.0/functionaljava-quickcheck/allclasses-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/allclasses-noframe.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/constant-values.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/deprecated-list.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/data/test/PropertyAssert.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-summary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-tree.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Arbitrary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Arg.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Bool.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/CheckResult.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Cogen.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Gen.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Property.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Rand.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Result.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Shrink.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/Variant.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/package-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/package-summary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/package-tree.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Category.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Check.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/CheckParams.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Main.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Name.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/NoCheck.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-summary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-tree.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-summary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-tree.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/help-doc.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/index-all.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/index.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/overview-frame.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/overview-summary.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/overview-tree.html create mode 100644 javadoc/5.0/functionaljava-quickcheck/package-list create mode 100644 javadoc/5.0/functionaljava-quickcheck/script.js create mode 100644 javadoc/5.0/functionaljava-quickcheck/stylesheet.css create mode 100644 javadoc/5.0/functionaljava/allclasses-frame.html create mode 100644 javadoc/5.0/functionaljava/allclasses-noframe.html create mode 100644 javadoc/5.0/functionaljava/constant-values.html create mode 100644 javadoc/5.0/functionaljava/deprecated-list.html create mode 100644 javadoc/5.0/functionaljava/fj/Bottom.html create mode 100644 javadoc/5.0/functionaljava/fj/Bounded.Definition.html create mode 100644 javadoc/5.0/functionaljava/fj/Bounded.html create mode 100644 javadoc/5.0/functionaljava/fj/Class.html create mode 100644 javadoc/5.0/functionaljava/fj/Digit.html create mode 100644 javadoc/5.0/functionaljava/fj/Effect.html create mode 100644 javadoc/5.0/functionaljava/fj/Equal.AltDefinition.html create mode 100644 javadoc/5.0/functionaljava/fj/Equal.Definition.html create mode 100644 javadoc/5.0/functionaljava/fj/Equal.html create mode 100644 javadoc/5.0/functionaljava/fj/F.html create mode 100644 javadoc/5.0/functionaljava/fj/F0.html create mode 100644 javadoc/5.0/functionaljava/fj/F2.html create mode 100644 javadoc/5.0/functionaljava/fj/F3.html create mode 100644 javadoc/5.0/functionaljava/fj/F4.html create mode 100644 javadoc/5.0/functionaljava/fj/F5.html create mode 100644 javadoc/5.0/functionaljava/fj/F6.html create mode 100644 javadoc/5.0/functionaljava/fj/F7.html create mode 100644 javadoc/5.0/functionaljava/fj/F8.html create mode 100644 javadoc/5.0/functionaljava/fj/Function.html create mode 100644 javadoc/5.0/functionaljava/fj/Hash.html create mode 100644 javadoc/5.0/functionaljava/fj/LcgRng.html create mode 100644 javadoc/5.0/functionaljava/fj/Monoid.AltDefinition.html create mode 100644 javadoc/5.0/functionaljava/fj/Monoid.Definition.html create mode 100644 javadoc/5.0/functionaljava/fj/Monoid.html create mode 100644 javadoc/5.0/functionaljava/fj/Ord.AltDefinition.html create mode 100644 javadoc/5.0/functionaljava/fj/Ord.Definition.html create mode 100644 javadoc/5.0/functionaljava/fj/Ord.html create mode 100644 javadoc/5.0/functionaljava/fj/Ordering.html create mode 100644 javadoc/5.0/functionaljava/fj/P.html create mode 100644 javadoc/5.0/functionaljava/fj/P1.html create mode 100644 javadoc/5.0/functionaljava/fj/P2.Optic.html create mode 100644 javadoc/5.0/functionaljava/fj/P2.html create mode 100644 javadoc/5.0/functionaljava/fj/P3.html create mode 100644 javadoc/5.0/functionaljava/fj/P4.html create mode 100644 javadoc/5.0/functionaljava/fj/P5.html create mode 100644 javadoc/5.0/functionaljava/fj/P6.html create mode 100644 javadoc/5.0/functionaljava/fj/P7.html create mode 100644 javadoc/5.0/functionaljava/fj/P8.html create mode 100644 javadoc/5.0/functionaljava/fj/Primitive.html create mode 100644 javadoc/5.0/functionaljava/fj/Rng.html create mode 100644 javadoc/5.0/functionaljava/fj/Semigroup.AltDefinition.html create mode 100644 javadoc/5.0/functionaljava/fj/Semigroup.Definition.html create mode 100644 javadoc/5.0/functionaljava/fj/Semigroup.html create mode 100644 javadoc/5.0/functionaljava/fj/Show.html create mode 100644 javadoc/5.0/functionaljava/fj/Try.html create mode 100644 javadoc/5.0/functionaljava/fj/TryEffect.html create mode 100644 javadoc/5.0/functionaljava/fj/Unit.html create mode 100644 javadoc/5.0/functionaljava/fj/Void.html create mode 100644 javadoc/5.0/functionaljava/fj/control/Trampoline.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/Connector.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/DB.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/DbState.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/control/db/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/control/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/control/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/control/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/Actor.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/Callables.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/ParModule.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/Promise.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/Strategy.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/control/parallel/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/$.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Array.ImmutableProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Array.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Collectors.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Conversions.html create mode 100644 javadoc/5.0/functionaljava/fj/data/DList.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either.LeftProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either.RightProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either3.LeftProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either3.MiddleProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either3.RightProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Either3.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Enumerator.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Eval.html create mode 100644 javadoc/5.0/functionaljava/fj/data/HashMap.html create mode 100644 javadoc/5.0/functionaljava/fj/data/HashSet.html create mode 100644 javadoc/5.0/functionaljava/fj/data/IO.html create mode 100644 javadoc/5.0/functionaljava/fj/data/IOFunctions.html create mode 100644 javadoc/5.0/functionaljava/fj/data/IterableW.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Iteratee.Input.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Iteratee.IterV.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Iteratee.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Java.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Java8.html create mode 100644 javadoc/5.0/functionaljava/fj/data/LazyString.html create mode 100644 javadoc/5.0/functionaljava/fj/data/List.Buffer.html create mode 100644 javadoc/5.0/functionaljava/fj/data/List.Optic.html create mode 100644 javadoc/5.0/functionaljava/fj/data/List.Unsafe.html create mode 100644 javadoc/5.0/functionaljava/fj/data/List.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Natural.html create mode 100644 javadoc/5.0/functionaljava/fj/data/NonEmptyList.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Option.Optic.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Option.html create mode 100644 javadoc/5.0/functionaljava/fj/data/PriorityQueue.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Reader.html create mode 100644 javadoc/5.0/functionaljava/fj/data/SafeIO.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Seq.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Set.html create mode 100644 javadoc/5.0/functionaljava/fj/data/State.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Stream.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/TreeMap.html create mode 100644 javadoc/5.0/functionaljava/fj/data/TreeZipper.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Validation.FailProjection.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Validation.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Writer.html create mode 100644 javadoc/5.0/functionaljava/fj/data/Zipper.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Deep.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Digit.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Empty.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/FingerTree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Four.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/MakeTree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Measured.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Node.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Node2.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Node3.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/One.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Single.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Three.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/Two.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/fingertrees/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/BitSet.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/HashArrayMappedTrie.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/Node.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hamt/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.Apply.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.HAppend.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.HCons.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.HFoldr.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.HNil.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HList.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAdd.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAnd.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HBool.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HCond.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HEq.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HFalse.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HNat.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HOr.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HSucc.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HTrue.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.HZero.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/HPre.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/hlist/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Fold.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Getter.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Iso.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Lens.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Optional.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/PIso.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/PLens.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/POptional.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/PPrism.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/PSetter.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/PTraversal.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Prism.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Setter.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/Traversal.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/optic/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V2.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V3.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V4.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V5.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V6.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V7.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/V8.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/data/vector/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/function/BigIntegers.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Booleans.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Characters.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Doubles.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect0.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect1.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect2.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect3.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect4.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect5.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect6.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect7.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Effect8.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Integers.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Longs.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Strings.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try0.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try1.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try2.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try3.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try4.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try5.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try6.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try7.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Try8.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect0.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect1.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect2.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect3.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect4.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect5.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect6.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect7.html create mode 100644 javadoc/5.0/functionaljava/fj/function/TryEffect8.html create mode 100644 javadoc/5.0/functionaljava/fj/function/Visitor.html create mode 100644 javadoc/5.0/functionaljava/fj/function/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/function/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/function/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/package-tree.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/Parser.CharsParser.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/Parser.StreamParser.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/Parser.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/Result.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/package-frame.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/package-summary.html create mode 100644 javadoc/5.0/functionaljava/fj/parser/package-tree.html create mode 100644 javadoc/5.0/functionaljava/help-doc.html create mode 100644 javadoc/5.0/functionaljava/index-all.html create mode 100644 javadoc/5.0/functionaljava/index.html create mode 100644 javadoc/5.0/functionaljava/overview-frame.html create mode 100644 javadoc/5.0/functionaljava/overview-summary.html create mode 100644 javadoc/5.0/functionaljava/overview-tree.html create mode 100644 javadoc/5.0/functionaljava/package-list create mode 100644 javadoc/5.0/functionaljava/script.js create mode 100644 javadoc/5.0/functionaljava/serialized-form.html create mode 100644 javadoc/5.0/functionaljava/stylesheet.css diff --git a/javadoc/5.0/functionaljava-java-core/allclasses-frame.html b/javadoc/5.0/functionaljava-java-core/allclasses-frame.html new file mode 100644 index 0000000..5db6196 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/allclasses-frame.html @@ -0,0 +1,18 @@ + + + + + +All Classes (java-core 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava-java-core/allclasses-noframe.html b/javadoc/5.0/functionaljava-java-core/allclasses-noframe.html new file mode 100644 index 0000000..08a699e --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/allclasses-noframe.html @@ -0,0 +1,18 @@ + + + + + +All Classes (java-core 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava-java-core/constant-values.html b/javadoc/5.0/functionaljava-java-core/constant-values.html new file mode 100644 index 0000000..85fb8dd --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/constant-values.html @@ -0,0 +1,119 @@ + + + + + +Constant Field Values (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/deprecated-list.html b/javadoc/5.0/functionaljava-java-core/deprecated-list.html new file mode 100644 index 0000000..178e96e --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/deprecated-list.html @@ -0,0 +1,119 @@ + + + + + +Deprecated List (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/fj/java/util/ListUtil.html b/javadoc/5.0/functionaljava-java-core/fj/java/util/ListUtil.html new file mode 100644 index 0000000..2b0300f --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/fj/java/util/ListUtil.html @@ -0,0 +1,332 @@ + + + + + +ListUtil (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.java.util
+

Class ListUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.java.util.ListUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ListUtil
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ListUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.List<B>bind(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A> java.util.List<A>filter(java.util.List<A> list, + fj.F<A,java.lang.Boolean> f) 
      static <A,B> java.util.List<B>flatMap(java.util.List<A> list, + fj.F<A,java.util.List<B>> f) 
      static <A,B> Bfold(java.util.List<A> list, + fj.F2<B,A,B> f, + B b) 
      static <A,B> java.util.List<B>map(java.util.List<A> list, + fj.F<A,B> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ListUtil

        +
        public ListUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        map

        +
        public static <A,B> java.util.List<B> map(java.util.List<A> list,
+                                          fj.F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> java.util.List<A> filter(java.util.List<A> list,
+                                           fj.F<A,java.lang.Boolean> f)
        +
        • +
      + + + + + +
        +
      • +

        fold

        +
        public static <A,B> B fold(java.util.List<A> list,
+                           fj.F2<B,A,B> f,
+                           B b)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> java.util.List<B> flatMap(java.util.List<A> list,
+                                              fj.F<A,java.util.List<B>> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.List<B> bind(java.util.List<A> list,
+                                           fj.F<A,java.util.List<B>> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/fj/java/util/package-frame.html b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-frame.html new file mode 100644 index 0000000..425511b --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-frame.html @@ -0,0 +1,19 @@ + + + + + +fj.java.util (java-core 5.0 API) + + + + +

fj.java.util

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava-java-core/fj/java/util/package-summary.html b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-summary.html new file mode 100644 index 0000000..a0a3e20 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-summary.html @@ -0,0 +1,137 @@ + + + + + +fj.java.util (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package fj.java.util

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ListUtil 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/fj/java/util/package-tree.html b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-tree.html new file mode 100644 index 0000000..9a2e606 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/fj/java/util/package-tree.html @@ -0,0 +1,128 @@ + + + + + +fj.java.util Class Hierarchy (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.java.util

+
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/help-doc.html b/javadoc/5.0/functionaljava-java-core/help-doc.html new file mode 100644 index 0000000..5bcf96b --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/help-doc.html @@ -0,0 +1,216 @@ + + + + + +API Help (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/index-all.html b/javadoc/5.0/functionaljava-java-core/index-all.html new file mode 100644 index 0000000..a0b0f3a --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/index-all.html @@ -0,0 +1,156 @@ + + + + + +Index (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
B F L M  + + +

B

+
+
bind(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

F

+
+
filter(List<A>, F<A, Boolean>) - Static method in class fj.java.util.ListUtil
+
 
+
fj.java.util - package fj.java.util
+
 
+
flatMap(List<A>, F<A, List<B>>) - Static method in class fj.java.util.ListUtil
+
 
+
fold(List<A>, F2<B, A, B>, B) - Static method in class fj.java.util.ListUtil
+
 
+
+ + + +

L

+
+
ListUtil - Class in fj.java.util
+
 
+
ListUtil() - Constructor for class fj.java.util.ListUtil
+
 
+
+ + + +

M

+
+
map(List<A>, F<A, B>) - Static method in class fj.java.util.ListUtil
+
 
+
+B F L M 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/index.html b/javadoc/5.0/functionaljava-java-core/index.html new file mode 100644 index 0000000..1b9aa5c --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/index.html @@ -0,0 +1,72 @@ + + + + + +java-core 5.0 API + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="fj/java/util/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/5.0/functionaljava-java-core/overview-tree.html b/javadoc/5.0/functionaljava-java-core/overview-tree.html new file mode 100644 index 0000000..8888ea1 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/overview-tree.html @@ -0,0 +1,132 @@ + + + + + +Class Hierarchy (java-core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-java-core/package-list b/javadoc/5.0/functionaljava-java-core/package-list new file mode 100644 index 0000000..01c82ea --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/package-list @@ -0,0 +1 @@ +fj.java.util diff --git a/javadoc/5.0/functionaljava-java-core/script.js b/javadoc/5.0/functionaljava-java-core/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/5.0/functionaljava-java-core/stylesheet.css b/javadoc/5.0/functionaljava-java-core/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/5.0/functionaljava-java-core/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/5.0/functionaljava-quickcheck/allclasses-frame.html b/javadoc/5.0/functionaljava-quickcheck/allclasses-frame.html new file mode 100644 index 0000000..25e8293 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/allclasses-frame.html @@ -0,0 +1,36 @@ + + + + + +All Classes (quickcheck 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/allclasses-noframe.html b/javadoc/5.0/functionaljava-quickcheck/allclasses-noframe.html new file mode 100644 index 0000000..3775893 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/allclasses-noframe.html @@ -0,0 +1,36 @@ + + + + + +All Classes (quickcheck 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/constant-values.html b/javadoc/5.0/functionaljava-quickcheck/constant-values.html new file mode 100644 index 0000000..1e6144d --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/constant-values.html @@ -0,0 +1,121 @@ + + + + + +Constant Field Values (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/deprecated-list.html b/javadoc/5.0/functionaljava-quickcheck/deprecated-list.html new file mode 100644 index 0000000..0e93ed0 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/deprecated-list.html @@ -0,0 +1,121 @@ + + + + + +Deprecated List (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/data/test/PropertyAssert.html b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/PropertyAssert.html new file mode 100644 index 0000000..3d78778 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/PropertyAssert.html @@ -0,0 +1,234 @@ + + + + + +PropertyAssert (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.test
+

Class PropertyAssert

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.test.PropertyAssert
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PropertyAssert
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static fj.UnitassertResult(Property p) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        assertResult

        +
        public static fj.Unit assertResult(Property p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-frame.html b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-frame.html new file mode 100644 index 0000000..b09c986 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-frame.html @@ -0,0 +1,19 @@ + + + + + +fj.data.test (quickcheck 5.0 API) + + + + +

fj.data.test

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-summary.html b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-summary.html new file mode 100644 index 0000000..113e122 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-summary.html @@ -0,0 +1,139 @@ + + + + + +fj.data.test (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.test

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    PropertyAssert 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-tree.html b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-tree.html new file mode 100644 index 0000000..5ca579d --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/data/test/package-tree.html @@ -0,0 +1,134 @@ + + + + + +fj.data.test Class Hierarchy (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Arbitrary.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Arbitrary.html new file mode 100644 index 0000000..863c56a --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Arbitrary.html @@ -0,0 +1,2671 @@ + + + + + +Arbitrary (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Arbitrary

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arbitrary
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arbitrary
+extends java.lang.Object
    +
    Common Gen helper functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Gen<java.lang.String>arbAlphaNumString +
      An arbitrary implementation for string values with alpha-numeric characters.
      +
      static Gen<java.math.BigDecimal>arbBigDecimal +
      An arbitrary implementation for big decimals.
      +
      static Gen<java.math.BigInteger>arbBigInteger +
      An arbitrary implementation for big integers.
      +
      static Gen<java.util.BitSet>arbBitSet +
      An arbitrary implementation for bit sets.
      +
      static Gen<java.lang.Boolean>arbBoolean +
      An arbitrary implementation for boolean values.
      +
      static Gen<java.lang.Byte>arbByte +
      An arbitrary implementation for byte values.
      +
      static Gen<java.lang.Byte>arbByteBoundaries +
      An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
      +
      static Gen<java.util.Calendar>arbCalendar +
      An arbitrary implementation for calendars.
      +
      static Gen<java.lang.Character>arbCharacter +
      An arbitrary implementation for character values.
      +
      static Gen<java.lang.Character>arbCharacterBoundaries +
      An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
      +
      static Gen<java.util.Date>arbDate +
      An arbitrary implementation for dates.
      +
      static Gen<java.lang.Double>arbDouble +
      An arbitrary implementation for double values.
      +
      static Gen<java.lang.Double>arbDoubleBoundaries +
      An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
      +
      static Gen<java.lang.Float>arbFloat +
      An arbitrary implementation for float values.
      +
      static Gen<java.lang.Float>arbFloatBoundaries +
      An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
      +
      static Gen<java.util.GregorianCalendar>arbGregorianCalendar +
      An arbitrary implementation for gregorian calendars.
      +
      static Gen<java.lang.Integer>arbInteger +
      An arbitrary implementation for integer values.
      +
      static Gen<java.lang.Integer>arbIntegerBoundaries +
      An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
      +
      static Gen<java.util.Locale>arbLocale +
      An arbitrary implementation for locales.
      +
      static Gen<java.lang.Long>arbLong +
      An arbitrary implementation for long values.
      +
      static Gen<java.lang.Long>arbLongBoundaries +
      An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
      +
      static Gen<fj.data.Natural>arbNatural +
      An arbitrary implementation for naturals.
      +
      static Gen<java.util.Properties>arbProperties +
      An arbitrary implementation for properties.
      +
      static Gen<java.lang.Short>arbShort +
      An arbitrary implementation for short values.
      +
      static Gen<java.lang.Short>arbShortBoundaries +
      An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
      +
      static Gen<java.sql.Date>arbSQLDate +
      An arbitrary implementation for SQL dates.
      +
      static Gen<java.lang.String>arbString +
      An arbitrary implementation for string values.
      +
      static Gen<java.lang.StringBuffer>arbStringBuffer +
      An arbitrary implementation for string buffer values.
      +
      static Gen<java.lang.StringBuilder>arbStringBuilder +
      An arbitrary implementation for string builder values.
      +
      static Gen<java.lang.Throwable>arbThrowable +
      An arbitrary implementation for throwables.
      +
      static Gen<java.sql.Time>arbTime +
      An arbitrary implementation for SQL times.
      +
      static Gen<java.sql.Timestamp>arbTimestamp +
      An arbitrary implementation for SQL time stamps.
      +
      static Gen<java.lang.String>arbUSASCIIString +
      An arbitrary implementation for string values with characters in the US-ASCII range.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Arbitrary() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Gen<fj.data.Array<A>>arbArray(Gen<A> aa) +
      Returns an arbitrary implementation for arrays.
      +
      static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>>arbArrayBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for array blocking queues.
      +
      static <A> Gen<java.util.ArrayList<A>>arbArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for array lists.
      +
      static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>>arbConcurrentHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for concurrent hash maps.
      +
      static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>>arbConcurrentLinkedQueue(Gen<A> aa) +
      Returns an arbitrary implementation for concurrent linked queues.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>>arbCopyOnWriteArrayList(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array lists.
      +
      static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>>arbCopyOnWriteArraySet(Gen<A> aa) +
      Returns an arbitrary implementation for copy-on-write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      Gen<java.util.concurrent.DelayQueue<A>>      		arbDelayQueue(Gen<A> aa) +
      Returns an arbitrary implementation for delay queues.
      +
      static <A,B> Gen<fj.data.Either<A,B>>arbEither(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for the disjoint union.
      +
      static <K extends java.lang.Enum<K>,V>
      Gen<java.util.EnumMap<K,V>>      		arbEnumMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for enum maps.
      +
      static <A extends java.lang.Enum<A>>
      Gen<java.util.EnumSet<A>>      		arbEnumSet(Gen<A> aa) +
      Returns an arbitrary implementation for enum sets.
      +
      static <A extends java.lang.Enum<A>>
      Gen<A>      		arbEnumValue(java.lang.Class<A> clazz) +
      Returns an arbitrary implementation for a Java enumeration.
      +
      static <A,B> Gen<fj.F<A,B>>arbF(Cogen<A> c, + Gen<B> a) +
      An arbitrary for functions.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2(Cogen<A> ca, + Cogen<B> cb, + Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C> Gen<fj.F2<A,B,C>>arbF2Invariant(Gen<C> a) +
      An arbitrary for function-2.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D> Gen<fj.F3<A,B,C,D>>arbF3Invariant(Gen<D> a) +
      An arbitrary for function-3.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E>
      Gen<fj.F4<A,B,C,D,E>>      		arbF4Invariant(Gen<E> a) +
      An arbitrary for function-4.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.F5<A,B,C,D,E,F$>>      		arbF5Invariant(Gen<F$> a) +
      An arbitrary for function-5.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.F6<A,B,C,D,E,F$,G>>      		arbF6Invariant(Gen<G> a) +
      An arbitrary for function-6.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.F7<A,B,C,D,E,F$,G,H>>      		arbF7Invariant(Gen<H> a) +
      An arbitrary for function-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8(Cogen<A> ca, + Cogen<B> cb, + Cogen<C> cc, + Cogen<D> cd, + Cogen<E> ce, + Cogen<F$> cf, + Cogen<G> cg, + Cogen<H> ch, + Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      Gen<fj.F8<A,B,C,D,E,F$,G,H,I>>      		arbF8Invariant(Gen<I> a) +
      An arbitrary for function-8.
      +
      static <A,B> Gen<fj.F<A,B>>arbFInvariant(Gen<B> a) +
      An arbitrary for functions.
      +
      static <A> Gen<Gen<A>>arbGen(Gen<A> aa) +
      Returns an arbitrary implementation for generators.
      +
      static <K,V> Gen<java.util.HashMap<K,V>>arbHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash maps.
      +
      static <A> Gen<java.util.HashSet<A>>arbHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <K,V> Gen<java.util.Hashtable<K,V>>arbHashtable(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for hash tables.
      +
      static <K,V> Gen<java.util.IdentityHashMap<K,V>>arbIdentityHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for identity hash maps.
      +
      static <K,V> Gen<java.util.TreeMap<K,V>>arbJavaTreeMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for java.util tree maps.
      +
      static <A> Gen<fj.LcgRng>arbLcgRng() +
      An arbitrary for the LcgRng.
      +
      static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>>arbLinkedBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for linked blocking queues.
      +
      static <K,V> Gen<java.util.LinkedHashMap<K,V>>arbLinkedHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for linked hash maps.
      +
      static <A> Gen<java.util.LinkedHashSet<A>>arbLinkedHashSet(Gen<A> aa) +
      Returns an arbitrary implementation for hash sets.
      +
      static <A> Gen<java.util.LinkedList<A>>arbLinkedList(Gen<A> aa) +
      Returns an arbitrary implementation for linked lists.
      +
      static <A> Gen<fj.data.List<A>>arbList(Gen<A> aa) +
      Returns an arbitrary implementation for lists.
      +
      static <A> Gen<fj.data.List<java.lang.Boolean>>arbListBoolean() +
      Returns an arbitrary list of booleans.
      +
      static <A> Gen<fj.data.List<java.lang.Double>>arbListDouble() +
      Returns an arbitrary list of doubles.
      +
      static <A> Gen<fj.data.List<java.lang.Integer>>arbListInteger() +
      Returns an arbitrary list of integers.
      +
      static <A> Gen<fj.data.List<java.lang.String>>arbListString() +
      Returns an arbitrary list of strings.
      +
      static <A> Gen<fj.data.NonEmptyList<A>>arbNonEmptyList(Gen<A> aa) 
      static <A> Gen<fj.data.Option<A>>arbOption(Gen<A> aa) +
      Returns an arbitrary implementation for optional values.
      +
      static <A> Gen<fj.P1<A>>arbP1(Gen<A> aa) +
      Returns an arbitrary implementation for product-1 values.
      +
      static <A,B> Gen<fj.P2<A,B>>arbP2(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary implementation for product-2 values.
      +
      static <A,B,C> Gen<fj.P3<A,B,C>>arbP3(Gen<A> aa, + Gen<B> ab, + Gen<C> ac) +
      Returns an arbitrary implementation for product-3 values.
      +
      static <A,B,C,D> Gen<fj.P4<A,B,C,D>>arbP4(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad) +
      Returns an arbitrary implementation for product-4 values.
      +
      static <A,B,C,D,E>
      Gen<fj.P5<A,B,C,D,E>>      		arbP5(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae) +
      Returns an arbitrary implementation for product-5 values.
      +
      static <A,B,C,D,E,F$>
      Gen<fj.P6<A,B,C,D,E,F$>>      		arbP6(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af) +
      Returns an arbitrary implementation for product-6 values.
      +
      static <A,B,C,D,E,F$,G>
      Gen<fj.P7<A,B,C,D,E,F$,G>>      		arbP7(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag) +
      Returns an arbitrary implementation for product-7 values.
      +
      static <A,B,C,D,E,F$,G,H>
      Gen<fj.P8<A,B,C,D,E,F$,G,H>>      		arbP8(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah) +
      Returns an arbitrary implementation for product-8 values.
      +
      static Gen<fj.control.parallel.ParModule>arbParModule() 
      static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>>arbPriorityBlockingQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static <A> Gen<java.util.PriorityQueue<A>>arbPriorityQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority queues.
      +
      static <A,B> Gen<fj.data.Reader<A,B>>arbReader(Cogen<A> aa, + Gen<B> ab) 
      static <A> Gen<fj.data.Seq<A>>arbSeq(Gen<A> aa) +
      Returns an arbitrary implementation for sequences.
      +
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa) 
      static <A> Gen<fj.data.Set<A>>arbSet(fj.Ord<A> ord, + Gen<A> aa, + int max) 
      static <A> Gen<java.util.Stack<A>>arbStack(Gen<A> aa) +
      Returns an arbitrary implementation for stacks.
      +
      static <S,A> Gen<fj.data.State<S,A>>arbState(Gen<S> as, + Cogen<S> cs, + Gen<A> aa) +
      An arbitrary for state.
      +
      static <A> Gen<fj.control.parallel.Strategy<A>>arbStrategy() 
      static <A> Gen<fj.data.Stream<A>>arbStream(Gen<A> aa) +
      Returns an arbitrary implementation for streams.
      +
      static <A> Gen<java.util.concurrent.SynchronousQueue<A>>arbSynchronousQueue(Gen<A> aa) +
      Returns an arbitrary implementation for priority blocking queues.
      +
      static Gen<java.lang.Throwable>arbThrowable(Gen<java.lang.String> as) +
      Returns an arbitrary implementation for throwables.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for tree maps.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + Gen<java.lang.Integer> ai) +
      Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<K> ak, + Gen<V> av, + int maxSize) +
      Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
      +
      static <K,V> Gen<fj.data.TreeMap<K,V>>arbTreeMap(fj.Ord<K> ord, + Gen<fj.data.List<fj.P2<K,V>>> al) +
      Returns an arbitrary implementation for tree maps.
      +
      static <A> Gen<java.util.TreeSet<A>>arbTreeSet(Gen<A> aa) +
      Returns an arbitrary implementation for tree sets.
      +
      static <A,B> Gen<fj.data.Validation<A,B>>arbValidation(Gen<A> aa, + Gen<B> ab) +
      Returns an arbitrary Validation for the given arbitrary parameters.
      +
      static <A> Gen<java.util.Vector<A>>arbVector(Gen<A> aa) +
      Returns an arbitrary implementation for vectors.
      +
      static <K,V> Gen<java.util.WeakHashMap<K,V>>arbWeakHashMap(Gen<K> ak, + Gen<V> av) +
      Returns an arbitrary implementation for weak hash maps.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        arbBoolean

        +
        public static final Gen<java.lang.Boolean> arbBoolean
        +
        An arbitrary implementation for boolean values.
        +
        • +
      + + + +
        +
      • +

        arbInteger

        +
        public static final Gen<java.lang.Integer> arbInteger
        +
        An arbitrary implementation for integer values.
        +
        • +
      + + + +
        +
      • +

        arbIntegerBoundaries

        +
        public static final Gen<java.lang.Integer> arbIntegerBoundaries
        +
        An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from arbInteger the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbLong

        +
        public static final Gen<java.lang.Long> arbLong
        +
        An arbitrary implementation for long values.
        +
        • +
      + + + +
        +
      • +

        arbLongBoundaries

        +
        public static final Gen<java.lang.Long> arbLongBoundaries
        +
        An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbLong + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbByte

        +
        public static final Gen<java.lang.Byte> arbByte
        +
        An arbitrary implementation for byte values.
        +
        • +
      + + + +
        +
      • +

        arbByteBoundaries

        +
        public static final Gen<java.lang.Byte> arbByteBoundaries
        +
        An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbByte + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbShort

        +
        public static final Gen<java.lang.Short> arbShort
        +
        An arbitrary implementation for short values.
        +
        • +
      + + + +
        +
      • +

        arbShortBoundaries

        +
        public static final Gen<java.lang.Short> arbShortBoundaries
        +
        An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from arbShort + the remainder of the time (93%).
        +
        • +
      + + + +
        +
      • +

        arbCharacter

        +
        public static final Gen<java.lang.Character> arbCharacter
        +
        An arbitrary implementation for character values.
        +
        • +
      + + + +
        +
      • +

        arbCharacterBoundaries

        +
        public static final Gen<java.lang.Character> arbCharacterBoundaries
        +
        An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from arbCharacter + the remainder of the time (96%).
        +
        • +
      + + + +
        +
      • +

        arbDouble

        +
        public static final Gen<java.lang.Double> arbDouble
        +
        An arbitrary implementation for double values.
        +
        • +
      + + + +
        +
      • +

        arbDoubleBoundaries

        +
        public static final Gen<java.lang.Double> arbDoubleBoundaries
        +
        An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from arbDouble the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbFloat

        +
        public static final Gen<java.lang.Float> arbFloat
        +
        An arbitrary implementation for float values.
        +
        • +
      + + + +
        +
      • +

        arbFloatBoundaries

        +
        public static final Gen<java.lang.Float> arbFloatBoundaries
        +
        An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + arbFloat the remainder of the time (91%).
        +
        • +
      + + + +
        +
      • +

        arbString

        +
        public static final Gen<java.lang.String> arbString
        +
        An arbitrary implementation for string values.
        +
        • +
      + + + +
        +
      • +

        arbUSASCIIString

        +
        public static final Gen<java.lang.String> arbUSASCIIString
        +
        An arbitrary implementation for string values with characters in the US-ASCII range.
        +
        • +
      + + + +
        +
      • +

        arbAlphaNumString

        +
        public static final Gen<java.lang.String> arbAlphaNumString
        +
        An arbitrary implementation for string values with alpha-numeric characters.
        +
        • +
      + + + +
        +
      • +

        arbStringBuffer

        +
        public static final Gen<java.lang.StringBuffer> arbStringBuffer
        +
        An arbitrary implementation for string buffer values.
        +
        • +
      + + + +
        +
      • +

        arbStringBuilder

        +
        public static final Gen<java.lang.StringBuilder> arbStringBuilder
        +
        An arbitrary implementation for string builder values.
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static final Gen<java.lang.Throwable> arbThrowable
        +
        An arbitrary implementation for throwables.
        +
        • +
      + + + +
        +
      • +

        arbBitSet

        +
        public static final Gen<java.util.BitSet> arbBitSet
        +
        An arbitrary implementation for bit sets.
        +
        • +
      + + + +
        +
      • +

        arbCalendar

        +
        public static final Gen<java.util.Calendar> arbCalendar
        +
        An arbitrary implementation for calendars.
        +
        • +
      + + + +
        +
      • +

        arbDate

        +
        public static final Gen<java.util.Date> arbDate
        +
        An arbitrary implementation for dates.
        +
        • +
      + + + +
        +
      • +

        arbGregorianCalendar

        +
        public static final Gen<java.util.GregorianCalendar> arbGregorianCalendar
        +
        An arbitrary implementation for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        arbProperties

        +
        public static final Gen<java.util.Properties> arbProperties
        +
        An arbitrary implementation for properties.
        +
        • +
      + + + +
        +
      • +

        arbSQLDate

        +
        public static final Gen<java.sql.Date> arbSQLDate
        +
        An arbitrary implementation for SQL dates.
        +
        • +
      + + + +
        +
      • +

        arbTime

        +
        public static final Gen<java.sql.Time> arbTime
        +
        An arbitrary implementation for SQL times.
        +
        • +
      + + + +
        +
      • +

        arbTimestamp

        +
        public static final Gen<java.sql.Timestamp> arbTimestamp
        +
        An arbitrary implementation for SQL time stamps.
        +
        • +
      + + + +
        +
      • +

        arbBigInteger

        +
        public static final Gen<java.math.BigInteger> arbBigInteger
        +
        An arbitrary implementation for big integers.
        +
        • +
      + + + +
        +
      • +

        arbBigDecimal

        +
        public static final Gen<java.math.BigDecimal> arbBigDecimal
        +
        An arbitrary implementation for big decimals.
        +
        • +
      + + + +
        +
      • +

        arbNatural

        +
        public static final Gen<fj.data.Natural> arbNatural
        +
        An arbitrary implementation for naturals.
        +
        • +
      + + + +
        +
      • +

        arbLocale

        +
        public static final Gen<java.util.Locale> arbLocale
        +
        An arbitrary implementation for locales.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Arbitrary

        +
        public Arbitrary()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        arbF

        +
        public static <A,B> Gen<fj.F<A,B>> arbF(Cogen<A> c,
+                                        Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        c - The cogen for the function domain.
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbReader

        +
        public static <A,B> Gen<fj.data.Reader<A,B>> arbReader(Cogen<A> aa,
+                                                       Gen<B> ab)
        +
        • +
      + + + +
        +
      • +

        arbState

        +
        public static <S,A> Gen<fj.data.State<S,A>> arbState(Gen<S> as,
+                                                     Cogen<S> cs,
+                                                     Gen<A> aa)
        +
        An arbitrary for state.
        +
        • +
      + + + +
        +
      • +

        arbParModule

        +
        public static Gen<fj.control.parallel.ParModule> arbParModule()
        +
        • +
      + + + +
        +
      • +

        arbStrategy

        +
        public static <A> Gen<fj.control.parallel.Strategy<A>> arbStrategy()
        +
        • +
      + + + +
        +
      • +

        arbLcgRng

        +
        public static <A> Gen<fj.LcgRng> arbLcgRng()
        +
        An arbitrary for the LcgRng.
        +
        • +
      + + + +
        +
      • +

        arbFInvariant

        +
        public static <A,B> Gen<fj.F<A,B>> arbFInvariant(Gen<B> a)
        +
        An arbitrary for functions.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for functions.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2(Cogen<A> ca,
+                                              Cogen<B> cb,
+                                              Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF2Invariant

        +
        public static <A,B,C> Gen<fj.F2<A,B,C>> arbF2Invariant(Gen<C> a)
        +
        An arbitrary for function-2.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-2.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc,
+                                                  Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF3Invariant

        +
        public static <A,B,C,D> Gen<fj.F3<A,B,C,D>> arbF3Invariant(Gen<D> a)
        +
        An arbitrary for function-3.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-3.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd,
+                                                      Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF4Invariant

        +
        public static <A,B,C,D,E> Gen<fj.F4<A,B,C,D,E>> arbF4Invariant(Gen<E> a)
        +
        An arbitrary for function-4.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-4.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5(Cogen<A> ca,
+                                                            Cogen<B> cb,
+                                                            Cogen<C> cc,
+                                                            Cogen<D> cd,
+                                                            Cogen<E> ce,
+                                                            Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF5Invariant

        +
        public static <A,B,C,D,E,F$> Gen<fj.F5<A,B,C,D,E,F$>> arbF5Invariant(Gen<F$> a)
        +
        An arbitrary for function-5.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-5.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf,
+                                                                Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF6Invariant

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.F6<A,B,C,D,E,F$,G>> arbF6Invariant(Gen<G> a)
        +
        An arbitrary for function-6.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-6.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg,
+                                                                    Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF7Invariant

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.F7<A,B,C,D,E,F$,G,H>> arbF7Invariant(Gen<H> a)
        +
        An arbitrary for function-7.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-7.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch,
+                                                                        Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        ca - A cogen for the part of the domain of the function.
        +
        cb - A cogen for the part of the domain of the function.
        +
        cc - A cogen for the part of the domain of the function.
        +
        cd - A cogen for the part of the domain of the function.
        +
        ce - A cogen for the part of the domain of the function.
        +
        cf - A cogen for the part of the domain of the function.
        +
        cg - A cogen for the part of the domain of the function.
        +
        ch - A cogen for the part of the domain of the function.
        +
        a - An arbitrary for the codomain of the function.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbF8Invariant

        +
        public static <A,B,C,D,E,F$,G,H,I> Gen<fj.F8<A,B,C,D,E,F$,G,H,I>> arbF8Invariant(Gen<I> a)
        +
        An arbitrary for function-8.
        +
        +
        Parameters:
        +
        a - The arbitrary for the function codomain.
        +
        Returns:
        +
        An arbitrary for function-8.
        +
        +
        • +
      + + + +
        +
      • +

        arbGen

        +
        public static <A> Gen<Gen<A>> arbGen(Gen<A> aa)
        +
        Returns an arbitrary implementation for generators.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the generator is defined.
        +
        Returns:
        +
        An arbitrary implementation for generators.
        +
        +
        • +
      + + + +
        +
      • +

        arbOption

        +
        public static <A> Gen<fj.data.Option<A>> arbOption(Gen<A> aa)
        +
        Returns an arbitrary implementation for optional values.
        +
        +
        Parameters:
        +
        aa - an arbitrary implementation for the type over which the optional value is defined.
        +
        Returns:
        +
        An arbitrary implementation for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        arbEither

        +
        public static <A,B> Gen<fj.data.Either<A,B>> arbEither(Gen<A> aa,
+                                                       Gen<B> ab)
        +
        Returns an arbitrary implementation for the disjoint union.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        ab - An arbitrary implementation for the type over which one side of the disjoint union is + defined.
        +
        Returns:
        +
        An arbitrary implementation for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        arbList

        +
        public static <A> Gen<fj.data.List<A>> arbList(Gen<A> aa)
        +
        Returns an arbitrary implementation for lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the list is defined.
        +
        Returns:
        +
        An arbitrary implementation for lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbListInteger

        +
        public static <A> Gen<fj.data.List<java.lang.Integer>> arbListInteger()
        +
        Returns an arbitrary list of integers.
        +
        • +
      + + + +
        +
      • +

        arbListString

        +
        public static <A> Gen<fj.data.List<java.lang.String>> arbListString()
        +
        Returns an arbitrary list of strings.
        +
        • +
      + + + +
        +
      • +

        arbListBoolean

        +
        public static <A> Gen<fj.data.List<java.lang.Boolean>> arbListBoolean()
        +
        Returns an arbitrary list of booleans.
        +
        • +
      + + + +
        +
      • +

        arbListDouble

        +
        public static <A> Gen<fj.data.List<java.lang.Double>> arbListDouble()
        +
        Returns an arbitrary list of doubles.
        +
        • +
      + + + +
        +
      • +

        arbNonEmptyList

        +
        public static <A> Gen<fj.data.NonEmptyList<A>> arbNonEmptyList(Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbValidation

        +
        public static <A,B> Gen<fj.data.Validation<A,B>> arbValidation(Gen<A> aa,
+                                                               Gen<B> ab)
        +
        Returns an arbitrary Validation for the given arbitrary parameters.
        +
        • +
      + + + +
        +
      • +

        arbStream

        +
        public static <A> Gen<fj.data.Stream<A>> arbStream(Gen<A> aa)
        +
        Returns an arbitrary implementation for streams.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stream is defined.
        +
        Returns:
        +
        An arbitrary implementation for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arbArray

        +
        public static <A> Gen<fj.data.Array<A>> arbArray(Gen<A> aa)
        +
        Returns an arbitrary implementation for arrays.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array is defined.
        +
        Returns:
        +
        An arbitrary implementation for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        arbSeq

        +
        public static <A> Gen<fj.data.Seq<A>> arbSeq(Gen<A> aa)
        +
        Returns an arbitrary implementation for sequences.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the sequence is defined.
        +
        Returns:
        +
        An arbitrary implementation for sequences.
        +
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa)
        +
        • +
      + + + +
        +
      • +

        arbSet

        +
        public static <A> Gen<fj.data.Set<A>> arbSet(fj.Ord<A> ord,
+                                             Gen<A> aa,
+                                             int max)
        +
        • +
      + + + +
        +
      • +

        arbThrowable

        +
        public static Gen<java.lang.Throwable> arbThrowable(Gen<java.lang.String> as)
        +
        Returns an arbitrary implementation for throwables.
        +
        +
        Parameters:
        +
        as - An arbitrary used for the throwable message.
        +
        Returns:
        +
        An arbitrary implementation for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayList

        +
        public static <A> Gen<java.util.ArrayList<A>> arbArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array list is defined.
        +
        Returns:
        +
        An arbitrary implementation for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumValue

        +
        public static <A extends java.lang.Enum<A>> Gen<A> arbEnumValue(java.lang.Class<A> clazz)
        +
        Returns an arbitrary implementation for a Java enumeration.
        +
        +
        Parameters:
        +
        clazz - The type of enum to return an arbitrary of.
        +
        Returns:
        +
        An arbitrary for instances of the supplied enum type.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Gen<java.util.EnumMap<K,V>> arbEnumMap(Gen<K> ak,
+                                                                                     Gen<V> av)
        +
        Returns an arbitrary implementation for enum maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the enum map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the enum map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbEnumSet

        +
        public static <A extends java.lang.Enum<A>> Gen<java.util.EnumSet<A>> arbEnumSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for enum sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the enum set is defined.
        +
        Returns:
        +
        An arbitrary implementation for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashMap

        +
        public static <K,V> Gen<java.util.HashMap<K,V>> arbHashMap(Gen<K> ak,
+                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashSet

        +
        public static <A> Gen<java.util.HashSet<A>> arbHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbHashtable

        +
        public static <K,V> Gen<java.util.Hashtable<K,V>> arbHashtable(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for hash tables.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the hash table's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the hash table's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        arbIdentityHashMap

        +
        public static <K,V> Gen<java.util.IdentityHashMap<K,V>> arbIdentityHashMap(Gen<K> ak,
+                                                                           Gen<V> av)
        +
        Returns an arbitrary implementation for identity hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the identity hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the identity hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashMap

        +
        public static <K,V> Gen<java.util.LinkedHashMap<K,V>> arbLinkedHashMap(Gen<K> ak,
+                                                                       Gen<V> av)
        +
        Returns an arbitrary implementation for linked hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the linked hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the linked hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedHashSet

        +
        public static <A> Gen<java.util.LinkedHashSet<A>> arbLinkedHashSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for hash sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the hash set is defined.
        +
        Returns:
        +
        An arbitrary implementation for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedList

        +
        public static <A> Gen<java.util.LinkedList<A>> arbLinkedList(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked list is defined.
        +
        Returns:
        +
        An arbitrary implementation for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityQueue

        +
        public static <A> Gen<java.util.PriorityQueue<A>> arbPriorityQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbStack

        +
        public static <A> Gen<java.util.Stack<A>> arbStack(Gen<A> aa)
        +
        Returns an arbitrary implementation for stacks.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the stack is defined.
        +
        Returns:
        +
        An arbitrary implementation for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        arbJavaTreeMap

        +
        public static <K,V> Gen<java.util.TreeMap<K,V>> arbJavaTreeMap(Gen<K> ak,
+                                                               Gen<V> av)
        +
        Returns an arbitrary implementation for java.util tree maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the tree map's keys are defined.
        +
        av - An arbitrary implementation for the type over which the tree map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<fj.data.List<fj.P2<K,V>>> al)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av)
        +
        Returns an arbitrary implementation for tree maps.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         Gen<java.lang.Integer> ai)
        +
        Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
        +
        • +
      + + + +
        +
      • +

        arbTreeMap

        +
        public static <K,V> Gen<fj.data.TreeMap<K,V>> arbTreeMap(fj.Ord<K> ord,
+                                                         Gen<K> ak,
+                                                         Gen<V> av,
+                                                         int maxSize)
        +
        Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
        +
        • +
      + + + +
        +
      • +

        arbTreeSet

        +
        public static <A> Gen<java.util.TreeSet<A>> arbTreeSet(Gen<A> aa)
        +
        Returns an arbitrary implementation for tree sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the tree set is defined.
        +
        Returns:
        +
        An arbitrary implementation for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbVector

        +
        public static <A> Gen<java.util.Vector<A>> arbVector(Gen<A> aa)
        +
        Returns an arbitrary implementation for vectors.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the vector is defined.
        +
        Returns:
        +
        An arbitrary implementation for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        arbWeakHashMap

        +
        public static <K,V> Gen<java.util.WeakHashMap<K,V>> arbWeakHashMap(Gen<K> ak,
+                                                                   Gen<V> av)
        +
        Returns an arbitrary implementation for weak hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the weak hash map's keys are + defined.
        +
        av - An arbitrary implementation for the type over which the weak hash map's values are + defined.
        +
        Returns:
        +
        An arbitrary implementation for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbArrayBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.ArrayBlockingQueue<A>> arbArrayBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for array blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the array blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentHashMap

        +
        public static <K,V> Gen<java.util.concurrent.ConcurrentHashMap<K,V>> arbConcurrentHashMap(Gen<K> ak,
+                                                                                          Gen<V> av)
        +
        Returns an arbitrary implementation for concurrent hash maps.
        +
        +
        Parameters:
        +
        ak - An arbitrary implementation for the type over which the concurrent hash map's keys + are defined.
        +
        av - An arbitrary implementation for the type over which the concurrent hash map's values + are defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        arbConcurrentLinkedQueue

        +
        public static <A> Gen<java.util.concurrent.ConcurrentLinkedQueue<A>> arbConcurrentLinkedQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for concurrent linked queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the concurrent linked queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArrayList

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArrayList<A>> arbCopyOnWriteArrayList(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array lists.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array list is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        arbCopyOnWriteArraySet

        +
        public static <A> Gen<java.util.concurrent.CopyOnWriteArraySet<A>> arbCopyOnWriteArraySet(Gen<A> aa)
        +
        Returns an arbitrary implementation for copy-on-write array sets.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the copy-on-write array set is + defined.
        +
        Returns:
        +
        An arbitrary implementation for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        arbDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Gen<java.util.concurrent.DelayQueue<A>> arbDelayQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for delay queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the delay queue is defined.
        +
        Returns:
        +
        An arbitrary implementation for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbLinkedBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.LinkedBlockingQueue<A>> arbLinkedBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for linked blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the linked blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbPriorityBlockingQueue

        +
        public static <A> Gen<java.util.concurrent.PriorityBlockingQueue<A>> arbPriorityBlockingQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbSynchronousQueue

        +
        public static <A> Gen<java.util.concurrent.SynchronousQueue<A>> arbSynchronousQueue(Gen<A> aa)
        +
        Returns an arbitrary implementation for priority blocking queues.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the priority blocking queue is + defined.
        +
        Returns:
        +
        An arbitrary implementation for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        arbP1

        +
        public static <A> Gen<fj.P1<A>> arbP1(Gen<A> aa)
        +
        Returns an arbitrary implementation for product-1 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for the type over which the product-1 is defined.
        +
        Returns:
        +
        An arbitrary implementation for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP2

        +
        public static <A,B> Gen<fj.P2<A,B>> arbP2(Gen<A> aa,
+                                          Gen<B> ab)
        +
        Returns an arbitrary implementation for product-2 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-2 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP3

        +
        public static <A,B,C> Gen<fj.P3<A,B,C>> arbP3(Gen<A> aa,
+                                              Gen<B> ab,
+                                              Gen<C> ac)
        +
        Returns an arbitrary implementation for product-3 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-3 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP4

        +
        public static <A,B,C,D> Gen<fj.P4<A,B,C,D>> arbP4(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Gen<C> ac,
+                                                  Gen<D> ad)
        +
        Returns an arbitrary implementation for product-4 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-4 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP5

        +
        public static <A,B,C,D,E> Gen<fj.P5<A,B,C,D,E>> arbP5(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Gen<D> ad,
+                                                      Gen<E> ae)
        +
        Returns an arbitrary implementation for product-5 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-5 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP6

        +
        public static <A,B,C,D,E,F$> Gen<fj.P6<A,B,C,D,E,F$>> arbP6(Gen<A> aa,
+                                                            Gen<B> ab,
+                                                            Gen<C> ac,
+                                                            Gen<D> ad,
+                                                            Gen<E> ae,
+                                                            Gen<F$> af)
        +
        Returns an arbitrary implementation for product-6 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-6 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP7

        +
        public static <A,B,C,D,E,F$,G> Gen<fj.P7<A,B,C,D,E,F$,G>> arbP7(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Gen<F$> af,
+                                                                Gen<G> ag)
        +
        Returns an arbitrary implementation for product-7 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-7 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        arbP8

        +
        public static <A,B,C,D,E,F$,G,H> Gen<fj.P8<A,B,C,D,E,F$,G,H>> arbP8(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Gen<G> ag,
+                                                                    Gen<H> ah)
        +
        Returns an arbitrary implementation for product-8 values.
        +
        +
        Parameters:
        +
        aa - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ab - An Arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ac - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ad - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ae - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        af - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ag - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        ah - An arbitrary implementation for one of the types over which the product-8 is + defined.
        +
        Returns:
        +
        An arbitrary implementation for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Arg.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Arg.html new file mode 100644 index 0000000..b29a951 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Arg.html @@ -0,0 +1,328 @@ + + + + + +Arg (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Arg<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Arg<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Arg<T>
+extends java.lang.Object
    +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<Arg<?>>argShow +
      The rendering of an argument (uses Object.toString() for the argument value).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> Arg<T>arg(T value, + int shrinks) +
      Construct a property argument with the given value and number of shrinks.
      +
      intshrinks() +
      Returns the argument's number of shrinks following falsification.
      +
      java.lang.Objectvalue() +
      Returns the argument's value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        argShow

        +
        public static final fj.Show<Arg<?>> argShow
        +
        The rendering of an argument (uses Object.toString() for the argument value).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        arg

        +
        public static <T> Arg<T> arg(T value,
+                             int shrinks)
        +
        Construct a property argument with the given value and number of shrinks.
        +
        +
        Parameters:
        +
        value - The value to construct an argument with.
        +
        shrinks - The number of shrinks to construct an argument with.
        +
        Returns:
        +
        A new argument.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public java.lang.Object value()
        +
        Returns the argument's value.
        +
        +
        Returns:
        +
        The argument's value.
        +
        +
        • +
      + + + +
        +
      • +

        shrinks

        +
        public int shrinks()
        +
        Returns the argument's number of shrinks following falsification.
        +
        +
        Returns:
        +
        The argument's number of shrinks following falsification.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Bool.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Bool.html new file mode 100644 index 0000000..3ad3ccb --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Bool.html @@ -0,0 +1,374 @@ + + + + + +Bool (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Bool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Bool
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bool
+extends java.lang.Object
    +
    A boolean wrapper that works well with properties.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Boolbool(boolean b) +
      Construct a Bool from the given value.
      +
      Propertyimplies(Bool c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(boolean c) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(fj.F0<Property> p) +
      Returns a property that produces a result only if this value is true.
      +
      Propertyimplies(Property p) +
      Returns a property that produces a result only if this value is true.
      +
      booleanis() +
      Returns true if this value is true, false otherwise.
      +
      booleanisNot() +
      Returns false if this value is true, true otherwise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        is

        +
        public boolean is()
        +
        Returns true if this value is true, false otherwise.
        +
        +
        Returns:
        +
        true if this value is true, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNot

        +
        public boolean isNot()
        +
        Returns false if this value is true, true otherwise.
        +
        +
        Returns:
        +
        false if this value is true, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(fj.F0<Property> p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Property p)
        +
        Returns a property that produces a result only if this value is true. The result will be taken + from the given property.
        +
        +
        Parameters:
        +
        p - The property to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(Bool c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public Property implies(boolean c)
        +
        Returns a property that produces a result only if this value is true.
        +
        +
        Parameters:
        +
        c - The value to construct a property with to return if this value is true.
        +
        Returns:
        +
        a property that produces a result only if this value is true.
        +
        +
        • +
      + + + +
        +
      • +

        bool

        +
        public static Bool bool(boolean b)
        +
        Construct a Bool from the given value.
        +
        +
        Parameters:
        +
        b - The value to construct a Bool with.
        +
        Returns:
        +
        A Bool from the given value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/CheckResult.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/CheckResult.html new file mode 100644 index 0000000..bd497b4 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/CheckResult.html @@ -0,0 +1,712 @@ + + + + + +CheckResult (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class CheckResult

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.CheckResult
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class CheckResult
+extends java.lang.Object
    +
    An enumeration of the possible results after checking a property. A CheckResult may + be in one of six states: +
      +
    1. Passed
      2. +
    2. Proven
      3. +
    3. Falsified
      4. +
    4. Exhausted
      5. +
    5. Exception executing the property
      6. +
    6. Exception generating values to check the property
      7. +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static fj.Show<CheckResult>summary +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
      +
      intdiscarded() +
      Returns the number of discarded checks of the property in this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
      +
      static CheckResultexhausted(int succeeded, + int discarded) +
      Returns a result that the property been exhausted in checking.
      +
      static CheckResultfalsified(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been falsified.
      +
      static CheckResultgenException(java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that generating values to check the property threw an exception.
      +
      booleanisExhausted() +
      Returns true if this result is exhausted, false otherwise.
      +
      booleanisFalsified() +
      Returns true if this result is falsified, false otherwise.
      +
      booleanisGenException() +
      Returns true if this result is an exception during generating of values for + property checking, false otherwise.
      +
      booleanisPassed() +
      Returns true if this result is passed, false otherwise.
      +
      booleanisPropException() +
      Returns true if this result is an exception during property execution, + false otherwise.
      +
      booleanisProven() +
      Returns true if this result is proven, false otherwise.
      +
      static CheckResultpassed(int succeeded, + int discarded) +
      Returns a result that the property has passed.
      +
      static CheckResultpropException(fj.data.List<Arg<?>> args, + java.lang.Throwable ex, + int succeeded, + int discarded) +
      Returns a result that checking the property threw an exception.
      +
      static CheckResultproven(fj.data.List<Arg<?>> args, + int succeeded, + int discarded) +
      Returns a result that the property has been proven.
      +
      intsucceeded() +
      Returns the number of succeeded checks of the property in this result.
      +
      static fj.Show<CheckResult>summary(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line.
      +
      static fj.Show<CheckResult>summaryEx(fj.Show<Arg<?>> sa) +
      A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        summary

        +
        public static final fj.Show<CheckResult> summary
        +
        A rendering of a check result that summarises in one line.
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static final fj.Show<CheckResult> summaryEx
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        passed

        +
        public static CheckResult passed(int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has passed.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has passed.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static CheckResult proven(fj.data.List<Arg<?>> args,
+                                 int succeeded,
+                                 int discarded)
        +
        Returns a result that the property has been proven.
        +
        +
        Parameters:
        +
        args - The arguments used to prove the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been proven.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static CheckResult falsified(fj.data.List<Arg<?>> args,
+                                    int succeeded,
+                                    int discarded)
        +
        Returns a result that the property has been falsified.
        +
        +
        Parameters:
        +
        args - The arguments used to falsify the property.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been falsified.
        +
        +
        • +
      + + + +
        +
      • +

        exhausted

        +
        public static CheckResult exhausted(int succeeded,
+                                    int discarded)
        +
        Returns a result that the property been exhausted in checking.
        +
        +
        Parameters:
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that the property has been exhausted in checking.
        +
        +
        • +
      + + + +
        +
      • +

        propException

        +
        public static CheckResult propException(fj.data.List<Arg<?>> args,
+                                        java.lang.Throwable ex,
+                                        int succeeded,
+                                        int discarded)
        +
        Returns a result that checking the property threw an exception.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception was thrown.
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that checking the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        genException

        +
        public static CheckResult genException(java.lang.Throwable ex,
+                                       int succeeded,
+                                       int discarded)
        +
        Returns a result that generating values to check the property threw an exception.
        +
        +
        Parameters:
        +
        ex - The exception that was thrown.
        +
        succeeded - The number of checks that succeeded.
        +
        discarded - The number of checks that were discarded.
        +
        Returns:
        +
        A result that generating values to check the property threw an exception.
        +
        +
        • +
      + + + +
        +
      • +

        isPassed

        +
        public boolean isPassed()
        +
        Returns true if this result is passed, false otherwise.
        +
        +
        Returns:
        +
        true if this result is passed, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven, false otherwise.
        +
        +
        Returns:
        +
        true if this result is proven, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified, false otherwise.
        +
        +
        Returns:
        +
        true if this result is falsified, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isExhausted

        +
        public boolean isExhausted()
        +
        Returns true if this result is exhausted, false otherwise.
        +
        +
        Returns:
        +
        true if this result is exhausted, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isPropException

        +
        public boolean isPropException()
        +
        Returns true if this result is an exception during property execution, + false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during property execution, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isGenException

        +
        public boolean isGenException()
        +
        Returns true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        Returns:
        +
        true if this result is an exception during generating of values for + property checking, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        Returns:
        +
        The arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        Returns:
        +
        The execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
        +
        +
        • +
      + + + +
        +
      • +

        succeeded

        +
        public int succeeded()
        +
        Returns the number of succeeded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of succeeded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        discarded

        +
        public int discarded()
        +
        Returns the number of discarded checks of the property in this result.
        +
        +
        Returns:
        +
        The number of discarded checks of the property in this result.
        +
        +
        • +
      + + + +
        +
      • +

        summary

        +
        public static fj.Show<CheckResult> summary(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line.
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line.
        +
        +
        • +
      + + + +
        +
      • +

        summaryEx

        +
        public static fj.Show<CheckResult> summaryEx(fj.Show<Arg<?>> sa)
        +
        A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
        +
        +
        Parameters:
        +
        sa - The rendering of arguments.
        +
        Returns:
        +
        A rendering of a check result that summarises in one line but throws an exception in + the result is a failure (falsified, property exception or generator exception).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Cogen.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Cogen.html new file mode 100644 index 0000000..f347f9e --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Cogen.html @@ -0,0 +1,2005 @@ + + + + + +Cogen (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.test
+

Class Cogen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Cogen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Cogen<A>
+extends java.lang.Object
    +
    Transforms a type and a generator to produce a new generator. This function is used to generate + gen functions.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        cogenBoolean

        +
        public static final Cogen<java.lang.Boolean> cogenBoolean
        +
        A cogen for booleans.
        +
        • +
      + + + +
        +
      • +

        cogenInteger

        +
        public static final Cogen<java.lang.Integer> cogenInteger
        +
        A cogen for integers.
        +
        • +
      + + + +
        +
      • +

        cogenByte

        +
        public static final Cogen<java.lang.Byte> cogenByte
        +
        A cogen for bytes.
        +
        • +
      + + + +
        +
      • +

        cogenShort

        +
        public static final Cogen<java.lang.Short> cogenShort
        +
        A cogen for shorts.
        +
        • +
      + + + +
        +
      • +

        cogenLong

        +
        public static final Cogen<java.lang.Long> cogenLong
        +
        A cogen for longs.
        +
        • +
      + + + +
        +
      • +

        cogenCharacter

        +
        public static final Cogen<java.lang.Character> cogenCharacter
        +
        A cogen for characters.
        +
        • +
      + + + +
        +
      • +

        cogenFloat

        +
        public static final Cogen<java.lang.Float> cogenFloat
        +
        A cogen for floats.
        +
        • +
      + + + +
        +
      • +

        cogenDouble

        +
        public static final Cogen<java.lang.Double> cogenDouble
        +
        A cogen for doubles.
        +
        • +
      + + + +
        +
      • +

        cogenString

        +
        public static final Cogen<java.lang.String> cogenString
        +
        A cogen for strings.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuffer

        +
        public static final Cogen<java.lang.StringBuffer> cogenStringBuffer
        +
        A cogen for string buffers.
        +
        • +
      + + + +
        +
      • +

        cogenStringBuilder

        +
        public static final Cogen<java.lang.StringBuilder> cogenStringBuilder
        +
        A cogen for string builders.
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static final Cogen<java.lang.Throwable> cogenThrowable
        +
        A cogen for throwables.
        +
        • +
      + + + +
        +
      • +

        cogenBitSet

        +
        public static final Cogen<java.util.BitSet> cogenBitSet
        +
        A cogen for bit sets.
        +
        • +
      + + + +
        +
      • +

        cogenCalendar

        +
        public static final Cogen<java.util.Calendar> cogenCalendar
        +
        A cogen for calendars.
        +
        • +
      + + + +
        +
      • +

        cogenDate

        +
        public static final Cogen<java.util.Date> cogenDate
        +
        A cogen for dates.
        +
        • +
      + + + +
        +
      • +

        cogenGregorianCalendar

        +
        public static final Cogen<java.util.GregorianCalendar> cogenGregorianCalendar
        +
        A cogen for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        cogenProperties

        +
        public static final Cogen<java.util.Properties> cogenProperties
        +
        A cogen for properties.
        +
        • +
      + + + +
        +
      • +

        cogenSQLDate

        +
        public static final Cogen<java.sql.Date> cogenSQLDate
        +
        • +
      + + + +
        +
      • +

        cogenTimestamp

        +
        public static final Cogen<java.sql.Timestamp> cogenTimestamp
        +
        • +
      + + + +
        +
      • +

        cogenTime

        +
        public static final Cogen<java.sql.Time> cogenTime
        +
        • +
      + + + +
        +
      • +

        cogenBigInteger

        +
        public static final Cogen<java.math.BigInteger> cogenBigInteger
        +
        • +
      + + + +
        +
      • +

        cogenBigDecimal

        +
        public static final Cogen<java.math.BigDecimal> cogenBigDecimal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Cogen

        +
        public Cogen()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cogen

        +
        public abstract <B> Gen<B> cogen(A a,
+                                 Gen<B> g)
        +
        Transforms the given value and generator to a new generator with a high probability of being + independent.
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A new generator with a high probability of being independent.
        +
        +
        • +
      + + + + + +
        +
      • +

        cogen

        +
        public final <B> fj.F<Gen<B>,Gen<B>> cogen(A a)
        +
        A curried version of cogen(Object, Gen).
        +
        +
        Parameters:
        +
        a - The value to produce the generator from.
        +
        Returns:
        +
        A curried version of cogen(Object, Gen).
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public final <B> Cogen<B> compose(fj.F<B,A> f)
        +
        Composes the given function with this cogen to produce a new cogen.
        +
        +
        Parameters:
        +
        f - The function to compose.
        +
        Returns:
        +
        A new cogen composed with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public final <B> Cogen<B> contramap(fj.F<B,A> f)
        +
        Contra-maps this cogen using the given function.
        +
        +
        Parameters:
        +
        f - The function to co-map with.
        +
        Returns:
        +
        A contra-mapped cogen.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF

        +
        public static <A,B> Cogen<fj.F<A,B>> cogenF(Gen<A> a,
+                                            Cogen<B> c)
        +
        A cogen for a function.
        +
        +
        Parameters:
        +
        a - A gen for the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF2

        +
        public static <A,B,C> Cogen<fj.F2<A,B,C>> cogenF2(Gen<A> aa,
+                                                  Gen<B> ab,
+                                                  Cogen<C> c)
        +
        A cogen for a function-2.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-2.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF3

        +
        public static <A,B,C,D> Cogen<fj.F3<A,B,C,D>> cogenF3(Gen<A> aa,
+                                                      Gen<B> ab,
+                                                      Gen<C> ac,
+                                                      Cogen<D> c)
        +
        A cogen for a function-3.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-3.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF4

        +
        public static <A,B,C,D,E> Cogen<fj.F4<A,B,C,D,E>> cogenF4(Gen<A> aa,
+                                                          Gen<B> ab,
+                                                          Gen<C> ac,
+                                                          Gen<D> ad,
+                                                          Cogen<E> c)
        +
        A cogen for a function-4.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-4.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF5

        +
        public static <A,B,C,D,E,F$> Cogen<fj.F5<A,B,C,D,E,F$>> cogenF5(Gen<A> aa,
+                                                                Gen<B> ab,
+                                                                Gen<C> ac,
+                                                                Gen<D> ad,
+                                                                Gen<E> ae,
+                                                                Cogen<F$> c)
        +
        A cogen for a function-5.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-5.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF6

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.F6<A,B,C,D,E,F$,G>> cogenF6(Gen<A> aa,
+                                                                    Gen<B> ab,
+                                                                    Gen<C> ac,
+                                                                    Gen<D> ad,
+                                                                    Gen<E> ae,
+                                                                    Gen<F$> af,
+                                                                    Cogen<G> c)
        +
        A cogen for a function-6.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-6.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF7

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.F7<A,B,C,D,E,F$,G,H>> cogenF7(Gen<A> aa,
+                                                                        Gen<B> ab,
+                                                                        Gen<C> ac,
+                                                                        Gen<D> ad,
+                                                                        Gen<E> ae,
+                                                                        Gen<F$> af,
+                                                                        Gen<G> ag,
+                                                                        Cogen<H> c)
        +
        A cogen for a function-7.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-7.
        +
        +
        • +
      + + + +
        +
      • +

        cogenF8

        +
        public static <A,B,C,D,E,F$,G,H,I> Cogen<fj.F8<A,B,C,D,E,F$,G,H,I>> cogenF8(Gen<A> aa,
+                                                                            Gen<B> ab,
+                                                                            Gen<C> ac,
+                                                                            Gen<D> ad,
+                                                                            Gen<E> ae,
+                                                                            Gen<F$> af,
+                                                                            Gen<G> ag,
+                                                                            Gen<H> ah,
+                                                                            Cogen<I> c)
        +
        A cogen for a function-8.
        +
        +
        Parameters:
        +
        aa - A gen for part of the domain of the function.
        +
        ab - A gen for part of the domain of the function.
        +
        ac - A gen for part of the domain of the function.
        +
        ad - A gen for part of the domain of the function.
        +
        ae - A gen for part of the domain of the function.
        +
        af - A gen for part of the domain of the function.
        +
        ag - A gen for part of the domain of the function.
        +
        ah - A gen for part of the domain of the function.
        +
        c - A cogen for the codomain of the function.
        +
        Returns:
        +
        A cogen for a function-8.
        +
        +
        • +
      + + + +
        +
      • +

        cogenOption

        +
        public static <A> Cogen<fj.data.Option<A>> cogenOption(Cogen<A> ca)
        +
        A cogen for the optional value.
        +
        +
        Parameters:
        +
        ca - A cogen for the type of the optional value.
        +
        Returns:
        +
        A cogen for the optional value.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEither

        +
        public static <A,B> Cogen<fj.data.Either<A,B>> cogenEither(Cogen<A> ca,
+                                                           Cogen<B> cb)
        +
        A cogen for the disjoint union.
        +
        +
        Parameters:
        +
        ca - A cogen for one side of the disjoint union.
        +
        cb - A cogen for one side of the disjoint union.
        +
        Returns:
        +
        A cogen for the disjoint union.
        +
        +
        • +
      + + + +
        +
      • +

        cogenList

        +
        public static <A> Cogen<fj.data.List<A>> cogenList(Cogen<A> ca)
        +
        A cogen for lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the list.
        +
        Returns:
        +
        A cogen for lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStream

        +
        public static <A> Cogen<fj.data.Stream<A>> cogenStream(Cogen<A> ca)
        +
        A cogen for streams.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the stream.
        +
        Returns:
        +
        A cogen for streams.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLcgRng

        +
        public static Cogen<fj.LcgRng> cogenLcgRng()
        +
        A cogen for the provided LcgRng
        +
        +
        Returns:
        +
        A cogen for the provided LcgRng.
        +
        +
        • +
      + + + +
        +
      • +

        cogenState

        +
        public static <S,A> Cogen<fj.data.State<S,A>> cogenState(Gen<S> as,
+                                                         fj.F2<S,A,java.lang.Long> f)
        +
        A cogen for state.
        +
        • +
      + + + +
        +
      • +

        cogenArray

        +
        public static <A> Cogen<fj.data.Array<A>> cogenArray(Cogen<A> ca)
        +
        A cogen for arrays.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array.
        +
        Returns:
        +
        A cogen for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        cogenThrowable

        +
        public static Cogen<java.lang.Throwable> cogenThrowable(Cogen<java.lang.String> cs)
        +
        A cogen for throwables.
        +
        +
        Parameters:
        +
        cs - A cogen for the throwable message.
        +
        Returns:
        +
        A cogen for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayList

        +
        public static <A> Cogen<java.util.ArrayList<A>> cogenArrayList(Cogen<A> ca)
        +
        A cogen for array lists.
        +
        +
        Parameters:
        +
        ca - A cogen for the elements of the array list.
        +
        Returns:
        +
        A cogen for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Cogen<java.util.EnumMap<K,V>> cogenEnumMap(Cogen<K> ck,
+                                                                                         Cogen<V> cv)
        +
        A cogen for enum maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenEnumSet

        +
        public static <A extends java.lang.Enum<A>> Cogen<java.util.EnumSet<A>> cogenEnumSet(Cogen<A> c)
        +
        A cogen for enum sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the enum set.
        +
        Returns:
        +
        A cogen for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashMap

        +
        public static <K,V> Cogen<java.util.HashMap<K,V>> cogenHashMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashSet

        +
        public static <A> Cogen<java.util.HashSet<A>> cogenHashSet(Cogen<A> c)
        +
        A cogen for hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the hash set.
        +
        Returns:
        +
        A cogen for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenHashtable

        +
        public static <K,V> Cogen<java.util.Hashtable<K,V>> cogenHashtable(Cogen<K> ck,
+                                                                   Cogen<V> cv)
        +
        A cogen for hash tables.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        cogenIdentityHashMap

        +
        public static <K,V> Cogen<java.util.IdentityHashMap<K,V>> cogenIdentityHashMap(Cogen<K> ck,
+                                                                               Cogen<V> cv)
        +
        A cogen for identity hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashMap

        +
        public static <K,V> Cogen<java.util.LinkedHashMap<K,V>> cogenLinkedHashMap(Cogen<K> ck,
+                                                                           Cogen<V> cv)
        +
        A cogen for linked hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedHashSet

        +
        public static <A> Cogen<java.util.LinkedHashSet<A>> cogenLinkedHashSet(Cogen<A> c)
        +
        A cogen for linked hash sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked hash set.
        +
        Returns:
        +
        A cogen for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedList

        +
        public static <A> Cogen<java.util.LinkedList<A>> cogenLinkedList(Cogen<A> c)
        +
        A cogen for linked lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked list.
        +
        Returns:
        +
        A cogen for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityQueue

        +
        public static <A> Cogen<java.util.PriorityQueue<A>> cogenPriorityQueue(Cogen<A> c)
        +
        A cogen for priority queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority queue.
        +
        Returns:
        +
        A cogen for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenStack

        +
        public static <A> Cogen<java.util.Stack<A>> cogenStack(Cogen<A> c)
        +
        A cogen for stacks.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the stack.
        +
        Returns:
        +
        A cogen for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeMap

        +
        public static <K,V> Cogen<java.util.TreeMap<K,V>> cogenTreeMap(Cogen<K> ck,
+                                                               Cogen<V> cv)
        +
        A cogen for tree maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenTreeSet

        +
        public static <A> Cogen<java.util.TreeSet<A>> cogenTreeSet(Cogen<A> c)
        +
        A cogen for tree sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the tree set.
        +
        Returns:
        +
        A cogen for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenVector

        +
        public static <A> Cogen<java.util.Vector<A>> cogenVector(Cogen<A> c)
        +
        A cogen for vectors.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the vector.
        +
        Returns:
        +
        A cogen for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        cogenWeakHashMap

        +
        public static <K,V> Cogen<java.util.WeakHashMap<K,V>> cogenWeakHashMap(Cogen<K> ck,
+                                                                       Cogen<V> cv)
        +
        A cogen for weak hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenArrayBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.ArrayBlockingQueue<A>> cogenArrayBlockingQueue(Cogen<A> c)
        +
        A cogen for array blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the array blocking queue.
        +
        Returns:
        +
        A cogen for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentHashMap

        +
        public static <K,V> Cogen<java.util.concurrent.ConcurrentHashMap<K,V>> cogenConcurrentHashMap(Cogen<K> ck,
+                                                                                              Cogen<V> cv)
        +
        A cogen for concurrent hash maps.
        +
        +
        Parameters:
        +
        ck - A cogen for the map keys.
        +
        cv - A cogen for the map values.
        +
        Returns:
        +
        A cogen for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        cogenConcurrentLinkedQueue

        +
        public static <A> Cogen<java.util.concurrent.ConcurrentLinkedQueue<A>> cogenConcurrentLinkedQueue(Cogen<A> c)
        +
        A cogen for concurrent linked queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the concurrent linked queue.
        +
        Returns:
        +
        A cogen for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArrayList

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArrayList<A>> cogenCopyOnWriteArrayList(Cogen<A> c)
        +
        A cogen for copy-on-write array lists.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array list.
        +
        Returns:
        +
        A cogen for copy-on-write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        cogenCopyOnWriteArraySet

        +
        public static <A> Cogen<java.util.concurrent.CopyOnWriteArraySet<A>> cogenCopyOnWriteArraySet(Cogen<A> c)
        +
        A cogen for copy-on-write array sets.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the copy-on-write array set.
        +
        Returns:
        +
        A cogen for copy-on-write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        cogenDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Cogen<java.util.concurrent.DelayQueue<A>> cogenDelayQueue(Cogen<A> c)
        +
        A cogen for delay queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the delay queue.
        +
        Returns:
        +
        A cogen for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenLinkedBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.LinkedBlockingQueue<A>> cogenLinkedBlockingQueue(Cogen<A> c)
        +
        A cogen for linked blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the linked blocking queue.
        +
        Returns:
        +
        A cogen for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenPriorityBlockingQueue

        +
        public static <A> Cogen<java.util.concurrent.PriorityBlockingQueue<A>> cogenPriorityBlockingQueue(Cogen<A> c)
        +
        A cogen for priority blocking queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the priority blocking queue.
        +
        Returns:
        +
        A cogen for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenSynchronousQueue

        +
        public static <A> Cogen<java.util.concurrent.SynchronousQueue<A>> cogenSynchronousQueue(Cogen<A> c)
        +
        A cogen for synchronous queues.
        +
        +
        Parameters:
        +
        c - A cogen for the elements of the synchronous queue.
        +
        Returns:
        +
        A cogen for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP1

        +
        public static <A> Cogen<fj.P1<A>> cogenP1(Cogen<A> ca)
        +
        A cogen for product-1 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-1 is defined.
        +
        Returns:
        +
        A cogen for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP2

        +
        public static <A,B> Cogen<fj.P2<A,B>> cogenP2(Cogen<A> ca,
+                                              Cogen<B> cb)
        +
        A cogen for product-2 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-2 is defined.
        +
        cb - A cogen for one of the types over which the product-2 is defined.
        +
        Returns:
        +
        A cogen for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP3

        +
        public static <A,B,C> Cogen<fj.P3<A,B,C>> cogenP3(Cogen<A> ca,
+                                                  Cogen<B> cb,
+                                                  Cogen<C> cc)
        +
        A cogen for product-3 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-3 is defined.
        +
        cb - A cogen for one of the types over which the product-3 is defined.
        +
        cc - A cogen for one of the types over which the product-3 is defined.
        +
        Returns:
        +
        A cogen for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP4

        +
        public static <A,B,C,D> Cogen<fj.P4<A,B,C,D>> cogenP4(Cogen<A> ca,
+                                                      Cogen<B> cb,
+                                                      Cogen<C> cc,
+                                                      Cogen<D> cd)
        +
        A cogen for product-4 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-4 is defined.
        +
        cb - A cogen for one of the types over which the product-4 is defined.
        +
        cc - A cogen for one of the types over which the product-4 is defined.
        +
        cd - A cogen for one of the types over which the product-4 is defined.
        +
        Returns:
        +
        A cogen for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP5

        +
        public static <A,B,C,D,E> Cogen<fj.P5<A,B,C,D,E>> cogenP5(Cogen<A> ca,
+                                                          Cogen<B> cb,
+                                                          Cogen<C> cc,
+                                                          Cogen<D> cd,
+                                                          Cogen<E> ce)
        +
        A cogen for product-5 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-5 is defined.
        +
        cb - A cogen for one of the types over which the product-5 is defined.
        +
        cc - A cogen for one of the types over which the product-5 is defined.
        +
        cd - A cogen for one of the types over which the product-5 is defined.
        +
        ce - A cogen for one of the types over which the product-5 is defined.
        +
        Returns:
        +
        A cogen for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP6

        +
        public static <A,B,C,D,E,F$> Cogen<fj.P6<A,B,C,D,E,F$>> cogenP6(Cogen<A> ca,
+                                                                Cogen<B> cb,
+                                                                Cogen<C> cc,
+                                                                Cogen<D> cd,
+                                                                Cogen<E> ce,
+                                                                Cogen<F$> cf)
        +
        A cogen for product-6 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-6 is defined.
        +
        cb - A cogen for one of the types over which the product-6 is defined.
        +
        cc - A cogen for one of the types over which the product-6 is defined.
        +
        cd - A cogen for one of the types over which the product-6 is defined.
        +
        ce - A cogen for one of the types over which the product-6 is defined.
        +
        cf - A cogen for one of the types over which the product-6 is defined.
        +
        Returns:
        +
        A cogen for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP7

        +
        public static <A,B,C,D,E,F$,G> Cogen<fj.P7<A,B,C,D,E,F$,G>> cogenP7(Cogen<A> ca,
+                                                                    Cogen<B> cb,
+                                                                    Cogen<C> cc,
+                                                                    Cogen<D> cd,
+                                                                    Cogen<E> ce,
+                                                                    Cogen<F$> cf,
+                                                                    Cogen<G> cg)
        +
        A cogen for product-7 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-7 is defined.
        +
        cb - A cogen for one of the types over which the product-7 is defined.
        +
        cc - A cogen for one of the types over which the product-7 is defined.
        +
        cd - A cogen for one of the types over which the product-7 is defined.
        +
        ce - A cogen for one of the types over which the product-7 is defined.
        +
        cf - A cogen for one of the types over which the product-7 is defined.
        +
        cg - A cogen for one of the types over which the product-7 is defined.
        +
        Returns:
        +
        A cogen for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        cogenP8

        +
        public static <A,B,C,D,E,F$,G,H> Cogen<fj.P8<A,B,C,D,E,F$,G,H>> cogenP8(Cogen<A> ca,
+                                                                        Cogen<B> cb,
+                                                                        Cogen<C> cc,
+                                                                        Cogen<D> cd,
+                                                                        Cogen<E> ce,
+                                                                        Cogen<F$> cf,
+                                                                        Cogen<G> cg,
+                                                                        Cogen<H> ch)
        +
        A cogen for product-8 values.
        +
        +
        Parameters:
        +
        ca - A cogen for one of the types over which the product-8 is defined.
        +
        cb - A cogen for one of the types over which the product-8 is defined.
        +
        cc - A cogen for one of the types over which the product-8 is defined.
        +
        cd - A cogen for one of the types over which the product-8 is defined.
        +
        ce - A cogen for one of the types over which the product-8 is defined.
        +
        cf - A cogen for one of the types over which the product-8 is defined.
        +
        cg - A cogen for one of the types over which the product-8 is defined.
        +
        ch - A cogen for one of the types over which the product-8 is defined.
        +
        Returns:
        +
        A cogen for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Gen.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Gen.html new file mode 100644 index 0000000..bf4651c --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Gen.html @@ -0,0 +1,1486 @@ + + + + + +Gen (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Gen<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Gen<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Gen<A>
+extends java.lang.Object
    +

    A generator for values of the type of the given type parameter (A). Generation + of a value accepts a general 'size' argument (integer), a random generator and + returns an optional value of the type parameter. Several generators are provided, + allowing various forms of composition of generators.

    A user typically creates an arbitrary to return a generator using the 'combinator methods' below. For example, + suppose a class Person: +

    
+class Person {
+  final int age;
+  final String name;
+  final boolean male;
+
+  Person(final int age, final String name, final boolean male) {
+    this.age = age;
+    this.name = name;
+    this.male = male;
+  }
+}
+
    +

    In a case like this one, a user may create a generator over Person by + invoking the bind(F) methods — in this case, bind(Gen , Gen , F) the one + that takes two generator arguments}, since the class has one more than two fields (the bind + method is invoked on a generator adding the extra one to the count as they are composed). The + class fields are of types for which there exist generators (on Gen so those can be + used to compose a generator for Person:

    +
    
+static Gen&lt;Person&gt; personArbitrary() {
+  return arbInteger.bind(arbString(), arbBoolean(),
+      // compose the generators
+      {int age =&gt; {String name =&gt; {boolean male =&gt; new Person(age, name, male)}}};
+}
+
    +

    + The example above uses Java 7 closure syntax. Here is the same example using objects instead: +

    
+static Gen&lt;Person&gt; personArbitrary() {
+  return arbInteger.bind(arbString, arbBoolean,
+      // compose the generators
+      new F&lt;Integer, F&lt;String, F&lt;Boolean, Person&gt;&gt;&gt;() {
+        public F&lt;String, F&lt;Boolean, Person&gt;&gt; f(final Integer age) {
+          return new F&lt;String, F&lt;Boolean, Person&gt;&gt;() {
+            public F&lt;Boolean, Person&gt; f(final String name) {
+              return new F&lt;Boolean, Person&gt;() {
+                public Person f(final Boolean male) {
+                  return new Person(age, name, male);
+                }
+              };
+            }
+          };
+        }
+      });
+}
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Gen<B>apply(Gen<fj.F<A,B>> gf) +
      Function application within this generator to produce a new generator.
      +
      <B> Gen<B>bind(fj.F<A,Gen<B>> f) +
      Binds the given function across this generator to produce a new generator.
      +
      <B,C> Gen<C>bind(Gen<B> gb, + fj.F<A,fj.F<B,C>> f) +
      Binds the given function across this generator and the given generator to produce a new + generator.
      +
      <B,C,D> Gen<D>bind(Gen<B> gb, + Gen<C> gc, + fj.F<A,fj.F<B,fj.F<C,D>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E> Gen<E>bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$>
      Gen<F$>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G>
      Gen<G>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H>
      Gen<H>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      <B,C,D,E,F$,G,H,I>
      Gen<I>      		bind(Gen<B> gb, + Gen<C> gc, + Gen<D> gd, + Gen<E> ge, + Gen<F$> gf, + Gen<G> gg, + Gen<H> gh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f) +
      Binds the given function across this generator and the given generators to produce a new + generator.
      +
      static Gen<java.lang.Double>choose(double from, + double to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Integer>choose(int from, + int to) +
      Returns a generator that produces values between the given range (inclusive).
      +
      static Gen<java.lang.Long>choose(long from, + long to) 
      static <A> Gen<fj.data.List<A>>combinationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<A>elements(A... as) +
      Returns a generator that produces values from the given arguments.
      +
      static <A> Gen<A>elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as) +
      Returns a generator that produces values from the given frequency and value pairs.
      +
      static <A> Gen<A>fail() +
      Returns a generator that never returns a value.
      +
      Gen<A>filter(fj.F<A,java.lang.Boolean> f) +
      Returns a generator that produces values that meet the given predicate.
      +
      fj.Unitforeach(java.lang.Integer i, + Rand r, + fj.F<A,fj.Unit> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      voidforeachDoEffect(java.lang.Integer i, + Rand r, + fj.function.Effect1<A> f) +
      Executes a side-effect for each generated result using the given arguments.
      +
      static <A> Gen<A>frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs) +
      Returns a generator that uses values from the given frequency and generator pairs.
      +
      static <A> Gen<A>gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f) +
      Returns a generator that uses the given function.
      +
      Agen(int i, + Rand r) +
      Applies the given size and random generator to produce a value.
      +
      static <A> Gen<A>join(Gen<Gen<A>> g) +
      Joins the generator of generators through a bind(F) operation.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf(Gen<A> g, + int x) +
      Returns a generator of lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOf1(Gen<A> g) +
      Returns a generator of non empty lists whose values come from the given generator.
      +
      static <A> Gen<fj.data.List<A>>listOfSorted(Gen<A> g, + int x, + fj.Ord<A> ord) 
      <B> Gen<B>map(fj.F<A,B> f) +
      Maps the given function across this generator.
      +
      static <A> Gen<A>oneOf(fj.data.List<Gen<A>> gs) +
      Returns a generator that produces values from one of the given generators on subsequent + requests.
      +
      static <A> Gen<A>parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f) +
      Constructs a generator that can access its construction arguments — size and random + generator.
      +
      static <A> Gen<fj.data.List<A>>permutationOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<A>pickOne(fj.data.List<A> as) +
      Returns a generator that picks one element from the given list.
      +
      static <A,B> Gen<fj.F<A,B>>promote(fj.F<A,Gen<B>> f) +
      Promotes the given function to a generator for functions.
      +
      Gen<A>resize(int s) +
      Resizes this generator with the given size.
      +
      static <A> Gen<fj.data.List<A>>selectionOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      static <A> Gen<fj.data.List<A>>sequence(fj.data.List<Gen<A>> gs) +
      Sequence the given generators through a bind(F) operation.
      +
      static <E,A> Gen<fj.data.Validation<E,A>>sequence(fj.data.Validation<E,Gen<A>> gv) +
      Transform a validation for a generator into a generator of validations: if the given validation is a failure, the + generator produces that failure value; if the given validation is a success, the generator produces success values.
      +
      static <A> Gen<fj.data.List<A>>sequenceN(int n, + Gen<A> g) +
      Sequences the given generator the given number of times through a bind(F) operation.
      +
      static <A> Gen<A>sized(fj.F<java.lang.Integer,Gen<A>> f) +
      Constructs a generator that can access its size construction arguments.
      +
      static <A> Gen<fj.data.List<A>>someCombinationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>somePermutationOf(fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someSelectionOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.List<A>>someWordOf(int maxLength, + fj.data.List<A> as) +
      Returns a generator of lists that produces some of the values of the given list.
      +
      static <A> Gen<fj.data.Stream<A>>streamOf(Gen<A> g) +
      Returns a generator of streams whose values come from the given generator.
      +
      static <A> Gen<A>value(A a) +
      Returns a generator that always produces the given value.
      +
      static <A> Gen<fj.data.List<A>>wordOf(int n, + fj.data.List<A> as) +
      Returns a generator of lists that picks the given number of elements from the given list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        gen

        +
        public A gen(int i,
+             Rand r)
        +
        Applies the given size and random generator to produce a value.
        +
        +
        Parameters:
        +
        i - The size to use to produce the value.
        +
        r - The random generator to use to produce the value..
        +
        Returns:
        +
        A generated value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Gen<B> map(fj.F<A,B> f)
        +
        Maps the given function across this generator.
        +
        +
        Parameters:
        +
        f - The function to map across this generator.
        +
        Returns:
        +
        A new generator after applying the mapping function.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Gen<A> filter(fj.F<A,java.lang.Boolean> f)
        +
        Returns a generator that produces values that meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to meet for the values produced by the generator.
        +
        Returns:
        +
        A generator that produces values that meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public fj.Unit foreach(java.lang.Integer i,
+                       Rand r,
+                       fj.F<A,fj.Unit> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(java.lang.Integer i,
+                            Rand r,
+                            fj.function.Effect1<A> f)
        +
        Executes a side-effect for each generated result using the given arguments.
        +
        +
        Parameters:
        +
        i - The size to generate the result to apply the side-effect to.
        +
        r - The random generator to generate the result to apply the side-effect to.
        +
        f - The side-effect to execute on the generated value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Gen<B> bind(fj.F<A,Gen<B>> f)
        +
        Binds the given function across this generator to produce a new generator.
        +
        +
        Parameters:
        +
        f - The function to bind across this generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Gen<C> bind(Gen<B> gb,
+                         fj.F<A,fj.F<B,C>> f)
        +
        Binds the given function across this generator and the given generator to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generator.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Gen<D> bind(Gen<B> gb,
+                           Gen<C> gc,
+                           fj.F<A,fj.F<B,fj.F<C,D>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E> Gen<E> bind(Gen<B> gb,
+                             Gen<C> gc,
+                             Gen<D> gd,
+                             fj.F<A,fj.F<B,fj.F<C,fj.F<D,E>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$> Gen<F$> bind(Gen<B> gb,
+                                 Gen<C> gc,
+                                 Gen<D> gd,
+                                 Gen<E> ge,
+                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,F$>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G> Gen<G> bind(Gen<B> gb,
+                                  Gen<C> gc,
+                                  Gen<D> gd,
+                                  Gen<E> ge,
+                                  Gen<F$> gf,
+                                  fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,G>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H> Gen<H> bind(Gen<B> gb,
+                                    Gen<C> gc,
+                                    Gen<D> gd,
+                                    Gen<E> ge,
+                                    Gen<F$> gf,
+                                    Gen<G> gg,
+                                    fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,H>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E,F$,G,H,I> Gen<I> bind(Gen<B> gb,
+                                      Gen<C> gc,
+                                      Gen<D> gd,
+                                      Gen<E> ge,
+                                      Gen<F$> gf,
+                                      Gen<G> gg,
+                                      Gen<H> gh,
+                                      fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,I>>>>>>>> f)
        +
        Binds the given function across this generator and the given generators to produce a new + generator.
        +
        +
        Parameters:
        +
        gb - The second generator to bind the given function across.
        +
        gc - The third generator to bind the given function across.
        +
        gd - The fourth generator to bind the given function across.
        +
        ge - The fifth generator to bind the given function across.
        +
        gf - The sixth generator to bind the given function across.
        +
        gg - The seventh generator to bind the given function across.
        +
        gh - The eighth generator to bind the given function across.
        +
        f - The function to bind across this generator and the given generators.
        +
        Returns:
        +
        A new generator after binding the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Gen<B> apply(Gen<fj.F<A,B>> gf)
        +
        Function application within this generator to produce a new generator.
        +
        +
        Parameters:
        +
        gf - The generator over the function to apply to this generator.
        +
        Returns:
        +
        A new generator after function application.
        +
        +
        • +
      + + + +
        +
      • +

        resize

        +
        public Gen<A> resize(int s)
        +
        Resizes this generator with the given size.
        +
        +
        Parameters:
        +
        s - The new size of the generator.
        +
        Returns:
        +
        A new generator that uses the given size.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public static <A> Gen<A> gen(fj.F<java.lang.Integer,fj.F<Rand,A>> f)
        +
        Returns a generator that uses the given function.
        +
        +
        Parameters:
        +
        f - The function to use for this generator.
        +
        Returns:
        +
        A new generator that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Gen<fj.data.List<A>> sequence(fj.data.List<Gen<A>> gs)
        +
        Sequence the given generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        gs - The generators to sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generators.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceN

        +
        public static <A> Gen<fj.data.List<A>> sequenceN(int n,
+                                                 Gen<A> g)
        +
        Sequences the given generator the given number of times through a bind(F) operation.
        +
        +
        Parameters:
        +
        n - The number of times to sequence the given generator.
        +
        g - The generator sequence.
        +
        Returns:
        +
        A generator of lists after sequencing the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <E,A> Gen<fj.data.Validation<E,A>> sequence(fj.data.Validation<E,Gen<A>> gv)
        +
        Transform a validation for a generator into a generator of validations: if the given validation is a failure, the + generator produces that failure value; if the given validation is a success, the generator produces success values.
        +
        +
        Type Parameters:
        +
        A - the type of the value
        +
        E - the type of the failure
        +
        Parameters:
        +
        gv - The validation for a generator.
        +
        Returns:
        +
        if the given validation is a failure, the generator produces that failure value; if the given validation is a success, the generator produces success values.
        +
        +
        • +
      + + + +
        +
      • +

        parameterised

        +
        public static <A> Gen<A> parameterised(fj.F<java.lang.Integer,fj.F<Rand,Gen<A>>> f)
        +
        Constructs a generator that can access its construction arguments — size and random + generator.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its arguments.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + +
        +
      • +

        sized

        +
        public static <A> Gen<A> sized(fj.F<java.lang.Integer,Gen<A>> f)
        +
        Constructs a generator that can access its size construction arguments.
        +
        +
        Parameters:
        +
        f - The function that constructs the generator with its size argument.
        +
        Returns:
        +
        A new generator.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <A> Gen<A> value(A a)
        +
        Returns a generator that always produces the given value.
        +
        +
        Parameters:
        +
        a - The value to always produce.
        +
        Returns:
        +
        A generator that always produces the given value.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Integer> choose(int from,
+                                            int to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces values between the given range (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Long> choose(long from,
+                                         long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public static Gen<java.lang.Double> choose(double from,
+                                           double to)
        +
        Returns a generator that produces values between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The value for the generator to produce values from.
        +
        to - The value for the generator to produce values from.
        +
        Returns:
        +
        A generator that produces v
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public static <A> Gen<A> fail()
        +
        Returns a generator that never returns a value.
        +
        +
        Returns:
        +
        A generator that never returns a value.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Gen<A> join(Gen<Gen<A>> g)
        +
        Joins the generator of generators through a bind(F) operation.
        +
        +
        Parameters:
        +
        g - The generator of generators to join.
        +
        Returns:
        +
        A new generator after joining the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        frequency

        +
        public static <A> Gen<A> frequency(fj.data.List<fj.P2<java.lang.Integer,Gen<A>>> gs)
        +
        Returns a generator that uses values from the given frequency and generator pairs. The returned + generator will produce values from the generator in a pair with a higher frequency than a lower + frequency generator.
        +
        +
        Parameters:
        +
        gs - The pairs of frequency and generator from which to return values in the returned + generator.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and generator.
        +
        +
        • +
      + + + +
        +
      • +

        elemFrequency

        +
        public static <A> Gen<A> elemFrequency(fj.data.List<fj.P2<java.lang.Integer,A>> as)
        +
        Returns a generator that produces values from the given frequency and value pairs. The returned + generator will produce the value with a higher frequency than a lower one.
        +
        +
        Parameters:
        +
        as - The pairs of frequency and value from which to produce values.
        +
        Returns:
        +
        A new generator that uses the given pairs of frequency and value.
        +
        +
        • +
      + + + + + +
        +
      • +

        elements

        +
        @SafeVarargs
+public static <A> Gen<A> elements(A... as)
        +
        Returns a generator that produces values from the given arguments.
        +
        +
        Parameters:
        +
        as - The values that the returned generator may produce.
        +
        Returns:
        +
        A generator that produces values from the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        oneOf

        +
        public static <A> Gen<A> oneOf(fj.data.List<Gen<A>> gs)
        +
        Returns a generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        Parameters:
        +
        gs - The list of generators to produce a value from.
        +
        Returns:
        +
        A generator that produces values from one of the given generators on subsequent + requests.
        +
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g,
+                                              int x)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        x - An adjuster of size to apply to the given generator when producing values.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOfSorted

        +
        public static <A> Gen<fj.data.List<A>> listOfSorted(Gen<A> g,
+                                                    int x,
+                                                    fj.Ord<A> ord)
        +
        • +
      + + + +
        +
      • +

        listOf

        +
        public static <A> Gen<fj.data.List<A>> listOf(Gen<A> g)
        +
        Returns a generator of lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        listOf1

        +
        public static <A> Gen<fj.data.List<A>> listOf1(Gen<A> g)
        +
        Returns a generator of non empty lists whose values come from the given generator.
        +
        +
        Parameters:
        +
        g - The generator to produce values from for the returned generator.
        +
        Returns:
        +
        A generator of lists whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        streamOf

        +
        public static <A> Gen<fj.data.Stream<A>> streamOf(Gen<A> g)
        +
        Returns a generator of streams whose values come from the given generator.
        +
        +
        Type Parameters:
        +
        A - the type of the generator
        +
        Parameters:
        +
        g - the generator to produce values from for the returned generator
        +
        Returns:
        +
        A generator of streams whose values come from the given generator.
        +
        +
        • +
      + + + +
        +
      • +

        pickOne

        +
        public static <A> Gen<A> pickOne(fj.data.List<A> as)
        +
        Returns a generator that picks one element from the given list. If the given list is empty, then the + returned generator will never produce a value.
        +
        +
        Parameters:
        +
        as - The list from which to pick an element.
        +
        Returns:
        +
        A generator that picks an element from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        combinationOf

        +
        public static <A> Gen<fj.data.List<A>> combinationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        selectionOf

        +
        public static <A> Gen<fj.data.List<A>> selectionOf(int n,
+                                                   fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        permutationOf

        +
        public static <A> Gen<fj.data.List<A>> permutationOf(int n,
+                                                     fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +

        + If the given number is less than zero or greater than the length of the given list, then the + returned generator will never produce a value.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        wordOf

        +
        public static <A> Gen<fj.data.List<A>> wordOf(int n,
+                                              fj.data.List<A> as)
        +
        Returns a generator of lists that picks the given number of elements from the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +

        + If the given number is less than zero, then the returned generator will never produce a value. Note that, + with replacement, the given number may be larger than the length of the given list.

        +
        +
        Parameters:
        +
        n - The number of elements to pick from the given list.
        +
        as - The list from which to pick elements.
        +
        Returns:
        +
        A generator of lists that picks the given number of elements from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someCombinationOf

        +
        public static <A> Gen<fj.data.List<A>> someCombinationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someSelectionOf

        +
        public static <A> Gen<fj.data.List<A>> someSelectionOf(int maxLength,
+                                                       fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a combination with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list will always contain its elements in the same order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somePermutationOf

        +
        public static <A> Gen<fj.data.List<A>> somePermutationOf(fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation without replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • An element will never be picked more than once
          • +
        +
        +
        Parameters:
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        someWordOf

        +
        public static <A> Gen<fj.data.List<A>> someWordOf(int maxLength,
+                                                  fj.data.List<A> as)
        +
        Returns a generator of lists that produces some of the values of the given list. The selection is + a permutation with replacement of elements from the given list, i.e. +
          +
        • For any given selection, a generated list may contain its elements in any order
          • +
        • Each element may be picked more than once
          • +
        +
        +
        Parameters:
        +
        maxLength - The maximum length of a generated list
        +
        as - The list from which to pick values.
        +
        Returns:
        +
        A generator of lists that produces some of the values of the given list.
        +
        +
        • +
      + + + +
        +
      • +

        promote

        +
        public static <A,B> Gen<fj.F<A,B>> promote(fj.F<A,Gen<B>> f)
        +
        Promotes the given function to a generator for functions.
        +
        +
        Parameters:
        +
        f - The function to promote to a generator of functions.
        +
        Returns:
        +
        A generator for functions.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Property.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Property.html new file mode 100644 index 0000000..52c1842 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Property.html @@ -0,0 +1,2513 @@ + + + + + +Property (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Property

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Property
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Property
+extends java.lang.Object
    +
    Represents an algebraic property about a program that may be checked for its truth value. For example, it is true that "for all integers (call it x) and + for all integers (call it y), then x + y is equivalent to y + x". This statement is a (algebraic) + property, proposition or theorem that, when checked, will at least (depending on arguments) fail + to be falsified — since there does not exist a counter-example to this statement.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Propertyand(Property p) +
      Performs a conjunction of this property with the given property.
      +
      CheckResultcheck() +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(int minSize, + int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
      +
      CheckResultcheck(int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using a standard random generator and the given + arguments to produce a result.
      +
      CheckResultcheck(Rand r) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultcheck(Rand r, + int minSize, + int maxSize) +
      Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
      +
      CheckResultcheck(Rand r, + int minSuccessful, + int maxDiscarded, + int minSize, + int maxSize) +
      Checks this property using the given arguments and produces a result.
      +
      static Propertyexception(fj.F0<Property> p) +
      Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
      +
      static <A> Propertyforall(Gen<A> g, + Shrink<A> shrink, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static PropertyfromGen(Gen<Result> g) +
      Constructs a property from a generator of results.
      +
      Gen<Result>gen() +
      Returns a generator of results from this property.
      +
      static Propertyimplies(boolean b, + fj.F0<Property> p) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + boolean b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      static PropertyimpliesBoolean(boolean a, + fj.F0<java.lang.Boolean> b) +
      Returns a property that produces a result only if the given condition satisfies.
      +
      CheckResultmaxDiscarded(int maxDiscarded) +
      Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxDiscarded(Rand r, + int maxDiscarded) +
      Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultmaxSize(int maxSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultmaxSize(Rand r, + int maxSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
      +
      CheckResultminSize(int minSize) +
      Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSize(Rand r, + int minSize) +
      Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
      +
      CheckResultminSuccessful(int minSuccessful) +
      Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      CheckResultminSuccessful(Rand r, + int minSuccessful) +
      Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
      +
      Propertyor(Property p) +
      Performs a disjunction of this property with the given property.
      +
      static Propertyprop(boolean b) +
      Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
      +
      static Propertyprop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f) +
      Returns a property from the given function.
      +
      Resultprop(int i, + Rand r) +
      Returns the result of applying the given size and random generator.
      +
      static Propertyprop(Result r) +
      Returns a property that always has the given result.
      +
      static <A> Propertyproperty(Gen<A> aa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G,H>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Gen<H> ah, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + Shrink<H> sh, + fj.F8<A,B,C,D,E,F$,G,H,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$,G>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Gen<G> ag, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + Shrink<G> sg, + fj.F7<A,B,C,D,E,F$,G,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E,F$>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Gen<F$> af, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + Shrink<F$> sf, + fj.F6<A,B,C,D,E,F$,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D,E>
      Property      		property(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Gen<E> ae, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + Shrink<E> se, + fj.F5<A,B,C,D,E,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C,D> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Gen<D> ad, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + Shrink<D> sd, + fj.F4<A,B,C,D,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F<A,fj.F<B,fj.F<C,Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B,C> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Gen<C> ac, + Shrink<A> sa, + Shrink<B> sb, + Shrink<C> sc, + fj.F3<A,B,C,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> Propertyproperty(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> Propertyproperty(Gen<A> aa, + Shrink<A> sa, + fj.F<A,Property> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F<A,fj.F<B,fj.P1<Property>>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A,B> PropertypropertyP(Gen<A> aa, + Gen<B> ab, + Shrink<A> sa, + Shrink<B> sb, + fj.F2<A,B,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      static <A> PropertypropertyP(Gen<A> aa, + Shrink<A> sa, + fj.F<A,fj.P1<Property>> f) +
      Returns a property where its result is derived from universal quantification across the + application of its arguments.
      +
      Propertysequence(Property p) +
      Performs a sequence of this property with the given property.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        prop

        +
        public Result prop(int i,
+                   Rand r)
        +
        Returns the result of applying the given size and random generator.
        +
        +
        Parameters:
        +
        i - The size to use to obtain a result.
        +
        r - The random generator to use to obtain a result.
        +
        Returns:
        +
        The result of applying the given size and random generator.
        +
        +
        • +
      + + + +
        +
      • +

        gen

        +
        public Gen<Result> gen()
        +
        Returns a generator of results from this property.
        +
        +
        Returns:
        +
        A generator of results from this property.
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Property and(Property p)
        +
        Performs a conjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the conjunction with.
        +
        Returns:
        +
        A conjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Property or(Property p)
        +
        Performs a disjunction of this property with the given property.
        +
        +
        Parameters:
        +
        p - The property to perform the disjunction with.
        +
        Returns:
        +
        A disjunction of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public Property sequence(Property p)
        +
        Performs a sequence of this property with the given property. The returned property holds if + and only if this property and the given property also hold. If one property does not hold, but + the other does, then the returned property will produce the same result and the property that + holds.
        +
        +
        Parameters:
        +
        p - The property to sequence this property with.
        +
        Returns:
        +
        A sequence of this property with the given property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given arguments and produces a result.
        +
        +
        Parameters:
        +
        r - The random generator to use for checking.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSuccessful,
+                         int maxDiscarded,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator and the given + arguments to produce a result.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(Rand r,
+                         int minSize,
+                         int maxSize)
        +
        Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check(int minSize,
+                         int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public CheckResult check()
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(int minSuccessful)
        +
        Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSuccessful

        +
        public CheckResult minSuccessful(Rand r,
+                                 int minSuccessful)
        +
        Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSuccessful - The minimum number of successful tests before a result is reached.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(int maxDiscarded)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxDiscarded

        +
        public CheckResult maxDiscarded(Rand r,
+                                int maxDiscarded)
        +
        Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxDiscarded - The maximum number of tests discarded because they did not satisfy + pre-conditions (i.e. implies(boolean, F0)).
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(int minSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        minSize

        +
        public CheckResult minSize(Rand r,
+                           int minSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        minSize - The minimum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(int maxSize)
        +
        Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        maxSize

        +
        public CheckResult maxSize(Rand r,
+                           int maxSize)
        +
        Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
        +
        +
        Parameters:
        +
        r - The random generator.
        +
        maxSize - The maximum size to use for checking.
        +
        Returns:
        +
        A result after checking this property.
        +
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static Property implies(boolean b,
+                               fj.F0<Property> p)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given property.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, produces the given property.
        +
        p - The property to return if the condition satisfies.
        +
        Returns:
        +
        A property that produces a result only if the given condition satisfies.
        +
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      boolean b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given boolean b.
        +
        • +
      + + + +
        +
      • +

        impliesBoolean

        +
        public static Property impliesBoolean(boolean a,
+                                      fj.F0<java.lang.Boolean> b)
        +
        Returns a property that produces a result only if the given condition satisfies. The result + will be taken from the given lazy boolean b.
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(fj.F<java.lang.Integer,fj.F<Rand,Result>> f)
        +
        Returns a property from the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the returned property with.
        +
        Returns:
        +
        A property from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(Result r)
        +
        Returns a property that always has the given result.
        +
        +
        Parameters:
        +
        r - The result of the returned property.
        +
        Returns:
        +
        A property that always has the given result.
        +
        +
        • +
      + + + +
        +
      • +

        prop

        +
        public static Property prop(boolean b)
        +
        Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        Parameters:
        +
        b - The condition that, if satisfied, returns a property that is proven; otherwise, the + property is falsified.
        +
        Returns:
        +
        A property that is either proven (the given condition satsifies) or falsified + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fromGen

        +
        public static Property fromGen(Gen<Result> g)
        +
        Constructs a property from a generator of results.
        +
        +
        Parameters:
        +
        g - The generator of results to constructor a property with.
        +
        Returns:
        +
        A property from a generator of results.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public static <A> Property forall(Gen<A> g,
+                                  Shrink<A> shrink,
+                                  fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        g - The generator to produces values from to produce the property with.
        +
        shrink - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     Shrink<A> sa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    Shrink<A> sa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A> Property propertyP(Gen<A> aa,
+                                     fj.F<A,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A> Property property(Gen<A> aa,
+                                    fj.F<A,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F<A,fj.F<B,fj.P1<Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F<A,fj.F<B,Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       Shrink<A> sa,
+                                       Shrink<B> sb,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      Shrink<A> sa,
+                                      Shrink<B> sb,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        propertyP

        +
        public static <A,B> Property propertyP(Gen<A> aa,
+                                       Gen<B> ab,
+                                       fj.F2<A,B,fj.P1<Property>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B> Property property(Gen<A> aa,
+                                      Gen<B> ab,
+                                      fj.F2<A,B,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F<A,fj.F<B,fj.F<C,Property>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        Shrink<A> sa,
+                                        Shrink<B> sb,
+                                        Shrink<C> sc,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C> Property property(Gen<A> aa,
+                                        Gen<B> ab,
+                                        Gen<C> ac,
+                                        fj.F3<A,B,C,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F<A,fj.F<B,fj.F<C,fj.F<D,Property>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          Shrink<A> sa,
+                                          Shrink<B> sb,
+                                          Shrink<C> sc,
+                                          Shrink<D> sd,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D> Property property(Gen<A> aa,
+                                          Gen<B> ab,
+                                          Gen<C> ac,
+                                          Gen<D> ad,
+                                          fj.F4<A,B,C,D,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,Property>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            Shrink<A> sa,
+                                            Shrink<B> sb,
+                                            Shrink<C> sc,
+                                            Shrink<D> sd,
+                                            Shrink<E> se,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E> Property property(Gen<A> aa,
+                                            Gen<B> ab,
+                                            Gen<C> ac,
+                                            Gen<D> ad,
+                                            Gen<E> ae,
+                                            fj.F5<A,B,C,D,E,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,Property>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               Shrink<A> sa,
+                                               Shrink<B> sb,
+                                               Shrink<C> sc,
+                                               Shrink<D> sd,
+                                               Shrink<E> se,
+                                               Shrink<F$> sf,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$> Property property(Gen<A> aa,
+                                               Gen<B> ab,
+                                               Gen<C> ac,
+                                               Gen<D> ad,
+                                               Gen<E> ae,
+                                               Gen<F$> af,
+                                               fj.F6<A,B,C,D,E,F$,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,Property>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 Shrink<A> sa,
+                                                 Shrink<B> sb,
+                                                 Shrink<C> sc,
+                                                 Shrink<D> sd,
+                                                 Shrink<E> se,
+                                                 Shrink<F$> sf,
+                                                 Shrink<G> sg,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G> Property property(Gen<A> aa,
+                                                 Gen<B> ab,
+                                                 Gen<C> ac,
+                                                 Gen<D> ad,
+                                                 Gen<E> ae,
+                                                 Gen<F$> af,
+                                                 Gen<G> ag,
+                                                 fj.F7<A,B,C,D,E,F$,G,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F<A,fj.F<B,fj.F<C,fj.F<D,fj.F<E,fj.F<F$,fj.F<G,fj.F<H,Property>>>>>>>> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   Shrink<A> sa,
+                                                   Shrink<B> sb,
+                                                   Shrink<C> sc,
+                                                   Shrink<D> sd,
+                                                   Shrink<E> se,
+                                                   Shrink<F$> sf,
+                                                   Shrink<G> sg,
+                                                   Shrink<H> sh,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        sa - The shrink strategy to use upon falsification.
        +
        sb - The shrink strategy to use upon falsification.
        +
        sc - The shrink strategy to use upon falsification.
        +
        sd - The shrink strategy to use upon falsification.
        +
        se - The shrink strategy to use upon falsification.
        +
        sf - The shrink strategy to use upon falsification.
        +
        sg - The shrink strategy to use upon falsification.
        +
        sh - The shrink strategy to use upon falsification.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        property

        +
        public static <A,B,C,D,E,F$,G,H> Property property(Gen<A> aa,
+                                                   Gen<B> ab,
+                                                   Gen<C> ac,
+                                                   Gen<D> ad,
+                                                   Gen<E> ae,
+                                                   Gen<F$> af,
+                                                   Gen<G> ag,
+                                                   Gen<H> ah,
+                                                   fj.F8<A,B,C,D,E,F$,G,H,Property> f)
        +
        Returns a property where its result is derived from universal quantification across the + application of its arguments. No shrinking occurs upon falsification.
        +
        +
        Parameters:
        +
        aa - The arbitrrary to produces values from to produce the property with.
        +
        ab - The arbitrrary to produces values from to produce the property with.
        +
        ac - The arbitrrary to produces values from to produce the property with.
        +
        ad - The arbitrrary to produces values from to produce the property with.
        +
        ae - The arbitrrary to produces values from to produce the property with.
        +
        af - The arbitrrary to produces values from to produce the property with.
        +
        ag - The arbitrrary to produces values from to produce the property with.
        +
        ah - The arbitrrary to produces values from to produce the property with.
        +
        f - The function to produce properties with results.
        +
        Returns:
        +
        A property where its result is derived from universal quantification across the + application of its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Property exception(fj.F0<Property> p)
        +
        Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        Parameters:
        +
        p - A property to evaluate to check for an exception.
        +
        Returns:
        +
        A property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Rand.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Rand.html new file mode 100644 index 0000000..a7f14be --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Rand.html @@ -0,0 +1,434 @@ + + + + + +Rand (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Rand

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Rand
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Rand
+extends java.lang.Object
    +
    A random number generator.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Randstandard +
      A standard random generator that uses Random.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      doublechoose(double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      doublechoose(long seed, + double from, + double to) +
      Randomly chooses a value between the given range (inclusive).
      +
      intchoose(long seed, + int from, + int to) +
      Randomly chooses a value between the given range (inclusive).
      +
      longchoose(long from, + long to) 
      static Randrand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f, + fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g, + fj.F<java.lang.Long,Rand> onReseed) +
      Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
      +
      Randreseed(long seed) +
      Gives this random generator a new seed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        standard

        +
        public static final Rand standard
        +
        A standard random generator that uses Random.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        choose

        +
        public int choose(long seed,
+                  int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public int choose(int from,
+                  int to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public long choose(long from,
+                   long to)
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(long seed,
+                     double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        seed - The seed to use for random generation.
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        choose

        +
        public double choose(double from,
+                     double to)
        +
        Randomly chooses a value between the given range (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value to choose.
        +
        to - The maximum value to choose.
        +
        Returns:
        +
        A random value in the given range.
        +
        +
        • +
      + + + +
        +
      • +

        reseed

        +
        public Rand reseed(long seed)
        +
        Gives this random generator a new seed.
        +
        +
        Parameters:
        +
        seed - The seed of the new random generator.
        +
        Returns:
        +
        A random generator with the given seed.
        +
        +
        • +
      + + + +
        +
      • +

        rand

        +
        public static Rand rand(fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Integer,fj.F<java.lang.Integer,java.lang.Integer>>> f,
+                        fj.F<fj.data.Option<java.lang.Long>,fj.F<java.lang.Double,fj.F<java.lang.Double,java.lang.Double>>> g,
+                        fj.F<java.lang.Long,Rand> onReseed)
        +
        Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
        +
        +
        Parameters:
        +
        f - The integer random generator.
        +
        g - The floating-point random generator.
        +
        onReseed - Function to create a reseeded Rand.
        +
        Returns:
        +
        A random generator from the given functions that supply a range to produce a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Result.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Result.html new file mode 100644 index 0000000..36a0e1f --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Result.html @@ -0,0 +1,609 @@ + + + + + +Result (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Result

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Result
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Result
+extends java.lang.Object
    +
    The result of evaluating a property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      ResultaddArg(Arg<?> a) +
      Adds an argument to this result.
      +
      fj.data.Option<fj.data.List<Arg<?>>>args() +
      Returns the potential arguments associated with this result.
      +
      fj.data.Option<java.lang.Throwable>exception() +
      Returns the potential exception associated with this result.
      +
      static Resultexception(fj.data.List<Arg<?>> args, + java.lang.Throwable t) +
      Returns an exception result.
      +
      booleanfailed() +
      Returns true if this result is falsified or an exception; otherwise, + false.
      +
      static Resultfalsified(fj.data.List<Arg<?>> args) +
      Returns a falsified result.
      +
      booleanisException() +
      Returns true if this result is an exception; otherwise, false.
      +
      booleanisFalsified() +
      Returns true if this result is falsified; otherwise, false.
      +
      booleanisNoResult() +
      Returns true if this result is no result; otherwise, false.
      +
      booleanisProven() +
      Returns true if this result is proven; otherwise, false.
      +
      booleanisUnfalsified() +
      Returns true if this result is unfalsified; otherwise, false.
      +
      static ResultnoResult() +
      Returns a result representing no result.
      +
      static ResultnoResult(fj.data.Option<Result> r) +
      Returns a result from the given potential result.
      +
      booleanpassed() +
      Returns true if this result is unfalsified or proven; otherwise, + false.
      +
      static Resultproven(fj.data.List<Arg<?>> args) +
      Returns a proven result.
      +
      ResultprovenAsUnfalsified() +
      If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
      +
      fj.data.Option<Result>toOption() +
      Returns a potential result for this result.
      +
      static Resultunfalsified(fj.data.List<Arg<?>> args) +
      Returns an unfalsified result.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        args

        +
        public fj.data.Option<fj.data.List<Arg<?>>> args()
        +
        Returns the potential arguments associated with this result. This will only have a value, if + and only if !noResult() holds.
        +
        +
        Returns:
        +
        The potential arguments associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public fj.data.Option<java.lang.Throwable> exception()
        +
        Returns the potential exception associated with this result. This will only have a value if and + only if this result is an exception result.
        +
        +
        Returns:
        +
        The potential exception associated with this result.
        +
        +
        • +
      + + + +
        +
      • +

        isUnfalsified

        +
        public boolean isUnfalsified()
        +
        Returns true if this result is unfalsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is unfalsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isFalsified

        +
        public boolean isFalsified()
        +
        Returns true if this result is falsified; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is falsified; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isProven

        +
        public boolean isProven()
        +
        Returns true if this result is proven; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is proven; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isException

        +
        public boolean isException()
        +
        Returns true if this result is an exception; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is an exception; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        isNoResult

        +
        public boolean isNoResult()
        +
        Returns true if this result is no result; otherwise, false.
        +
        +
        Returns:
        +
        true if this result is no result; otherwise, false.
        +
        +
        • +
      + + + +
        +
      • +

        failed

        +
        public boolean failed()
        +
        Returns true if this result is falsified or an exception; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is falsified or an exception; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        passed

        +
        public boolean passed()
        +
        Returns true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        Returns:
        +
        true if this result is unfalsified or proven; otherwise, + false.
        +
        +
        • +
      + + + +
        +
      • +

        provenAsUnfalsified

        +
        public Result provenAsUnfalsified()
        +
        If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
        +
        +
        Returns:
        +
        If this result is proven, alter it to be unfalsified with the same arguments; + otherwise, return this.
        +
        +
        • +
      + + + +
        +
      • +

        addArg

        +
        public Result addArg(Arg<?> a)
        +
        Adds an argument to this result.
        +
        +
        Parameters:
        +
        a - The argument to add.
        +
        Returns:
        +
        A result with the new argument.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public fj.data.Option<Result> toOption()
        +
        Returns a potential result for this result. This will have a value if this result is + !noResult().
        +
        +
        Returns:
        +
        A potential result for this result.
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult(fj.data.Option<Result> r)
        +
        Returns a result from the given potential result.
        +
        +
        Parameters:
        +
        r - The potential result.
        +
        Returns:
        +
        The result that may be noResult().
        +
        +
        • +
      + + + +
        +
      • +

        noResult

        +
        public static Result noResult()
        +
        Returns a result representing no result.
        +
        +
        Returns:
        +
        A result representing no result.
        +
        +
        • +
      + + + +
        +
      • +

        unfalsified

        +
        public static Result unfalsified(fj.data.List<Arg<?>> args)
        +
        Returns an unfalsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during the failure of falsification.
        +
        Returns:
        +
        An unfalsified result.
        +
        +
        • +
      + + + +
        +
      • +

        falsified

        +
        public static Result falsified(fj.data.List<Arg<?>> args)
        +
        Returns a falsified result.
        +
        +
        Parameters:
        +
        args - The arguments used during falsification.
        +
        Returns:
        +
        A falsified result.
        +
        +
        • +
      + + + +
        +
      • +

        proven

        +
        public static Result proven(fj.data.List<Arg<?>> args)
        +
        Returns a proven result.
        +
        +
        Parameters:
        +
        args - The arguments used during proof.
        +
        Returns:
        +
        A proven result.
        +
        +
        • +
      + + + +
        +
      • +

        exception

        +
        public static Result exception(fj.data.List<Arg<?>> args,
+                               java.lang.Throwable t)
        +
        Returns an exception result.
        +
        +
        Parameters:
        +
        args - The arguments used when the exception occurred.
        +
        t - The exception that occurred.
        +
        Returns:
        +
        A exception result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Shrink.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Shrink.html new file mode 100644 index 0000000..9f96739 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Shrink.html @@ -0,0 +1,1679 @@ + + + + + +Shrink (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test
+

Class Shrink<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Shrink<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Shrink<A>
+extends java.lang.Object
    +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure. This is used in falsification to produce the smallest counter-example, rather + than the first counter-example.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        shrinkLong

        +
        public static final Shrink<java.lang.Long> shrinkLong
        +
        A shrink strategy for longs using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkBoolean

        +
        public static final Shrink<java.lang.Boolean> shrinkBoolean
        +
        A shrink strategy for booleans using false as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkInteger

        +
        public static final Shrink<java.lang.Integer> shrinkInteger
        +
        A shrink strategy for integers using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkByte

        +
        public static final Shrink<java.lang.Byte> shrinkByte
        +
        A shrink strategy for bytes using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkCharacter

        +
        public static final Shrink<java.lang.Character> shrinkCharacter
        +
        A shrink strategy for characters using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkShort

        +
        public static final Shrink<java.lang.Short> shrinkShort
        +
        A shrink strategy for shorts using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkFloat

        +
        public static final Shrink<java.lang.Float> shrinkFloat
        +
        A shrink strategy for floats using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkDouble

        +
        public static final Shrink<java.lang.Double> shrinkDouble
        +
        A shrink strategy for doubles using 0 as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkString

        +
        public static final Shrink<java.lang.String> shrinkString
        +
        A shrink strategy for strings using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuffer

        +
        public static final Shrink<java.lang.StringBuffer> shrinkStringBuffer
        +
        A shrink strategy for string buffers using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkStringBuilder

        +
        public static final Shrink<java.lang.StringBuilder> shrinkStringBuilder
        +
        A shrink strategy for string builders using the empty string as the bottom of the shrink.
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static final Shrink<java.lang.Throwable> shrinkThrowable
        +
        A shrink strategy for throwables.
        +
        • +
      + + + +
        +
      • +

        shrinkBitSet

        +
        public static final Shrink<java.util.BitSet> shrinkBitSet
        +
        A shrink strategy for bit sets.
        +
        • +
      + + + +
        +
      • +

        shrinkCalendar

        +
        public static final Shrink<java.util.Calendar> shrinkCalendar
        +
        A shrink strategy for calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkDate

        +
        public static final Shrink<java.util.Date> shrinkDate
        +
        A shrink strategy for dates.
        +
        • +
      + + + +
        +
      • +

        shrinkGregorianCalendar

        +
        public static final Shrink<java.util.GregorianCalendar> shrinkGregorianCalendar
        +
        A shrink strategy for gregorian calendars.
        +
        • +
      + + + +
        +
      • +

        shrinkProperties

        +
        public static final Shrink<java.util.Properties> shrinkProperties
        +
        A shrink strategy for properties.
        +
        • +
      + + + +
        +
      • +

        shrinkSQLDate

        +
        public static final Shrink<java.sql.Date> shrinkSQLDate
        +
        A shrink strategy for SQL dates.
        +
        • +
      + + + +
        +
      • +

        shrinkTime

        +
        public static final Shrink<java.sql.Time> shrinkTime
        +
        A shrink strategy for SQL times.
        +
        • +
      + + + +
        +
      • +

        shrinkTimestamp

        +
        public static final Shrink<java.sql.Timestamp> shrinkTimestamp
        +
        A shrink strategy for SQL timestamps.
        +
        • +
      + + + +
        +
      • +

        shrinkBigInteger

        +
        public static final Shrink<java.math.BigInteger> shrinkBigInteger
        +
        A shrink strategy for big integers.
        +
        • +
      + + + +
        +
      • +

        shrinkBigDecimal

        +
        public static final Shrink<java.math.BigDecimal> shrinkBigDecimal
        +
        A shrink strategy for big decimals.
        +
        • +
      + + + +
        +
      • +

        shrinkNatural

        +
        public static final Shrink<fj.data.Natural> shrinkNatural
        +
        A shrink strategy for naturals.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        shrink

        +
        public fj.data.Stream<A> shrink(A a)
        +
        Returns a shrink of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to shrink.
        +
        Returns:
        +
        A shrink of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Shrink<B> map(fj.F<A,B> f,
+                         fj.F<B,A> g)
        +
        Creates a shrink from this shrink and the given symmetric transformations.
        +
        +
        Parameters:
        +
        f - A transformation from this shrink type to the new shrink type.
        +
        g - A transformation from the new shrink type to this shrink type.
        +
        Returns:
        +
        A shrink from this shrink and the given symmetric transformations.
        +
        +
        • +
      + + + +
        +
      • +

        shrink

        +
        public static <A> Shrink<A> shrink(fj.F<A,fj.data.Stream<A>> f)
        +
        Constructs a shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        Parameters:
        +
        f - A function that produces a tree of values given a value.
        +
        Returns:
        +
        A shrink strategy from the given function that produces a tree of values given a + value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Shrink<A> empty()
        +
        Returns a shrink strategy that cannot be reduced further.
        +
        +
        Returns:
        +
        A shrink strategy that cannot be reduced further.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkOption

        +
        public static <A> Shrink<fj.data.Option<A>> shrinkOption(Shrink<A> sa)
        +
        Returns a shrink strategy for optional values. A 'no value' is already fully + shrunk, otherwise, the shrinking occurs on the value with the given shrink strategy.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the potential value.
        +
        Returns:
        +
        A shrink strategy for optional values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEither

        +
        public static <A,B> Shrink<fj.data.Either<A,B>> shrinkEither(Shrink<A> sa,
+                                                             Shrink<B> sb)
        +
        Returns a shrink strategy for either values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for left values.
        +
        sb - The shrinking strategy for right values.
        +
        Returns:
        +
        A shrink strategy for either values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkList

        +
        public static <A> Shrink<fj.data.List<A>> shrinkList(Shrink<A> sa)
        +
        Returns a shrink strategy for lists. An empty list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the list.
        +
        Returns:
        +
        A shrink strategy for lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArray

        +
        public static <A> Shrink<fj.data.Array<A>> shrinkArray(Shrink<A> sa)
        +
        Returns a shrink strategy for arrays. An empty array is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array.
        +
        Returns:
        +
        A shrink strategy for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStream

        +
        public static <A> Shrink<fj.data.Stream<A>> shrinkStream(Shrink<A> sa)
        +
        Returns a shrink strategy for streams. An empty stream is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the stream.
        +
        Returns:
        +
        A shrink strategy for streams.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkThrowable

        +
        public static Shrink<java.lang.Throwable> shrinkThrowable(Shrink<java.lang.String> ss)
        +
        A shrink strategy for throwables.
        +
        +
        Parameters:
        +
        ss - A shrink strategy for throwable messages.
        +
        Returns:
        +
        A shrink strategy for throwables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayList

        +
        public static <A> Shrink<java.util.ArrayList<A>> shrinkArrayList(Shrink<A> sa)
        +
        Returns a shrink strategy for array lists. An empty array list is fully shrunk.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements of the array list.
        +
        Returns:
        +
        A shrink strategy for array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumMap

        +
        public static <K extends java.lang.Enum<K>,V> Shrink<java.util.EnumMap<K,V>> shrinkEnumMap(Shrink<K> sk,
+                                                                                           Shrink<V> sv)
        +
        A shrink strategy for enum maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for enum maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkEnumSet

        +
        public static <A extends java.lang.Enum<A>> Shrink<java.util.EnumSet<A>> shrinkEnumSet(Shrink<A> sa)
        +
        A shrink strategy for enum sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashMap

        +
        public static <K,V> Shrink<java.util.HashMap<K,V>> shrinkHashMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashSet

        +
        public static <A> Shrink<java.util.HashSet<A>> shrinkHashSet(Shrink<A> sa)
        +
        A shrink strategy for hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkHashtable

        +
        public static <K,V> Shrink<java.util.Hashtable<K,V>> shrinkHashtable(Shrink<K> sk,
+                                                                     Shrink<V> sv)
        +
        A shrink strategy for hash tables.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for hash tables.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkIdentityHashMap

        +
        public static <K,V> Shrink<java.util.IdentityHashMap<K,V>> shrinkIdentityHashMap(Shrink<K> sk,
+                                                                                 Shrink<V> sv)
        +
        A shrink strategy for identity hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for identity hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashMap

        +
        public static <K,V> Shrink<java.util.LinkedHashMap<K,V>> shrinkLinkedHashMap(Shrink<K> sk,
+                                                                             Shrink<V> sv)
        +
        A shrink strategy for linked hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for linked hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedHashSet

        +
        public static <A> Shrink<java.util.LinkedHashSet<A>> shrinkLinkedHashSet(Shrink<A> sa)
        +
        A shrink strategy for linked hash sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedList

        +
        public static <A> Shrink<java.util.LinkedList<A>> shrinkLinkedList(Shrink<A> sa)
        +
        A shrink strategy for linked lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityQueue

        +
        public static <A> Shrink<java.util.PriorityQueue<A>> shrinkPriorityQueue(Shrink<A> sa)
        +
        A shrink strategy for priority queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkStack

        +
        public static <A> Shrink<java.util.Stack<A>> shrinkStack(Shrink<A> sa)
        +
        A shrink strategy for stacks.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for stacks.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeMap

        +
        public static <K,V> Shrink<java.util.TreeMap<K,V>> shrinkTreeMap(Shrink<K> sk,
+                                                                 Shrink<V> sv)
        +
        A shrink strategy for tree maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for tree maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkTreeSet

        +
        public static <A> Shrink<java.util.TreeSet<A>> shrinkTreeSet(Shrink<A> sa)
        +
        A shrink strategy for tree sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkVector

        +
        public static <A> Shrink<java.util.Vector<A>> shrinkVector(Shrink<A> sa)
        +
        A shrink strategy for vectors.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for vectors.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkWeakHashMap

        +
        public static <K,V> Shrink<java.util.WeakHashMap<K,V>> shrinkWeakHashMap(Shrink<K> sk,
+                                                                         Shrink<V> sv)
        +
        A shrink strategy for weak hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for weak hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkArrayBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.ArrayBlockingQueue<A>> shrinkArrayBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for array blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentHashMap

        +
        public static <K,V> Shrink<java.util.concurrent.ConcurrentHashMap<K,V>> shrinkConcurrentHashMap(Shrink<K> sk,
+                                                                                                Shrink<V> sv)
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        Parameters:
        +
        sk - The shrink strategy for keys.
        +
        sv - The shrink strategy for values.
        +
        Returns:
        +
        A shrink strategy for concurrent hash maps.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkConcurrentLinkedQueue

        +
        public static <A> Shrink<java.util.concurrent.ConcurrentLinkedQueue<A>> shrinkConcurrentLinkedQueue(Shrink<A> sa)
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArrayList

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArrayList<A>> shrinkCopyOnWriteArrayList(Shrink<A> sa)
        +
        A shrink strategy for copy on write array lists.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkCopyOnWriteArraySet

        +
        public static <A> Shrink<java.util.concurrent.CopyOnWriteArraySet<A>> shrinkCopyOnWriteArraySet(Shrink<A> sa)
        +
        A shrink strategy for copy on write array sets.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkDelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> Shrink<java.util.concurrent.DelayQueue<A>> shrinkDelayQueue(Shrink<A> sa)
        +
        A shrink strategy for delay queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkLinkedBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.LinkedBlockingQueue<A>> shrinkLinkedBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for linked blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkPriorityBlockingQueue

        +
        public static <A> Shrink<java.util.concurrent.PriorityBlockingQueue<A>> shrinkPriorityBlockingQueue(Shrink<A> sa)
        +
        A shrink strategy for priority blocking queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkSynchronousQueue

        +
        public static <A> Shrink<java.util.concurrent.SynchronousQueue<A>> shrinkSynchronousQueue(Shrink<A> sa)
        +
        A shrink strategy for synchronous queues.
        +
        +
        Parameters:
        +
        sa - The shrink strategy for the elements.
        +
        Returns:
        +
        A shrink strategy for synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP1

        +
        public static <A> Shrink<fj.P1<A>> shrinkP1(Shrink<A> sa)
        +
        Returns a shrinking strategy for product-1 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-1 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP2

        +
        public static <A,B> Shrink<fj.P2<A,B>> shrinkP2(Shrink<A> sa,
+                                                Shrink<B> sb)
        +
        Returns a shrinking strategy for product-2 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-2 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP3

        +
        public static <A,B,C> Shrink<fj.P3<A,B,C>> shrinkP3(Shrink<A> sa,
+                                                    Shrink<B> sb,
+                                                    Shrink<C> sc)
        +
        Returns a shrinking strategy for product-3 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-3 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP4

        +
        public static <A,B,C,D> Shrink<fj.P4<A,B,C,D>> shrinkP4(Shrink<A> sa,
+                                                        Shrink<B> sb,
+                                                        Shrink<C> sc,
+                                                        Shrink<D> sd)
        +
        Returns a shrinking strategy for product-4 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-4 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP5

        +
        public static <A,B,C,D,E> Shrink<fj.P5<A,B,C,D,E>> shrinkP5(Shrink<A> sa,
+                                                            Shrink<B> sb,
+                                                            Shrink<C> sc,
+                                                            Shrink<D> sd,
+                                                            Shrink<E> se)
        +
        Returns a shrinking strategy for product-5 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-5 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP6

        +
        public static <A,B,C,D,E,F$> Shrink<fj.P6<A,B,C,D,E,F$>> shrinkP6(Shrink<A> sa,
+                                                                  Shrink<B> sb,
+                                                                  Shrink<C> sc,
+                                                                  Shrink<D> sd,
+                                                                  Shrink<E> se,
+                                                                  Shrink<F$> sf)
        +
        Returns a shrinking strategy for product-6 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-6 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP7

        +
        public static <A,B,C,D,E,F$,G> Shrink<fj.P7<A,B,C,D,E,F$,G>> shrinkP7(Shrink<A> sa,
+                                                                      Shrink<B> sb,
+                                                                      Shrink<C> sc,
+                                                                      Shrink<D> sd,
+                                                                      Shrink<E> se,
+                                                                      Shrink<F$> sf,
+                                                                      Shrink<G> sg)
        +
        Returns a shrinking strategy for product-7 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-7 values.
        +
        +
        • +
      + + + +
        +
      • +

        shrinkP8

        +
        public static <A,B,C,D,E,F$,G,H> Shrink<fj.P8<A,B,C,D,E,F$,G,H>> shrinkP8(Shrink<A> sa,
+                                                                          Shrink<B> sb,
+                                                                          Shrink<C> sc,
+                                                                          Shrink<D> sd,
+                                                                          Shrink<E> se,
+                                                                          Shrink<F$> sf,
+                                                                          Shrink<G> sg,
+                                                                          Shrink<H> sh)
        +
        Returns a shrinking strategy for product-8 values.
        +
        +
        Parameters:
        +
        sa - The shrinking strategy for the values.
        +
        sb - The shrinking strategy for the values.
        +
        sc - The shrinking strategy for the values.
        +
        sd - The shrinking strategy for the values.
        +
        se - The shrinking strategy for the values.
        +
        sf - The shrinking strategy for the values.
        +
        sg - The shrinking strategy for the values.
        +
        sh - The shrinking strategy for the values.
        +
        Returns:
        +
        a shrinking strategy for product-8 values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/Variant.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/Variant.html new file mode 100644 index 0000000..b3a2c01 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/Variant.html @@ -0,0 +1,269 @@ + + + + + +Variant (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test
+

Class Variant

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.Variant
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Variant
+extends java.lang.Object
    +
    A memoised generator variant. Stores generators that have already been computed for the given arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> fj.F<Gen<A>,Gen<A>>variant(long n) +
      A curried version of variant(long, Gen).
      +
      static <A> Gen<A>variant(long n, + Gen<A> g) +
      Produces a generator that is independent of the given generator using the given value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        variant

        +
        public static <A> Gen<A> variant(long n,
+                                 Gen<A> g)
        +
        Produces a generator that is independent of the given generator using the given value.
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        g - The generator to produce the new generator from.
        +
        Returns:
        +
        A generator that is independent of the given generator using the given value.
        +
        +
        • +
      + + + +
        +
      • +

        variant

        +
        public static <A> fj.F<Gen<A>,Gen<A>> variant(long n)
        +
        A curried version of variant(long, Gen).
        +
        +
        Parameters:
        +
        n - The value to produce the new generator from.
        +
        Returns:
        +
        A curried version of variant(long, Gen).
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/package-frame.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-frame.html new file mode 100644 index 0000000..eafb355 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-frame.html @@ -0,0 +1,29 @@ + + + + + +fj.test (quickcheck 5.0 API) + + + + +

fj.test

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/package-summary.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-summary.html new file mode 100644 index 0000000..22a286e --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-summary.html @@ -0,0 +1,224 @@ + + + + + +fj.test (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test

+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Arbitrary +
    Common Gen helper functions.
    +
    Arg<T> +
    An argument used in a property that may have undergone shrinking following falsification.
    +
    Bool +
    A boolean wrapper that works well with properties.
    +
    CheckResult +
    An enumeration of the possible results after checking a property.
    +
    Cogen<A> +
    Transforms a type and a generator to produce a new generator.
    +
    Gen<A> +
    A generator for values of the type of the given type parameter (A).
    +
    Property +
    Represents an algebraic property about a program that may be checked for its truth value.
    +
    Rand +
    A random number generator.
    +
    Result +
    The result of evaluating a property.
    +
    Shrink<A> +
    Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
    +
    Variant +
    A memoised generator variant.
    +
    +
    • +
+ + + +

Package fj.test Description

+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation. Reductio + encourages users to express properties or theorems about their software, and + the testing and reporting of the status of those properties occurs by automating various aspects. + For example, if a property is found to be false (i.e. a test fails), then the counter-example may + be reduced while still falsifying the property so that the reported counter-example is the + simplest found (this is called Shrink). The expression of the property also + serves as very rigorous documentation for the code under test; far surpassing that provided by + traditional testing techniques. + + Many of the concepts of Reductio originated with a paper called QuickCheck: A Lightweight Tool + for Random Testing of Haskell Programs by Koen Claassen and John Hughes from Chalmers University + of Technology. Reductio also borrows ideas from ScalaCheck by Rickard Nilsson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/package-tree.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-tree.html new file mode 100644 index 0000000..d0ef553 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/package-tree.html @@ -0,0 +1,144 @@ + + + + + +fj.test Class Hierarchy (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Category.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Category.html new file mode 100644 index 0000000..d26fbb7 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Category.html @@ -0,0 +1,222 @@ + + + + + +Category (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Category

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Category
    +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      The categories of the property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        The categories of the property.
        +
        +
        Returns:
        +
        The categories of the property.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Check.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Check.html new file mode 100644 index 0000000..ed10d2b --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Check.html @@ -0,0 +1,496 @@ + + + + + +Check (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Check

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Check
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Check
+extends java.lang.Object
    +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given class using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + fj.data.List<java.lang.String> categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + Rand r, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes.
      +
      static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>>check(fj.data.List<java.lang.Class<T>> c, + java.lang.String... categories) +
      Returns the results and names of checking the properties on the given classes using a + standard random generator.
      +
      static <U,T extends U>
      fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>>      		properties(java.lang.Class<T> c, + java.lang.String... categories) +
      Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(fj.data.List<java.lang.Class<T>> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given classes.
        +
        +
        Parameters:
        +
        c - The classes to check the properties of.
        +
        r - The random generator to use to check the properties on the given classes.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given classes.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results and names of checking the properties on the given class using a + standard random generator.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          java.lang.String... categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        check

        +
        public static <T> fj.data.List<fj.P2<java.lang.String,CheckResult>> check(java.lang.Class<T> c,
+                                                                          Rand r,
+                                                                          fj.data.List<java.lang.String> categories)
        +
        Returns the results and names of checking the properties on the given class.
        +
        +
        Parameters:
        +
        c - The class to check the properties of.
        +
        r - The random generator to use to check the properties on the given class.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        The results of checking the properties on the given class.
        +
        +
        • +
      + + + +
        +
      • +

        properties

        +
        public static <U,T extends U> fj.data.List<fj.P3<Property,java.lang.String,fj.data.Option<CheckParams>>> properties(java.lang.Class<T> c,
+                                                                                                                    java.lang.String... categories)
        +
        Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations. For example, properties or their + enclosing class that are annotated with NoCheck are not considered. The name of a + property is specified by the annotation or if this annotation is not present, the + name of the method or field that represents the property.
        +
        +
        Parameters:
        +
        c - The class to look for properties on.
        +
        categories - The categories of properties to return. If no categories are specified, all + candidate properties are returned, otherwise, only those properties in the given categories are + returned (properties in no category are omitted in this latter case).
        +
        Returns:
        +
        All properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/CheckParams.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/CheckParams.html new file mode 100644 index 0000000..9842994 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/CheckParams.html @@ -0,0 +1,308 @@ + + + + + +CheckParams (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type CheckParams

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={TYPE,FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface CheckParams
    +
    Specifies the check parameters on a Property property with typical defaults.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmaxDiscarded +
      The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e.
      +
      intmaxSize +
      The maximum size to use for checking.
      +
      intminSize +
      The minimum size to use for checking.
      +
      intminSuccessful +
      The minimum number of successful tests before a result is reached.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        minSuccessful

        +
        public abstract int minSuccessful
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        Returns:
        +
        The minimum number of successful tests before a result is reached.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxDiscarded

        +
        public abstract int maxDiscarded
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        Returns:
        +
        The maximum number of tests discarded because they did not satisfy pre-conditions + (i.e. Property.implies(boolean, F0)).
        +
        +
        +
        Default:
        +
        500
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        minSize

        +
        public abstract int minSize
        +
        The minimum size to use for checking.
        +
        +
        Returns:
        +
        The minimum size to use for checking.
        +
        +
        +
        Default:
        +
        0
        +
        +
        • +
      +
      • +
    +
      +
    • + + +
        +
      • +

        maxSize

        +
        public abstract int maxSize
        +
        The maximum size to use for checking.
        +
        +
        Returns:
        +
        The maximum size to use for checking.
        +
        +
        +
        Default:
        +
        100
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Main.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Main.html new file mode 100644 index 0000000..41fd4d7 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Main.html @@ -0,0 +1,244 @@ + + + + + +Main (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Class Main

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.test.reflect.Main
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Main
+extends java.lang.Object
    +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories. The class name and categories are passed as command line arguments.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String... args) +
      Check the given class and categories.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String... args)
        +
        Check the given class and categories. At least one command line argument (the class name) must be + passed or an error message results.
        +
        +
        Parameters:
        +
        args - The class name as the first argument, then zero or more categories.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Name.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Name.html new file mode 100644 index 0000000..97dae99 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/Name.html @@ -0,0 +1,220 @@ + + + + + +Name (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type Name

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface Name
    +
    The name of a property to be used in reporting.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      The name of a property to be used in reporting.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        The name of a property to be used in reporting.
        +
        +
        Returns:
        +
        The name of a property to be used in reporting.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/NoCheck.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/NoCheck.html new file mode 100644 index 0000000..b0eeb6a --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/NoCheck.html @@ -0,0 +1,165 @@ + + + + + +NoCheck (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
fj.test.reflect
+

Annotation Type NoCheck

+
+
+
+
    +
  • +
    +
    +
    @Documented
+ @Target(value={FIELD,TYPE,METHOD})
+ @Retention(value=RUNTIME)
+ @Inherited
+public @interface NoCheck
    +
    Denotes that a property should be excluded from any checking.
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-frame.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-frame.html new file mode 100644 index 0000000..c6ae269 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-frame.html @@ -0,0 +1,27 @@ + + + + + +fj.test.reflect (quickcheck 5.0 API) + + + + +

fj.test.reflect

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-summary.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-summary.html new file mode 100644 index 0000000..8b71c14 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-summary.html @@ -0,0 +1,226 @@ + + + + + +fj.test.reflect (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.reflect

+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Check +
    Functions for checking properties in a class that are found reflectively and according to various + annotations.
    +
    Main +
    Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Annotation Types Summary 
    Annotation TypeDescription
    Category +
    Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
    +
    CheckParams +
    Specifies the check parameters on a Property property with typical defaults.
    +
    Name +
    The name of a property to be used in reporting.
    +
    NoCheck +
    Denotes that a property should be excluded from any checking.
    +
    +
    • +
+ + + +

Package fj.test.reflect Description

+
A wrapper around the fj.test package that uses annotations for configuring properties to + check. The properties are found using reflection. All annotations + are optional and a property is eligible for checking by default. A property is any of the + following member descriptions, unless the member or enclosing class is annotated with + NoCheck. + +
    +
  • a static field of type Property.
    • +
  • a static zero argument method that returns Property.
    • +
  • a non-static field of type Property in a class with a zero-argument constructor.
    • +
  • a non-static no-argument method that returns Property in a class with a no-argument + constructor.
    • +
+ +

+ A property may be in zero or more categories by annotating the member or enclosing class with + Category. The property is in the set of categories that make up the + union of its member and enclosing class category annotation. +

+

+ When a property is checked, it uses default configuration values, which may be overridden by + annotating the member or the enclosing class with the CheckParams + annotation. The values used are first those specified on the member; or if the annotation does + not exist, then the enclosing class (default values otherwise). +

+

+ A property can have a name associated with it by annotating the member with the + Name annotation. The name is a String that is used + only for reporting in check results. If the Name annotation does not + appear on a property member, then the field or method name is used by default. +

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-tree.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-tree.html new file mode 100644 index 0000000..82b7d0e --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/reflect/package-tree.html @@ -0,0 +1,142 @@ + + + + + +fj.test.reflect Class Hierarchy (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.reflect

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.test.reflect.Check
      • +
    • fj.test.reflect.Main
      • +
    +
    • +
+

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html new file mode 100644 index 0000000..08e946c --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/PropertyTestRunner.html @@ -0,0 +1,328 @@ + + + + + +PropertyTestRunner (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.test.runner
+

Class PropertyTestRunner

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.junit.runner.Runner
      • +
    • +
        +
      • fj.test.runner.PropertyTestRunner
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.junit.runner.Describable, org.junit.runner.manipulation.Filterable
    +
    +
    +
    +
    public class PropertyTestRunner
+extends org.junit.runner.Runner
+implements org.junit.runner.manipulation.Filterable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PropertyTestRunner(java.lang.Class<?> clas) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidfilter(org.junit.runner.manipulation.Filter filter) 
      org.junit.runner.DescriptiongetDescription() 
      voidrun(org.junit.runner.notification.RunNotifier notifier) 
      +
        +
      • + + +

        Methods inherited from class org.junit.runner.Runner

        +testCount
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PropertyTestRunner

        +
        public PropertyTestRunner(java.lang.Class<?> clas)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDescription

        +
        public final org.junit.runner.Description getDescription()
        +
        +
        Specified by:
        +
        getDescription in interface org.junit.runner.Describable
        +
        Specified by:
        +
        getDescription in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final void run(org.junit.runner.notification.RunNotifier notifier)
        +
        +
        Specified by:
        +
        run in class org.junit.runner.Runner
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final void filter(org.junit.runner.manipulation.Filter filter)
+                  throws org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        Specified by:
        +
        filter in interface org.junit.runner.manipulation.Filterable
        +
        Throws:
        +
        org.junit.runner.manipulation.NoTestsRemainException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-frame.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-frame.html new file mode 100644 index 0000000..4a92b55 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-frame.html @@ -0,0 +1,19 @@ + + + + + +fj.test.runner (quickcheck 5.0 API) + + + + +

fj.test.runner

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-summary.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-summary.html new file mode 100644 index 0000000..5f10c72 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-summary.html @@ -0,0 +1,139 @@ + + + + + +fj.test.runner (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.test.runner

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-tree.html b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-tree.html new file mode 100644 index 0000000..ccf281b --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/fj/test/runner/package-tree.html @@ -0,0 +1,138 @@ + + + + + +fj.test.runner Class Hierarchy (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.test.runner

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • org.junit.runner.Runner (implements org.junit.runner.Describable) +
        +
      • fj.test.runner.PropertyTestRunner (implements org.junit.runner.manipulation.Filterable)
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/help-doc.html b/javadoc/5.0/functionaljava-quickcheck/help-doc.html new file mode 100644 index 0000000..977a5c5 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/help-doc.html @@ -0,0 +1,222 @@ + + + + + +API Help (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/index-all.html b/javadoc/5.0/functionaljava-quickcheck/index-all.html new file mode 100644 index 0000000..85ff42a --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/index-all.html @@ -0,0 +1,2119 @@ + + + + + +Index (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
A B C D E F G I J L M N O P R S T U V W  + + +

A

+
+
addArg(Arg<?>) - Method in class fj.test.Result
+
+
Adds an argument to this result.
+
+
and(Property) - Method in class fj.test.Property
+
+
Performs a conjunction of this property with the given property.
+
+
apply(Gen<F<A, B>>) - Method in class fj.test.Gen
+
+
Function application within this generator to produce a new generator.
+
+
arbAlphaNumString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with alpha-numeric characters.
+
+
arbArray(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for arrays.
+
+
arbArrayBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array blocking queues.
+
+
arbArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for array lists.
+
+
arbBigDecimal - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big decimals.
+
+
arbBigInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for big integers.
+
+
arbBitSet - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for bit sets.
+
+
arbBoolean - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for boolean values.
+
+
arbByte - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values.
+
+
arbByteBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for byte values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbByte + the remainder of the time (93%).
+
+
arbCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for calendars.
+
+
arbCharacter - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values.
+
+
arbCharacterBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for character values that checks boundary values (max, min, + max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbCharacter + the remainder of the time (96%).
+
+
arbConcurrentHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent hash maps.
+
+
arbConcurrentLinkedQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for concurrent linked queues.
+
+
arbCopyOnWriteArrayList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array lists.
+
+
arbCopyOnWriteArraySet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for copy-on-write array sets.
+
+
arbDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for dates.
+
+
arbDelayQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for delay queues.
+
+
arbDouble - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values.
+
+
arbDoubleBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for double values that checks boundary values (0, 1, -1, max, + min, min (normal), NaN, -infinity, infinity, max - 1) with a frequency of 1% each then + generates from Arbitrary.arbDouble the remainder of the time (91%).
+
+
arbEither(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for the disjoint union.
+
+
arbEnumMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum maps.
+
+
arbEnumSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for enum sets.
+
+
arbEnumValue(Class<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for a Java enumeration.
+
+
arbF(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbF2(Cogen<A>, Cogen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF2Invariant(Gen<C>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-2.
+
+
arbF3(Cogen<A>, Cogen<B>, Cogen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF3Invariant(Gen<D>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-3.
+
+
arbF4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF4Invariant(Gen<E>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-4.
+
+
arbF5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF5Invariant(Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-5.
+
+
arbF6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF6Invariant(Gen<G>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-6.
+
+
arbF7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF7Invariant(Gen<H>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-7.
+
+
arbF8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>, Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbF8Invariant(Gen<I>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for function-8.
+
+
arbFInvariant(Gen<B>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for functions.
+
+
arbFloat - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values.
+
+
arbFloatBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for float values that checks boundary values (0, 1, -1, max, + min, NaN, -infinity, infinity, max - 1) with a frequency of 1% each then generates from + Arbitrary.arbFloat the remainder of the time (91%).
+
+
arbGen(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for generators.
+
+
arbGregorianCalendar - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for gregorian calendars.
+
+
arbHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash maps.
+
+
arbHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbHashtable(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash tables.
+
+
arbIdentityHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for identity hash maps.
+
+
arbInteger - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values.
+
+
arbIntegerBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for integer values that checks boundary values (0, 1, -1, + max, min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbInteger the remainder of the time (93%).
+
+
Arbitrary - Class in fj.test
+
+
Common Gen helper functions.
+
+
Arbitrary() - Constructor for class fj.test.Arbitrary
+
 
+
arbJavaTreeMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for java.util tree maps.
+
+
arbLcgRng() - Static method in class fj.test.Arbitrary
+
+
An arbitrary for the LcgRng.
+
+
arbLinkedBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked blocking queues.
+
+
arbLinkedHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked hash maps.
+
+
arbLinkedHashSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for hash sets.
+
+
arbLinkedList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for linked lists.
+
+
arbList(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for lists.
+
+
arbListBoolean() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of booleans.
+
+
arbListDouble() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of doubles.
+
+
arbListInteger() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of integers.
+
+
arbListString() - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary list of strings.
+
+
arbLocale - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for locales.
+
+
arbLong - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values.
+
+
arbLongBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for long values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbLong + the remainder of the time (93%).
+
+
arbNatural - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for naturals.
+
+
arbNonEmptyList(Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbOption(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for optional values.
+
+
arbP1(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-1 values.
+
+
arbP2(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-2 values.
+
+
arbP3(Gen<A>, Gen<B>, Gen<C>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-3 values.
+
+
arbP4(Gen<A>, Gen<B>, Gen<C>, Gen<D>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-4 values.
+
+
arbP5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-5 values.
+
+
arbP6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-6 values.
+
+
arbP7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-7 values.
+
+
arbP8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for product-8 values.
+
+
arbParModule() - Static method in class fj.test.Arbitrary
+
 
+
arbPriorityBlockingQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbPriorityQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority queues.
+
+
arbProperties - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for properties.
+
+
arbReader(Cogen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
 
+
arbSeq(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for sequences.
+
+
arbSet(Ord<A>, Gen<A>) - Static method in class fj.test.Arbitrary
+
 
+
arbSet(Ord<A>, Gen<A>, int) - Static method in class fj.test.Arbitrary
+
 
+
arbShort - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values.
+
+
arbShortBoundaries - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for short values that checks boundary values (0, 1, -1, max, + min, max - 1, min + 1) with a frequency of 1% each then generates from Arbitrary.arbShort + the remainder of the time (93%).
+
+
arbSQLDate - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL dates.
+
+
arbStack(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for stacks.
+
+
arbState(Gen<S>, Cogen<S>, Gen<A>) - Static method in class fj.test.Arbitrary
+
+
An arbitrary for state.
+
+
arbStrategy() - Static method in class fj.test.Arbitrary
+
 
+
arbStream(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for streams.
+
+
arbString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values.
+
+
arbStringBuffer - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string buffer values.
+
+
arbStringBuilder - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string builder values.
+
+
arbSynchronousQueue(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for priority blocking queues.
+
+
arbThrowable - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for throwables.
+
+
arbThrowable(Gen<String>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for throwables.
+
+
arbTime - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL times.
+
+
arbTimestamp - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for SQL time stamps.
+
+
arbTreeMap(Ord<K>, Gen<List<P2<K, V>>>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, Gen<Integer>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the map size is the given arbitrary integer.
+
+
arbTreeMap(Ord<K>, Gen<K>, Gen<V>, int) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree maps where the size is less than or equal to the max size.
+
+
arbTreeSet(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for tree sets.
+
+
arbUSASCIIString - Static variable in class fj.test.Arbitrary
+
+
An arbitrary implementation for string values with characters in the US-ASCII range.
+
+
arbValidation(Gen<A>, Gen<B>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary Validation for the given arbitrary parameters.
+
+
arbVector(Gen<A>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for vectors.
+
+
arbWeakHashMap(Gen<K>, Gen<V>) - Static method in class fj.test.Arbitrary
+
+
Returns an arbitrary implementation for weak hash maps.
+
+
Arg<T> - Class in fj.test
+
+
An argument used in a property that may have undergone shrinking following falsification.
+
+
arg(T, int) - Static method in class fj.test.Arg
+
+
Construct a property argument with the given value and number of shrinks.
+
+
args() - Method in class fj.test.CheckResult
+
+
Returns the arguments if the result is one of; proven, falsified or exception during property + execution, otherwise, no arguments are returned.
+
+
args() - Method in class fj.test.Result
+
+
Returns the potential arguments associated with this result.
+
+
argShow - Static variable in class fj.test.Arg
+
+
The rendering of an argument (uses Object.toString() for the argument value).
+
+
assertResult(Property) - Static method in class fj.data.test.PropertyAssert
+
 
+
+ + + +

B

+
+
bind(F<A, Gen<B>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator to produce a new generator.
+
+
bind(Gen<B>, F<A, F<B, C>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generator to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, F<A, F<B, F<C, D>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
bind(Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.test.Gen
+
+
Binds the given function across this generator and the given generators to produce a new + generator.
+
+
Bool - Class in fj.test
+
+
A boolean wrapper that works well with properties.
+
+
bool(boolean) - Static method in class fj.test.Bool
+
+
Construct a Bool from the given value.
+
+
+ + + +

C

+
+
Category - Annotation Type in fj.test.reflect
+
+
Specifies the categories of a property, which are the union of + categories specified on the enclosing class and the categories specified on the method or field + that make up the property.
+
+
check(Rand, int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given arguments and produces a result.
+
+
check(int, int, int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator and the given + arguments to produce a result.
+
+
check(Rand) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
check(Rand, int, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum successful checks, 500 + maximum discarded tests, the given minimum size and the given maximum size.
+
+
check(int, int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests and the given arguments to produce a result.
+
+
check() - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
Check - Class in fj.test.reflect
+
+
Functions for checking properties in a class that are found reflectively and according to various + annotations.
+
+
check(List<Class<T>>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes using a + standard random generator.
+
+
check(List<Class<T>>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(List<Class<T>>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given classes.
+
+
check(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class using a + standard random generator.
+
+
check(Class<T>, Rand, String...) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
check(Class<T>, Rand, List<String>) - Static method in class fj.test.reflect.Check
+
+
Returns the results and names of checking the properties on the given class.
+
+
CheckParams - Annotation Type in fj.test.reflect
+
+
Specifies the check parameters on a Property property with typical defaults.
+
+
CheckResult - Class in fj.test
+
+
An enumeration of the possible results after checking a property.
+
+
choose(int, int) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, long) - Static method in class fj.test.Gen
+
 
+
choose(double, double) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values between the given range (inclusive).
+
+
choose(long, int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(int, int) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(long, long) - Method in class fj.test.Rand
+
 
+
choose(long, double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
choose(double, double) - Method in class fj.test.Rand
+
+
Randomly chooses a value between the given range (inclusive).
+
+
Cogen<A> - Class in fj.test
+
+
Transforms a type and a generator to produce a new generator.
+
+
Cogen() - Constructor for class fj.test.Cogen
+
 
+
cogen(A, Gen<B>) - Method in class fj.test.Cogen
+
+
Transforms the given value and generator to a new generator with a high probability of being + independent.
+
+
cogen(A) - Method in class fj.test.Cogen
+
+
A curried version of Cogen.cogen(Object, Gen).
+
+
cogenArray(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for arrays.
+
+
cogenArrayBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array blocking queues.
+
+
cogenArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for array lists.
+
+
cogenBigDecimal - Static variable in class fj.test.Cogen
+
 
+
cogenBigInteger - Static variable in class fj.test.Cogen
+
 
+
cogenBitSet - Static variable in class fj.test.Cogen
+
+
A cogen for bit sets.
+
+
cogenBoolean - Static variable in class fj.test.Cogen
+
+
A cogen for booleans.
+
+
cogenByte - Static variable in class fj.test.Cogen
+
+
A cogen for bytes.
+
+
cogenCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for calendars.
+
+
cogenCharacter - Static variable in class fj.test.Cogen
+
+
A cogen for characters.
+
+
cogenConcurrentHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent hash maps.
+
+
cogenConcurrentLinkedQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for concurrent linked queues.
+
+
cogenCopyOnWriteArrayList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array lists.
+
+
cogenCopyOnWriteArraySet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for copy-on-write array sets.
+
+
cogenDate - Static variable in class fj.test.Cogen
+
+
A cogen for dates.
+
+
cogenDelayQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for delay queues.
+
+
cogenDouble - Static variable in class fj.test.Cogen
+
+
A cogen for doubles.
+
+
cogenEither(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for the disjoint union.
+
+
cogenEnumMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for enum maps.
+
+
cogenEnumSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for enum sets.
+
+
cogenF(Gen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for a function.
+
+
cogenF2(Gen<A>, Gen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-2.
+
+
cogenF3(Gen<A>, Gen<B>, Gen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-3.
+
+
cogenF4(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-4.
+
+
cogenF5(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-5.
+
+
cogenF6(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-6.
+
+
cogenF7(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-7.
+
+
cogenF8(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Cogen<I>) - Static method in class fj.test.Cogen
+
+
A cogen for a function-8.
+
+
cogenFloat - Static variable in class fj.test.Cogen
+
+
A cogen for floats.
+
+
cogenGregorianCalendar - Static variable in class fj.test.Cogen
+
+
A cogen for gregorian calendars.
+
+
cogenHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash maps.
+
+
cogenHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for hash sets.
+
+
cogenHashtable(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for hash tables.
+
+
cogenIdentityHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for identity hash maps.
+
+
cogenInteger - Static variable in class fj.test.Cogen
+
+
A cogen for integers.
+
+
cogenLcgRng() - Static method in class fj.test.Cogen
+
+
A cogen for the provided LcgRng
+
+
cogenLinkedBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked blocking queues.
+
+
cogenLinkedHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash maps.
+
+
cogenLinkedHashSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked hash sets.
+
+
cogenLinkedList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for linked lists.
+
+
cogenList(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for lists.
+
+
cogenLong - Static variable in class fj.test.Cogen
+
+
A cogen for longs.
+
+
cogenOption(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for the optional value.
+
+
cogenP1(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for product-1 values.
+
+
cogenP2(Cogen<A>, Cogen<B>) - Static method in class fj.test.Cogen
+
+
A cogen for product-2 values.
+
+
cogenP3(Cogen<A>, Cogen<B>, Cogen<C>) - Static method in class fj.test.Cogen
+
+
A cogen for product-3 values.
+
+
cogenP4(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>) - Static method in class fj.test.Cogen
+
+
A cogen for product-4 values.
+
+
cogenP5(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>) - Static method in class fj.test.Cogen
+
+
A cogen for product-5 values.
+
+
cogenP6(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>) - Static method in class fj.test.Cogen
+
+
A cogen for product-6 values.
+
+
cogenP7(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>) - Static method in class fj.test.Cogen
+
+
A cogen for product-7 values.
+
+
cogenP8(Cogen<A>, Cogen<B>, Cogen<C>, Cogen<D>, Cogen<E>, Cogen<F$>, Cogen<G>, Cogen<H>) - Static method in class fj.test.Cogen
+
+
A cogen for product-8 values.
+
+
cogenPriorityBlockingQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority blocking queues.
+
+
cogenPriorityQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for priority queues.
+
+
cogenProperties - Static variable in class fj.test.Cogen
+
+
A cogen for properties.
+
+
cogenShort - Static variable in class fj.test.Cogen
+
+
A cogen for shorts.
+
+
cogenSQLDate - Static variable in class fj.test.Cogen
+
 
+
cogenStack(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for stacks.
+
+
cogenState(Gen<S>, F2<S, A, Long>) - Static method in class fj.test.Cogen
+
+
A cogen for state.
+
+
cogenStream(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for streams.
+
+
cogenString - Static variable in class fj.test.Cogen
+
+
A cogen for strings.
+
+
cogenStringBuffer - Static variable in class fj.test.Cogen
+
+
A cogen for string buffers.
+
+
cogenStringBuilder - Static variable in class fj.test.Cogen
+
+
A cogen for string builders.
+
+
cogenSynchronousQueue(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for synchronous queues.
+
+
cogenThrowable - Static variable in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenThrowable(Cogen<String>) - Static method in class fj.test.Cogen
+
+
A cogen for throwables.
+
+
cogenTime - Static variable in class fj.test.Cogen
+
 
+
cogenTimestamp - Static variable in class fj.test.Cogen
+
 
+
cogenTreeMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for tree maps.
+
+
cogenTreeSet(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for tree sets.
+
+
cogenVector(Cogen<A>) - Static method in class fj.test.Cogen
+
+
A cogen for vectors.
+
+
cogenWeakHashMap(Cogen<K>, Cogen<V>) - Static method in class fj.test.Cogen
+
+
A cogen for weak hash maps.
+
+
combinationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
compose(F<B, A>) - Method in class fj.test.Cogen
+
+
Composes the given function with this cogen to produce a new cogen.
+
+
contramap(F<B, A>) - Method in class fj.test.Cogen
+
+
Contra-maps this cogen using the given function.
+
+
+ + + +

D

+
+
discarded() - Method in class fj.test.CheckResult
+
+
Returns the number of discarded checks of the property in this result.
+
+
+ + + +

E

+
+
elements(A...) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given arguments.
+
+
elemFrequency(List<P2<Integer, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from the given frequency and value pairs.
+
+
empty() - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy that cannot be reduced further.
+
+
exception() - Method in class fj.test.CheckResult
+
+
Returns the execption if the result is one of; exception during property execution or exception + during argument value generation, otherwise, no exception are returned.
+
+
exception(F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that has a result of exception, if the evaluation of the given property + throws an exception; otherwise, the given property is returned.
+
+
exception() - Method in class fj.test.Result
+
+
Returns the potential exception associated with this result.
+
+
exception(List<Arg<?>>, Throwable) - Static method in class fj.test.Result
+
+
Returns an exception result.
+
+
exhausted(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property been exhausted in checking.
+
+
+ + + +

F

+
+
fail() - Static method in class fj.test.Gen
+
+
Returns a generator that never returns a value.
+
+
failed() - Method in class fj.test.Result
+
+
Returns true if this result is falsified or an exception; otherwise, + false.
+
+
falsified(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been falsified.
+
+
falsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a falsified result.
+
+
filter(F<A, Boolean>) - Method in class fj.test.Gen
+
+
Returns a generator that produces values that meet the given predicate.
+
+
filter(Filter) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
fj.data.test - package fj.data.test
+
 
+
fj.test - package fj.test
+
+
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
+
fj.test.reflect - package fj.test.reflect
+
+
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
+
fj.test.runner - package fj.test.runner
+
 
+
forall(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
foreach(Integer, Rand, F<A, Unit>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
foreachDoEffect(Integer, Rand, Effect1<A>) - Method in class fj.test.Gen
+
+
Executes a side-effect for each generated result using the given arguments.
+
+
frequency(List<P2<Integer, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses values from the given frequency and generator pairs.
+
+
fromGen(Gen<Result>) - Static method in class fj.test.Property
+
+
Constructs a property from a generator of results.
+
+
+ + + +

G

+
+
Gen<A> - Class in fj.test
+
+
A generator for values of the type of the given type parameter (A).
+
+
gen(int, Rand) - Method in class fj.test.Gen
+
+
Applies the given size and random generator to produce a value.
+
+
gen(F<Integer, F<Rand, A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that uses the given function.
+
+
gen() - Method in class fj.test.Property
+
+
Returns a generator of results from this property.
+
+
genException(Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that generating values to check the property threw an exception.
+
+
getDescription() - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

I

+
+
implies(F0<Property>) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Property) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(Bool) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean) - Method in class fj.test.Bool
+
+
Returns a property that produces a result only if this value is true.
+
+
implies(boolean, F0<Property>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, boolean) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
impliesBoolean(boolean, F0<Boolean>) - Static method in class fj.test.Property
+
+
Returns a property that produces a result only if the given condition satisfies.
+
+
is() - Method in class fj.test.Bool
+
+
Returns true if this value is true, false otherwise.
+
+
isException() - Method in class fj.test.Result
+
+
Returns true if this result is an exception; otherwise, false.
+
+
isExhausted() - Method in class fj.test.CheckResult
+
+
Returns true if this result is exhausted, false otherwise.
+
+
isFalsified() - Method in class fj.test.CheckResult
+
+
Returns true if this result is falsified, false otherwise.
+
+
isFalsified() - Method in class fj.test.Result
+
+
Returns true if this result is falsified; otherwise, false.
+
+
isGenException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during generating of values for + property checking, false otherwise.
+
+
isNoResult() - Method in class fj.test.Result
+
+
Returns true if this result is no result; otherwise, false.
+
+
isNot() - Method in class fj.test.Bool
+
+
Returns false if this value is true, true otherwise.
+
+
isPassed() - Method in class fj.test.CheckResult
+
+
Returns true if this result is passed, false otherwise.
+
+
isPropException() - Method in class fj.test.CheckResult
+
+
Returns true if this result is an exception during property execution, + false otherwise.
+
+
isProven() - Method in class fj.test.CheckResult
+
+
Returns true if this result is proven, false otherwise.
+
+
isProven() - Method in class fj.test.Result
+
+
Returns true if this result is proven; otherwise, false.
+
+
isUnfalsified() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified; otherwise, false.
+
+
+ + + +

J

+
+
join(Gen<Gen<A>>) - Static method in class fj.test.Gen
+
+
Joins the generator of generators through a Gen.bind(F) operation.
+
+
+ + + +

L

+
+
listOf(Gen<A>, int) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists whose values come from the given generator.
+
+
listOf1(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of non empty lists whose values come from the given generator.
+
+
listOfSorted(Gen<A>, int, Ord<A>) - Static method in class fj.test.Gen
+
 
+
+ + + +

M

+
+
Main - Class in fj.test.reflect
+
+
Checks the properties of a class using a standard random generator, standard check parameters and + the given categories.
+
+
main(String...) - Static method in class fj.test.reflect.Main
+
+
Check the given class and categories.
+
+
map(F<A, B>) - Method in class fj.test.Gen
+
+
Maps the given function across this generator.
+
+
map(F<A, B>, F<B, A>) - Method in class fj.test.Shrink
+
+
Creates a shrink from this shrink and the given symmetric transformations.
+
+
maxDiscarded(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxDiscarded(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using a the given random generator}, 100 minimum + successful checks, the given maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
maxSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
maxSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, minimum size of 0, the given maximum size.
+
+
minSize(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSize(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, 100 minimum + successful checks, 500 maximum discarded tests, the given minimum size, maximum size of 100.
+
+
minSuccessful(int) - Method in class fj.test.Property
+
+
Checks this property using a standard random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
minSuccessful(Rand, int) - Method in class fj.test.Property
+
+
Checks this property using the given random generator, the given minimum + successful checks, 500 maximum discarded tests, minimum size of 0, maximum size of 100.
+
+
+ + + +

N

+
+
Name - Annotation Type in fj.test.reflect
+
+
The name of a property to be used in reporting.
+
+
NoCheck - Annotation Type in fj.test.reflect
+
+
Denotes that a property should be excluded from any checking.
+
+
noResult(Option<Result>) - Static method in class fj.test.Result
+
+
Returns a result from the given potential result.
+
+
noResult() - Static method in class fj.test.Result
+
+
Returns a result representing no result.
+
+
+ + + +

O

+
+
oneOf(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Returns a generator that produces values from one of the given generators on subsequent + requests.
+
+
or(Property) - Method in class fj.test.Property
+
+
Performs a disjunction of this property with the given property.
+
+
+ + + +

P

+
+
parameterised(F<Integer, F<Rand, Gen<A>>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its construction arguments — size and random + generator.
+
+
passed(int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has passed.
+
+
passed() - Method in class fj.test.Result
+
+
Returns true if this result is unfalsified or proven; otherwise, + false.
+
+
permutationOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
pickOne(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator that picks one element from the given list.
+
+
promote(F<A, Gen<B>>) - Static method in class fj.test.Gen
+
+
Promotes the given function to a generator for functions.
+
+
prop(int, Rand) - Method in class fj.test.Property
+
+
Returns the result of applying the given size and random generator.
+
+
prop(F<Integer, F<Rand, Result>>) - Static method in class fj.test.Property
+
+
Returns a property from the given function.
+
+
prop(Result) - Static method in class fj.test.Property
+
+
Returns a property that always has the given result.
+
+
prop(boolean) - Static method in class fj.test.Property
+
+
Returns a property that is either proven (the given condition satsifies) or falsified + otherwise.
+
+
properties(Class<T>, String...) - Static method in class fj.test.reflect.Check
+
+
Returns all properties, their name and possible check parameters in a given class that are + found reflectively and according to various annotations.
+
+
Property - Class in fj.test
+
+
Represents an algebraic property about a program that may be checked for its truth value.
+
+
property(Gen<A>, Shrink<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, F<A, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F<A, F<B, Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, F2<A, B, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F<A, F<B, F<C, Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Shrink<A>, Shrink<B>, Shrink<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, F3<A, B, C, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F<A, F<B, F<C, F<D, Property>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, F4<A, B, C, D, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F<A, F<B, F<C, F<D, F<E, Property>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, F5<A, B, C, D, E, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, Property>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, F6<A, B, C, D, E, F$, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, Property>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, F7<A, B, C, D, E, F$, G, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, Property>>>>>>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
property(Gen<A>, Gen<B>, Gen<C>, Gen<D>, Gen<E>, Gen<F$>, Gen<G>, Gen<H>, F8<A, B, C, D, E, F$, G, H, Property>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyAssert - Class in fj.data.test
+
 
+
propertyP(Gen<A>, Shrink<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, F<A, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F<A, F<B, P1<Property>>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, Shrink<A>, Shrink<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
propertyP(Gen<A>, Gen<B>, F2<A, B, P1<Property>>) - Static method in class fj.test.Property
+
+
Returns a property where its result is derived from universal quantification across the + application of its arguments.
+
+
PropertyTestRunner - Class in fj.test.runner
+
 
+
PropertyTestRunner(Class<?>) - Constructor for class fj.test.runner.PropertyTestRunner
+
 
+
propException(List<Arg<?>>, Throwable, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that checking the property threw an exception.
+
+
proven(List<Arg<?>>, int, int) - Static method in class fj.test.CheckResult
+
+
Returns a result that the property has been proven.
+
+
proven(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns a proven result.
+
+
provenAsUnfalsified() - Method in class fj.test.Result
+
+
If this result is proven, alter it to be unfalsified with the same arguments; otherwise, return + this.
+
+
+ + + +

R

+
+
Rand - Class in fj.test
+
+
A random number generator.
+
+
rand(F<Option<Long>, F<Integer, F<Integer, Integer>>>, F<Option<Long>, F<Double, F<Double, Double>>>, F<Long, Rand>) - Static method in class fj.test.Rand
+
+
Constructs a reseedable random generator from the given functions that supply a range to produce a + result.
+
+
reseed(long) - Method in class fj.test.Rand
+
+
Gives this random generator a new seed.
+
+
resize(int) - Method in class fj.test.Gen
+
+
Resizes this generator with the given size.
+
+
Result - Class in fj.test
+
+
The result of evaluating a property.
+
+
run(RunNotifier) - Method in class fj.test.runner.PropertyTestRunner
+
 
+
+ + + +

S

+
+
selectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
sequence(List<Gen<A>>) - Static method in class fj.test.Gen
+
+
Sequence the given generators through a Gen.bind(F) operation.
+
+
sequence(Validation<E, Gen<A>>) - Static method in class fj.test.Gen
+
+
Transform a validation for a generator into a generator of validations: if the given validation is a failure, the + generator produces that failure value; if the given validation is a success, the generator produces success values.
+
+
sequence(Property) - Method in class fj.test.Property
+
+
Performs a sequence of this property with the given property.
+
+
sequenceN(int, Gen<A>) - Static method in class fj.test.Gen
+
+
Sequences the given generator the given number of times through a Gen.bind(F) operation.
+
+
Shrink<A> - Class in fj.test
+
+
Represents a shrinking strategy over the given type parameter if that type can be represented as + a tree structure.
+
+
shrink(A) - Method in class fj.test.Shrink
+
+
Returns a shrink of the given argument.
+
+
shrink(F<A, Stream<A>>) - Static method in class fj.test.Shrink
+
+
Constructs a shrink strategy from the given function that produces a tree of values given a + value.
+
+
shrinkArray(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for arrays.
+
+
shrinkArrayBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for array blocking queues.
+
+
shrinkArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for array lists.
+
+
shrinkBigDecimal - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big decimals.
+
+
shrinkBigInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for big integers.
+
+
shrinkBitSet - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bit sets.
+
+
shrinkBoolean - Static variable in class fj.test.Shrink
+
+
A shrink strategy for booleans using false as the bottom of the shrink.
+
+
shrinkByte - Static variable in class fj.test.Shrink
+
+
A shrink strategy for bytes using 0 as the bottom of the shrink.
+
+
shrinkCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for calendars.
+
+
shrinkCharacter - Static variable in class fj.test.Shrink
+
+
A shrink strategy for characters using 0 as the bottom of the shrink.
+
+
shrinkConcurrentHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent hash maps.
+
+
shrinkConcurrentLinkedQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for concurrent linked queues.
+
+
shrinkCopyOnWriteArrayList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array lists.
+
+
shrinkCopyOnWriteArraySet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for copy on write array sets.
+
+
shrinkDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for dates.
+
+
shrinkDelayQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for delay queues.
+
+
shrinkDouble - Static variable in class fj.test.Shrink
+
+
A shrink strategy for doubles using 0 as the bottom of the shrink.
+
+
shrinkEither(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for either values.
+
+
shrinkEnumMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum maps.
+
+
shrinkEnumSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for enum sets.
+
+
shrinkFloat - Static variable in class fj.test.Shrink
+
+
A shrink strategy for floats using 0 as the bottom of the shrink.
+
+
shrinkGregorianCalendar - Static variable in class fj.test.Shrink
+
+
A shrink strategy for gregorian calendars.
+
+
shrinkHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash maps.
+
+
shrinkHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash sets.
+
+
shrinkHashtable(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for hash tables.
+
+
shrinkIdentityHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for identity hash maps.
+
+
shrinkInteger - Static variable in class fj.test.Shrink
+
+
A shrink strategy for integers using 0 as the bottom of the shrink.
+
+
shrinkLinkedBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked blocking queues.
+
+
shrinkLinkedHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash maps.
+
+
shrinkLinkedHashSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked hash sets.
+
+
shrinkLinkedList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for linked lists.
+
+
shrinkList(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for lists.
+
+
shrinkLong - Static variable in class fj.test.Shrink
+
+
A shrink strategy for longs using 0 as the bottom of the shrink.
+
+
shrinkNatural - Static variable in class fj.test.Shrink
+
+
A shrink strategy for naturals.
+
+
shrinkOption(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for optional values.
+
+
shrinkP1(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-1 values.
+
+
shrinkP2(Shrink<A>, Shrink<B>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-2 values.
+
+
shrinkP3(Shrink<A>, Shrink<B>, Shrink<C>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-3 values.
+
+
shrinkP4(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-4 values.
+
+
shrinkP5(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-5 values.
+
+
shrinkP6(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-6 values.
+
+
shrinkP7(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-7 values.
+
+
shrinkP8(Shrink<A>, Shrink<B>, Shrink<C>, Shrink<D>, Shrink<E>, Shrink<F$>, Shrink<G>, Shrink<H>) - Static method in class fj.test.Shrink
+
+
Returns a shrinking strategy for product-8 values.
+
+
shrinkPriorityBlockingQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority blocking queues.
+
+
shrinkPriorityQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for priority queues.
+
+
shrinkProperties - Static variable in class fj.test.Shrink
+
+
A shrink strategy for properties.
+
+
shrinks() - Method in class fj.test.Arg
+
+
Returns the argument's number of shrinks following falsification.
+
+
shrinkShort - Static variable in class fj.test.Shrink
+
+
A shrink strategy for shorts using 0 as the bottom of the shrink.
+
+
shrinkSQLDate - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL dates.
+
+
shrinkStack(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for stacks.
+
+
shrinkStream(Shrink<A>) - Static method in class fj.test.Shrink
+
+
Returns a shrink strategy for streams.
+
+
shrinkString - Static variable in class fj.test.Shrink
+
+
A shrink strategy for strings using the empty string as the bottom of the shrink.
+
+
shrinkStringBuffer - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string buffers using the empty string as the bottom of the shrink.
+
+
shrinkStringBuilder - Static variable in class fj.test.Shrink
+
+
A shrink strategy for string builders using the empty string as the bottom of the shrink.
+
+
shrinkSynchronousQueue(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for synchronous queues.
+
+
shrinkThrowable - Static variable in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkThrowable(Shrink<String>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for throwables.
+
+
shrinkTime - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL times.
+
+
shrinkTimestamp - Static variable in class fj.test.Shrink
+
+
A shrink strategy for SQL timestamps.
+
+
shrinkTreeMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree maps.
+
+
shrinkTreeSet(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for tree sets.
+
+
shrinkVector(Shrink<A>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for vectors.
+
+
shrinkWeakHashMap(Shrink<K>, Shrink<V>) - Static method in class fj.test.Shrink
+
+
A shrink strategy for weak hash maps.
+
+
sized(F<Integer, Gen<A>>) - Static method in class fj.test.Gen
+
+
Constructs a generator that can access its size construction arguments.
+
+
someCombinationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
somePermutationOf(List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someSelectionOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
someWordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that produces some of the values of the given list.
+
+
standard - Static variable in class fj.test.Rand
+
+
A standard random generator that uses Random.
+
+
streamOf(Gen<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of streams whose values come from the given generator.
+
+
succeeded() - Method in class fj.test.CheckResult
+
+
Returns the number of succeeded checks of the property in this result.
+
+
summary - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summary(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line.
+
+
summaryEx - Static variable in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
summaryEx(Show<Arg<?>>) - Static method in class fj.test.CheckResult
+
+
A rendering of a check result that summarises in one line but throws an exception in the result + is a failure (falsified, property exception or generator exception).
+
+
+ + + +

T

+
+
toOption() - Method in class fj.test.Result
+
+
Returns a potential result for this result.
+
+
+ + + +

U

+
+
unfalsified(List<Arg<?>>) - Static method in class fj.test.Result
+
+
Returns an unfalsified result.
+
+
+ + + +

V

+
+
value() - Method in class fj.test.Arg
+
+
Returns the argument's value.
+
+
value(A) - Static method in class fj.test.Gen
+
+
Returns a generator that always produces the given value.
+
+
Variant - Class in fj.test
+
+
A memoised generator variant.
+
+
variant(long, Gen<A>) - Static method in class fj.test.Variant
+
+
Produces a generator that is independent of the given generator using the given value.
+
+
variant(long) - Static method in class fj.test.Variant
+
+
A curried version of Variant.variant(long, Gen).
+
+
+ + + +

W

+
+
wordOf(int, List<A>) - Static method in class fj.test.Gen
+
+
Returns a generator of lists that picks the given number of elements from the given list.
+
+
+A B C D E F G I J L M N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/index.html b/javadoc/5.0/functionaljava-quickcheck/index.html new file mode 100644 index 0000000..74ac0d3 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/index.html @@ -0,0 +1,75 @@ + + + + + +quickcheck 5.0 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/5.0/functionaljava-quickcheck/overview-frame.html b/javadoc/5.0/functionaljava-quickcheck/overview-frame.html new file mode 100644 index 0000000..e55a366 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/overview-frame.html @@ -0,0 +1,23 @@ + + + + + +Overview List (quickcheck 5.0 API) + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/5.0/functionaljava-quickcheck/overview-summary.html b/javadoc/5.0/functionaljava-quickcheck/overview-summary.html new file mode 100644 index 0000000..ef08221 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/overview-summary.html @@ -0,0 +1,153 @@ + + + + + +Overview (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

quickcheck 5.0 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj.data.test 
fj.test +
Reductio is a software package that provides automated specification-based testing and + is intended to replace traditional testing techniques that have very little automation.
+
fj.test.reflect +
A wrapper around the fj.test package that uses annotations for configuring properties to + check.
+
fj.test.runner 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/overview-tree.html b/javadoc/5.0/functionaljava-quickcheck/overview-tree.html new file mode 100644 index 0000000..4b501a9 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/overview-tree.html @@ -0,0 +1,162 @@ + + + + + +Class Hierarchy (quickcheck 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+
    +
  • fj.test.reflect.Category (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.CheckParams (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.Name (implements java.lang.annotation.Annotation)
    • +
  • fj.test.reflect.NoCheck (implements java.lang.annotation.Annotation)
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava-quickcheck/package-list b/javadoc/5.0/functionaljava-quickcheck/package-list new file mode 100644 index 0000000..34273ed --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/package-list @@ -0,0 +1,4 @@ +fj.data.test +fj.test +fj.test.reflect +fj.test.runner diff --git a/javadoc/5.0/functionaljava-quickcheck/script.js b/javadoc/5.0/functionaljava-quickcheck/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/5.0/functionaljava-quickcheck/stylesheet.css b/javadoc/5.0/functionaljava-quickcheck/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/5.0/functionaljava-quickcheck/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/javadoc/5.0/functionaljava/allclasses-frame.html b/javadoc/5.0/functionaljava/allclasses-frame.html new file mode 100644 index 0000000..e1fd6d7 --- /dev/null +++ b/javadoc/5.0/functionaljava/allclasses-frame.html @@ -0,0 +1,218 @@ + + + + + +All Classes (core 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava/allclasses-noframe.html b/javadoc/5.0/functionaljava/allclasses-noframe.html new file mode 100644 index 0000000..e407725 --- /dev/null +++ b/javadoc/5.0/functionaljava/allclasses-noframe.html @@ -0,0 +1,218 @@ + + + + + +All Classes (core 5.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/javadoc/5.0/functionaljava/constant-values.html b/javadoc/5.0/functionaljava/constant-values.html new file mode 100644 index 0000000..3192457 --- /dev/null +++ b/javadoc/5.0/functionaljava/constant-values.html @@ -0,0 +1,204 @@ + + + + + +Constant Field Values (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

fj.data.*

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/deprecated-list.html b/javadoc/5.0/functionaljava/deprecated-list.html new file mode 100644 index 0000000..cc3876e --- /dev/null +++ b/javadoc/5.0/functionaljava/deprecated-list.html @@ -0,0 +1,121 @@ + + + + + +Deprecated List (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Bottom.html b/javadoc/5.0/functionaljava/fj/Bottom.html new file mode 100644 index 0000000..431f931 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Bottom.html @@ -0,0 +1,400 @@ + + + + + +Bottom (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Bottom

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Bottom
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bottom
+extends java.lang.Object
    +
    Represents the bottom _|_ value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> java.lang.Errordecons(A a, + Show<A> sa) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <A> java.lang.Errordecons(java.lang.Class<A> c) +
      Represents a deconstruction failure that was non-exhaustive.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eMessage() +
      A function that returns the getMessage for a throwable.
      +
      static <A> P1<A>error_(java.lang.String s) +
      Provides a thunk that throws an error using the given message when evaluated.
      +
      static java.lang.Errorerror(java.lang.String s) +
      Returns an error to represent undefinedness in a computation with early failure using the given + message.
      +
      static <A,B> F<A,B>errorF(java.lang.String s) +
      Provides a function that throws an error using the given message, ignoring its argument.
      +
      static <T extends java.lang.Throwable>
      F<T,java.lang.String>      		eToString() +
      A function that returns the toString for a throwable.
      +
      static java.lang.Errorundefined() +
      Returns an error to represent undefinedness in a computation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        undefined

        +
        public static java.lang.Error undefined()
        +
        Returns an error to represent undefinedness in a computation.
        +
        +
        Returns:
        +
        An error to represent undefinedness in a computation.
        +
        +
        • +
      + + + +
        +
      • +

        error

        +
        public static java.lang.Error error(java.lang.String s)
        +
        Returns an error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        An error to represent undefinedness in a computation with early failure using the given + message.
        +
        +
        • +
      + + + +
        +
      • +

        error_

        +
        public static <A> P1<A> error_(java.lang.String s)
        +
        Provides a thunk that throws an error using the given message when evaluated.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A thunk that throws an error using the given message when evaluated.
        +
        +
        • +
      + + + +
        +
      • +

        errorF

        +
        public static <A,B> F<A,B> errorF(java.lang.String s)
        +
        Provides a function that throws an error using the given message, ignoring its argument.
        +
        +
        Parameters:
        +
        s - The message to fail with.
        +
        Returns:
        +
        A function that throws an error using the given message, ignoring its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(A a,
+                                         Show<A> sa)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        a - The value being deconstructed.
        +
        sa - The rendering for the value being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        decons

        +
        public static <A> java.lang.Error decons(java.lang.Class<A> c)
        +
        Represents a deconstruction failure that was non-exhaustive.
        +
        +
        Parameters:
        +
        c - The type being deconstructed.
        +
        Returns:
        +
        A deconstruction failure that was non-exhaustive.
        +
        +
        • +
      + + + +
        +
      • +

        eToString

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eToString()
        +
        A function that returns the toString for a throwable.
        +
        +
        Returns:
        +
        A function that returns the toString for a throwable.
        +
        +
        • +
      + + + +
        +
      • +

        eMessage

        +
        public static <T extends java.lang.Throwable> F<T,java.lang.String> eMessage()
        +
        A function that returns the getMessage for a throwable.
        +
        +
        Returns:
        +
        A function that returns the getMessage for a throwable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Bounded.Definition.html b/javadoc/5.0/functionaljava/fj/Bounded.Definition.html new file mode 100644 index 0000000..d097c04 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Bounded.Definition.html @@ -0,0 +1,236 @@ + + + + + +Bounded.Definition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Bounded.Definition<A>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    Bounded<A>
    +
    +
    +
    +
    public static interface Bounded.Definition<A>
    +
    Minimal definition of Bounded
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        min

        +
        A min()
        +
        • +
      + + + +
        +
      • +

        max

        +
        A max()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Bounded.html b/javadoc/5.0/functionaljava/fj/Bounded.html new file mode 100644 index 0000000..345af2a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Bounded.html @@ -0,0 +1,300 @@ + + + + + +Bounded (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Bounded<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Bounded<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Bounded<A>
+extends java.lang.Object
    +
    The Bounded class is used to name the upper and lower limits of a type. + Ord is not a superclass of Bounded since types that are not totally ordered may also have upper and lower bounds.
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Class.html b/javadoc/5.0/functionaljava/fj/Class.html new file mode 100644 index 0000000..0a833c6 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Class.html @@ -0,0 +1,372 @@ + + + + + +Class (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Class<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Class<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Class<T>
+extends java.lang.Object
    +
    A wrapper for a Class that provides additional methods.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<T>clas() +
      Returns the underlying class.
      +
      static <T> Class<T>clas(java.lang.Class<T> c) +
      Constructs a class from the given argument.
      +
      Tree<java.lang.reflect.Type>classParameters() +
      Provides this class's type parameter information as a Tree of the type expression.
      +
      List<Class<? super T>>inheritance() +
      Returns the inheritance hierarchy of this class.
      +
      List<Tree<java.lang.reflect.Type>>interfaceParameters() +
      Provides this class's interface type parameter information as a list of trees.
      +
      Tree<java.lang.reflect.Type>superclassParameters() +
      Provides this class's superclass type parameter information as a Tree of the type expression.
      +
      static Tree<java.lang.reflect.Type>typeParameterTree(java.lang.reflect.Type t) +
      Provides type parameter information as a Tree of the type expression.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        inheritance

        +
        public List<Class<? super T>> inheritance()
        +
        Returns the inheritance hierarchy of this class.
        +
        +
        Returns:
        +
        The inheritance hierarchy of this class.
        +
        +
        • +
      + + + +
        +
      • +

        classParameters

        +
        public Tree<java.lang.reflect.Type> classParameters()
        +
        Provides this class's type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The rose tree representing the type expression for this class.
        +
        +
        • +
      + + + +
        +
      • +

        superclassParameters

        +
        public Tree<java.lang.reflect.Type> superclassParameters()
        +
        Provides this class's superclass type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Returns:
        +
        The Tree representing the type expression for this class's superclass.
        +
        +
        • +
      + + + +
        +
      • +

        interfaceParameters

        +
        public List<Tree<java.lang.reflect.Type>> interfaceParameters()
        +
        Provides this class's interface type parameter information as a list of trees.
        +
        +
        Returns:
        +
        A list of trees representing the type expressions for this class's interfaces.
        +
        +
        • +
      + + + +
        +
      • +

        typeParameterTree

        +
        public static Tree<java.lang.reflect.Type> typeParameterTree(java.lang.reflect.Type t)
        +
        Provides type parameter information as a Tree of the type expression. + Only descends into Parameterized classes. Non-abstract classes, or classes that don't implement an interface, + are treated as raw types. Arrays, Type Variables, and Wildcards are treated as opaque Types.
        +
        +
        Parameters:
        +
        t - The type (class) for which to get the generic type information.
        +
        Returns:
        +
        Type parameter information as a rose tree of the type expression.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public java.lang.Class<T> clas()
        +
        Returns the underlying class.
        +
        +
        Returns:
        +
        The underlying class.
        +
        +
        • +
      + + + +
        +
      • +

        clas

        +
        public static <T> Class<T> clas(java.lang.Class<T> c)
        +
        Constructs a class from the given argument.
        +
        +
        Parameters:
        +
        c - The argument to construct this class with.
        +
        Returns:
        +
        A class from the given argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Digit.html b/javadoc/5.0/functionaljava/fj/Digit.html new file mode 100644 index 0000000..2e147b9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Digit.html @@ -0,0 +1,636 @@ + + + + + +Digit (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Digit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Digit>
      • +
    • +
        +
      • fj.Digit
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Digit>
    +
    +
    +
    +
    public enum Digit
+extends java.lang.Enum<Digit>
    +
    The digits zero to nine.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      _0 +
      Zero.
      +
      _1 +
      One.
      +
      _2 +
      Two.
      +
      _3 +
      Three.
      +
      _4 +
      Four.
      +
      _5 +
      Five.
      +
      _6 +
      Six.
      +
      _7 +
      Seven.
      +
      _8 +
      Eight.
      +
      _9 +
      Nine.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,Option<Digit>>fromChar +
      First-class conversion from a character to a digit.
      +
      static F<java.lang.Long,Digit>fromLong +
      First-class conversion from a long to a digit.
      +
      static F<Digit,java.lang.Character>toChar +
      First-class conversion from a digit to a character.
      +
      static F<Digit,java.lang.Long>toLong +
      First-class conversion from digit to a long.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static Option<Digit>fromChar(char c) +
      Converts the given character in the given long value to a digit.
      +
      static DigitfromLong(long i) +
      Converts the right-most digit in the given long value to a digit.
      +
      chartoChar() +
      Converts this digit to a character.
      +
      longtoLong() +
      Converts this digit to a long.
      +
      static DigitvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Digit[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        _0

        +
        public static final Digit _0
        +
        Zero.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static final Digit _1
        +
        One.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static final Digit _2
        +
        Two.
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public static final Digit _3
        +
        Three.
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public static final Digit _4
        +
        Four.
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public static final Digit _5
        +
        Five.
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public static final Digit _6
        +
        Six.
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public static final Digit _7
        +
        Seven.
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public static final Digit _8
        +
        Eight.
        +
        • +
      + + + +
        +
      • +

        _9

        +
        public static final Digit _9
        +
        Nine.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        toLong

        +
        public static final F<Digit,java.lang.Long> toLong
        +
        First-class conversion from digit to a long.
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static final F<java.lang.Long,Digit> fromLong
        +
        First-class conversion from a long to a digit.
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public static final F<Digit,java.lang.Character> toChar
        +
        First-class conversion from a digit to a character.
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static final F<java.lang.Character,Option<Digit>> fromChar
        +
        First-class conversion from a character to a digit.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Digit[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Digit c : Digit.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Digit valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toLong

        +
        public long toLong()
        +
        Converts this digit to a long.
        +
        +
        Returns:
        +
        A long for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        toChar

        +
        public char toChar()
        +
        Converts this digit to a character.
        +
        +
        Returns:
        +
        A character for this digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromLong

        +
        public static Digit fromLong(long i)
        +
        Converts the right-most digit in the given long value to a digit.
        +
        +
        Parameters:
        +
        i - The long to convert.
        +
        Returns:
        +
        The right-most digit in the given long value as a digit.
        +
        +
        • +
      + + + +
        +
      • +

        fromChar

        +
        public static Option<Digit> fromChar(char c)
        +
        Converts the given character in the given long value to a digit.
        +
        +
        Parameters:
        +
        c - The character to convert.
        +
        Returns:
        +
        The character in the given long value as a digit.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Effect.html b/javadoc/5.0/functionaljava/fj/Effect.html new file mode 100644 index 0000000..4c63a8e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Effect.html @@ -0,0 +1,383 @@ + + + + + +Effect (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Effect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Effect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Effect
+extends java.lang.Object
    +
    Represents a side-effect.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Effect1<B>contramap(Effect1<A> e1, + F<B,A> f) +
      A contra-variant functor on effect.
      +
      static P1<Unit>f(Effect0 e) 
      static <A> F<A,Unit>f(Effect1<A> e1) +
      Returns a function for the given effect.
      +
      static <A,B> F2<A,B,Unit>f(Effect2<A,B> e) 
      static <A,B,C> F3<A,B,C,Unit>f(Effect3<A,B,C> e) 
      static <A,B,C,D> F4<A,B,C,D,Unit>f(Effect4<A,B,C,D> e) 
      static <A,B,C,D,E>
      F5<A,B,C,D,E,Unit>      		f(Effect5<A,B,C,D,E> z) 
      static <A,B,C,D,E,$F>
      F6<A,B,C,D,E,$F,Unit>      		f(Effect6<A,B,C,D,E,$F> z) 
      static <A,B,C,D,E,$F,G>
      F7<A,B,C,D,E,$F,G,Unit>      		f(Effect7<A,B,C,D,E,$F,G> z) 
      static <A,B,C,D,E,$F,G,H>
      F8<A,B,C,D,E,$F,G,H,Unit>      		f(Effect8<A,B,C,D,E,$F,G,H> z) 
      static <A> Effect1<A>lazy(F<A,Unit> f) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        f

        +
        public static <A> F<A,Unit> f(Effect1<A> e1)
        +
        Returns a function for the given effect.
        +
        +
        Returns:
        +
        The function using the given effect.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B> F2<A,B,Unit> f(Effect2<A,B> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C> F3<A,B,C,Unit> f(Effect3<A,B,C> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D> F4<A,B,C,D,Unit> f(Effect4<A,B,C,D> e)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E> F5<A,B,C,D,E,Unit> f(Effect5<A,B,C,D,E> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F> F6<A,B,C,D,E,$F,Unit> f(Effect6<A,B,C,D,E,$F> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G> F7<A,B,C,D,E,$F,G,Unit> f(Effect7<A,B,C,D,E,$F,G> z)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,$F,G,H> F8<A,B,C,D,E,$F,G,H,Unit> f(Effect8<A,B,C,D,E,$F,G,H> z)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Effect1<B> contramap(Effect1<A> e1,
+                                         F<B,A> f)
        +
        A contra-variant functor on effect.
        +
        +
        Parameters:
        +
        f - The function to map over the effect.
        +
        Returns:
        +
        An effect after a contra-variant map.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> Effect1<A> lazy(F<A,Unit> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Equal.AltDefinition.html b/javadoc/5.0/functionaljava/fj/Equal.AltDefinition.html new file mode 100644 index 0000000..c4a13c5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Equal.AltDefinition.html @@ -0,0 +1,262 @@ + + + + + +Equal.AltDefinition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Equal.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Equal<A>
    +
    +
    +
    +
    public static interface Equal.AltDefinition<A>
+extends Equal.Definition<A>
    +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Equal.Definition.html b/javadoc/5.0/functionaljava/fj/Equal.Definition.html new file mode 100644 index 0000000..71dfd90 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Equal.Definition.html @@ -0,0 +1,290 @@ + + + + + +Equal.Definition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Equal.Definition<A>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        equal

        +
        F<A,java.lang.Boolean> equal(A a)
        +
        • +
      + + + + + +
        +
      • +

        equal

        +
        default boolean equal(A a1,
+                      A a2)
        +
        • +
      + + + +
        +
      • +

        then

        +
        default <B> Equal.Definition<A> then(F<A,B> f,
+                                     Equal<B> eq)
        +
        Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
        +
        +
        Parameters:
        +
        f - The function to map the original object
        +
        eq - Equality for the mapped object
        +
        Returns:
        +
        A new equal definition
        +
        See Also:
        +
        equal()
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        default Equal<A> equal()
        +
        Build an equal instance from this definition. + to be called after some successive then(F, Equal) calls.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Equal.html b/javadoc/5.0/functionaljava/fj/Equal.html new file mode 100644 index 0000000..80007e4 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Equal.html @@ -0,0 +1,1667 @@ + + + + + +Equal (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Equal<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Equal<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Equal<A>
+extends java.lang.Object
    +
    Tests for equality between two objects.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEqual

        +
        public static final Equal<java.lang.Boolean> booleanEqual
        +
        An equal instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteEqual

        +
        public static final Equal<java.lang.Byte> byteEqual
        +
        An equal instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charEqual

        +
        public static final Equal<java.lang.Character> charEqual
        +
        An equal instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleEqual

        +
        public static final Equal<java.lang.Double> doubleEqual
        +
        An equal instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatEqual

        +
        public static final Equal<java.lang.Float> floatEqual
        +
        An equal instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intEqual

        +
        public static final Equal<java.lang.Integer> intEqual
        +
        An equal instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintEqual

        +
        public static final Equal<java.math.BigInteger> bigintEqual
        +
        An equal instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEqual

        +
        public static final Equal<java.math.BigDecimal> bigdecimalEqual
        +
        An equal instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longEqual

        +
        public static final Equal<java.lang.Long> longEqual
        +
        An equal instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortEqual

        +
        public static final Equal<java.lang.Short> shortEqual
        +
        An equal instance for the short type.
        +
        • +
      + + + +
        +
      • +

        naturalEqual

        +
        public static final Equal<Natural> naturalEqual
        +
        An equal instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringEqual

        +
        public static final Equal<java.lang.String> stringEqual
        +
        An equal instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferEqual

        +
        public static final Equal<java.lang.StringBuffer> stringBufferEqual
        +
        An equal instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderEqual

        +
        public static final Equal<java.lang.StringBuilder> stringBuilderEqual
        +
        An equal instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        bitSetSequal

        +
        public static final Equal<BitSet> bitSetSequal
        +
        An equal instance for the BitSet type.
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static final Equal<LazyString> eq
        +
        An equal instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static final Equal<HList.HNil> hListEqual
        +
        An equal instance for the empty heterogeneous list.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the two given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for equality against another.
        +
        a2 - An object to test for equality against another.
        +
        Returns:
        +
        true if the two given arguments are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        notEq

        +
        public boolean notEq(A a1,
+                     A a2)
        +
        Returns true if the two given arguments are not equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An object to test for inequality against another.
        +
        a2 - An object to test for inequality against another.
        +
        Returns:
        +
        true if the two given arguments are not equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public F2<A,A,java.lang.Boolean> eq()
        +
        First-class equality check.
        +
        +
        Returns:
        +
        A function that returns true if the two given arguments are equal.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public F<A,java.lang.Boolean> eq(A a)
        +
        Partially applied equality check.
        +
        +
        Parameters:
        +
        a - An object to test for equality against another.
        +
        Returns:
        +
        A function that returns true if the given argument equals the argument to this method.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Equal<B> contramap(F<B,A> f)
        +
        Maps the given function across this equal as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new equal.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public final Equal<A> not()
        +
        An equal instance, which reverts equality for self
        +
        +
        Returns:
        +
        A new equal instance
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> Equal<A> contramap(F<A,B> f,
+                                       Equal<B> eq)
        +
        Static version of contramap(F)
        +
        • +
      + + + + + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F<A,F<A,java.lang.Boolean>> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public static <A> Equal<A> equal(F2<A,A,java.lang.Boolean> f)
        +
        Constructs an equal instance from the given function. + + Java 8+ users: use equalDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The function to construct the equal with.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.Definition<A> definition)
        +
        Constructs an equal instance from the given definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        equalDef

        +
        public static <A> Equal<A> equalDef(Equal.AltDefinition<A> definition)
        +
        Constructs an equal instance from the given (alternative) definition.
        +
        +
        Parameters:
        +
        definition - a definition of the equal instance.
        +
        Returns:
        +
        An equal instance from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyEqual

        +
        public static <A> Equal<A> anyEqual()
        +
        Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        Returns:
        +
        An equal instance that uses the Object.equals(Object) method to test for + equality.
        +
        +
        • +
      + + + +
        +
      • +

        eitherEqual

        +
        public static <A,B> Equal<Either<A,B>> eitherEqual(Equal<A> ea,
+                                                   Equal<B> eb)
        +
        An equal instance for the Either type.
        +
        +
        Parameters:
        +
        ea - Equality across the left side of Either.
        +
        eb - Equality across the right side of Either.
        +
        Returns:
        +
        An equal instance for the Either type.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        validationEqual

        +
        public static <A,B> Equal<Validation<A,B>> validationEqual(Equal<A> ea,
+                                                           Equal<B> eb)
        +
        An equal instance for the Validation type.
        +
        +
        Parameters:
        +
        ea - Equality across the failing side of Validation.
        +
        eb - Equality across the succeeding side of Validation.
        +
        Returns:
        +
        An equal instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listEqual

        +
        public static <A> Equal<List<A>> listEqual(Equal<A> ea)
        +
        An equal instance for the List type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the list.
        +
        Returns:
        +
        An equal instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListEqual

        +
        public static <A> Equal<NonEmptyList<A>> nonEmptyListEqual(Equal<A> ea)
        +
        An equal instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the non-empty list.
        +
        Returns:
        +
        An equal instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionEqual

        +
        public static <A> Equal<Option<A>> optionEqual(Equal<A> ea)
        +
        An equal instance for the Option type.
        +
        +
        Parameters:
        +
        ea - Equality across the element of the option.
        +
        Returns:
        +
        An equal instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqEqual

        +
        public static <A> Equal<Seq<A>> seqEqual(Equal<A> e)
        +
        • +
      + + + +
        +
      • +

        streamEqual

        +
        public static <A> Equal<Stream<A>> streamEqual(Equal<A> ea)
        +
        An equal instance for the Stream type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the stream.
        +
        Returns:
        +
        An equal instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperEqual

        +
        public static <A> Equal<Zipper<A>> zipperEqual(Equal<A> ea)
        +
        An equal instance for the Zipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the zipper.
        +
        Returns:
        +
        An equal instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperEqual

        +
        public static <A> Equal<TreeZipper<A>> treeZipperEqual(Equal<A> ea)
        +
        An equal instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree zipper.
        +
        Returns:
        +
        An equal instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayEqual

        +
        public static <A> Equal<Array<A>> arrayEqual(Equal<A> ea)
        +
        An equal instance for the Array type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the array.
        +
        Returns:
        +
        An equal instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        treeEqual

        +
        public static <A> Equal<Tree<A>> treeEqual(Equal<A> ea)
        +
        An equal instance for the Tree type.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the tree.
        +
        Returns:
        +
        An equal instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Equal

        +
        public static <A> Equal<P1<A>> p1Equal(Equal<A> ea)
        +
        An equal instance for a product-1.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        Returns:
        +
        An equal instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Equal

        +
        public static <A,B> Equal<P2<A,B>> p2Equal(Equal<A> ea,
+                                           Equal<B> eb)
        +
        An equal instance for a product-2.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        Returns:
        +
        An equal instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Equal

        +
        public static <A,B,C> Equal<P3<A,B,C>> p3Equal(Equal<A> ea,
+                                               Equal<B> eb,
+                                               Equal<C> ec)
        +
        An equal instance for a product-3.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        Returns:
        +
        An equal instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Equal

        +
        public static <A,B,C,D> Equal<P4<A,B,C,D>> p4Equal(Equal<A> ea,
+                                                   Equal<B> eb,
+                                                   Equal<C> ec,
+                                                   Equal<D> ed)
        +
        An equal instance for a product-4.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        Returns:
        +
        An equal instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Equal

        +
        public static <A,B,C,D,E> Equal<P5<A,B,C,D,E>> p5Equal(Equal<A> ea,
+                                                       Equal<B> eb,
+                                                       Equal<C> ec,
+                                                       Equal<D> ed,
+                                                       Equal<E> ee)
        +
        An equal instance for a product-5.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        Returns:
        +
        An equal instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Equal

        +
        public static <A,B,C,D,E,F$> Equal<P6<A,B,C,D,E,F$>> p6Equal(Equal<A> ea,
+                                                             Equal<B> eb,
+                                                             Equal<C> ec,
+                                                             Equal<D> ed,
+                                                             Equal<E> ee,
+                                                             Equal<F$> ef)
        +
        An equal instance for a product-6.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        Returns:
        +
        An equal instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Equal

        +
        public static <A,B,C,D,E,F$,G> Equal<P7<A,B,C,D,E,F$,G>> p7Equal(Equal<A> ea,
+                                                                 Equal<B> eb,
+                                                                 Equal<C> ec,
+                                                                 Equal<D> ed,
+                                                                 Equal<E> ee,
+                                                                 Equal<F$> ef,
+                                                                 Equal<G> eg)
        +
        An equal instance for a product-7.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        Returns:
        +
        An equal instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Equal

        +
        public static <A,B,C,D,E,F$,G,H> Equal<P8<A,B,C,D,E,F$,G,H>> p8Equal(Equal<A> ea,
+                                                                     Equal<B> eb,
+                                                                     Equal<C> ec,
+                                                                     Equal<D> ed,
+                                                                     Equal<E> ee,
+                                                                     Equal<F$> ef,
+                                                                     Equal<G> eg,
+                                                                     Equal<H> eh)
        +
        An equal instance for a product-8.
        +
        +
        Parameters:
        +
        ea - Equality across the first element of the product.
        +
        eb - Equality across the second element of the product.
        +
        ec - Equality across the third element of the product.
        +
        ed - Equality across the fourth element of the product.
        +
        ee - Equality across the fifth element of the product.
        +
        ef - Equality across the sixth element of the product.
        +
        eg - Equality across the seventh element of the product.
        +
        eh - Equality across the eighth element of the product.
        +
        Returns:
        +
        An equal instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Equal

        +
        public static <A> Equal<V2<A>> v2Equal(Equal<A> ea)
        +
        An equal instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Equal

        +
        public static <A> Equal<V3<A>> v3Equal(Equal<A> ea)
        +
        An equal instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Equal

        +
        public static <A> Equal<V4<A>> v4Equal(Equal<A> ea)
        +
        An equal instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Equal

        +
        public static <A> Equal<V5<A>> v5Equal(Equal<A> ea)
        +
        An equal instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Equal

        +
        public static <A> Equal<V6<A>> v6Equal(Equal<A> ea)
        +
        An equal instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Equal

        +
        public static <A> Equal<V7<A>> v7Equal(Equal<A> ea)
        +
        An equal instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Equal

        +
        public static <A> Equal<V8<A>> v8Equal(Equal<A> ea)
        +
        An equal instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - Equality across the elements of the vector.
        +
        Returns:
        +
        An equal instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        hListEqual

        +
        public static <E,L extends HList<L>> Equal<HList.HCons<E,L>> hListEqual(Equal<E> e,
+                                                                        Equal<L> l)
        +
        An equal instance for heterogeneous lists.
        +
        +
        Parameters:
        +
        e - Equality for the first element of the list.
        +
        l - Equality for the rest of the list.
        +
        Returns:
        +
        an equal instance for a heterogeneous list.
        +
        +
        • +
      + + + +
        +
      • +

        setEqual

        +
        public static <A> Equal<Set<A>> setEqual(Equal<A> e)
        +
        Equal instance for sets.
        +
        +
        Parameters:
        +
        e - Equality for the set elements.
        +
        Returns:
        +
        An equal instance for sets.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writerEqual

        +
        public static <A,B> Equal<Writer<A,B>> writerEqual(Equal<A> eq1,
+                                                   Equal<B> eq2)
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  Equal<A> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - an equal instance for the type of self (that use anyEqual() if generic type).
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      + + + + + +
        +
      • +

        equals0

        +
        public static <A> boolean equals0(java.lang.Class<? super A> clazz,
+                                  A self,
+                                  java.lang.Object other,
+                                  F0<Equal<A>> equal)
        +
        Helper method to implement Object.equals(Object) correctly. DO NOT USE it for any other purpose.
        +
        +
        Parameters:
        +
        clazz - the class in which the Object.equals(Object) is implemented
        +
        self - a reference to 'this'
        +
        other - the other object of the comparison
        +
        equal - a lazy equal instance for the type (that use anyEqual() if generic type)..
        +
        Returns:
        +
        true if self and other are equal
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F.html b/javadoc/5.0/functionaljava/fj/F.html new file mode 100644 index 0000000..4aed82d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F.html @@ -0,0 +1,1686 @@ + + + + + +F (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F<A,B>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.Function<A,B>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F<A,B>
+extends java.util.function.Function<A,B>
    +
    A transformation or function from A to B.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethod and Description
      default <C> F<F<B,C>,F<A,C>>andThen() +
      First-class composition flipped.
      +
      default <C> F<A,C>andThen(F<B,C> g) +
      Function composition flipped.
      +
      default <C> F<F<A,F<B,C>>,F<A,C>>apply() +
      First-class function application in an environment.
      +
      default Bapply(A a) 
      default <C> F<A,C>apply(F<A,F<B,C>> g) +
      Function application in an environment (Applicative Functor).
      +
      default F<A,Array<B>>arrayK() +
      Promotes this function so that it returns its result in a Array.
      +
      default <C> F<F<B,F<A,C>>,F<A,C>>bind() +
      First-class function binding.
      +
      default <C> F<A,C>bind(F<B,F<A,C>> g) +
      Binds a given function across this function (Reader Monad).
      +
      default <C> F<C,B>contramap(F<C,A> f) 
      default F<Actor<B>,Actor<A>>contramapActor() +
      Returns a function that contramaps over a given actor.
      +
      default F<Equal<B>,Equal<A>>contramapEqual() +
      Promotes this function to map over an Equal as a contravariant functor.
      +
      default F<Hash<B>,Hash<A>>contramapHash() +
      Promotes this function to map over a Hash as a contravariant functor.
      +
      default F<Show<B>,Show<A>>contramapShow() +
      Promotes this function to map over a Show as a contravariant functor.
      +
      default <C,D> F<C,D>dimap(F<C,A> f, + F<B,D> g) +
      Both map (with g) and contramap (with f) the target function.
      +
      default <C> F<A,Either<B,C>>eitherLeftK() +
      Promotes this function so that it returns its result on the left side of an Either.
      +
      default <C> F<A,Either<C,B>>eitherRightK() +
      Promotes this function so that it returns its result on the right side of an Either.
      +
      Bf(A a) +
      Transform A to B.
      +
      default <C> F<A,Validation<B,C>>failK() +
      Promotes this function so that it returns its result on the failure side of a Validation.
      +
      default F<Tree<A>,B>foldMapTree(Monoid<B> m) +
      Returns a function that maps this function over a tree and folds it with the given monoid.
      +
      default F<A,IterableW<B>>iterableK() +
      Promotes this function to return its value in an Iterable.
      +
      default F<A,P1<B>>lazy() +
      Promotes this function so that it returns its result in a product-1.
      +
      default F<A,List<B>>listK() +
      Promotes this function so that it returns its result in a List.
      +
      default <C> F<A,C>map(F<B,C> f) 
      default F<Array<A>,Array<B>>mapArray() +
      Promotes this function to map over a Array.
      +
      default F<P2<A,A>,P2<B,B>>mapBoth() +
      Promotes this function to map over both elements of a pair.
      +
      default <X> F<Validation<A,X>,Validation<B,X>>mapFail() +
      Promotes this function to map over the failure side of a Validation.
      +
      default <C> F<P2<A,C>,P2<B,C>>mapFst() +
      Promotes this function to map over the first element of a pair.
      +
      default F<java.lang.Iterable<A>,IterableW<B>>mapIterable() +
      Promotes this function to map over Iterables.
      +
      default java.util.concurrent.ArrayBlockingQueue<B>mapJ(java.util.concurrent.ArrayBlockingQueue<A> as) +
      Maps this function over an ArrayBlockingQueue.
      +
      default java.util.ArrayList<B>mapJ(java.util.ArrayList<A> as) +
      Maps this function over an ArrayList.
      +
      default java.util.concurrent.ConcurrentLinkedQueue<B>mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as) +
      Maps this function over a ConcurrentLinkedQueue.
      +
      default java.util.concurrent.CopyOnWriteArrayList<B>mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as) +
      Maps this function over a CopyOnWriteArrayList.
      +
      default java.util.concurrent.CopyOnWriteArraySet<B>mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as) +
      Maps this function over a CopyOnWriteArraySet.
      +
      default java.util.concurrent.LinkedBlockingQueue<B>mapJ(java.util.concurrent.LinkedBlockingQueue<A> as) +
      Maps this function over a LinkedBlockingQueue.
      +
      default java.util.LinkedList<B>mapJ(java.util.LinkedList<A> as) +
      Maps this function over a LinkedList.
      +
      default java.util.concurrent.PriorityBlockingQueue<B>mapJ(java.util.concurrent.PriorityBlockingQueue<A> as) +
      Maps this function over a PriorityBlockingQueue.
      +
      default java.util.PriorityQueue<B>mapJ(java.util.PriorityQueue<A> as) +
      Maps this function over a PriorityQueue.
      +
      default java.util.concurrent.SynchronousQueue<B>mapJ(java.util.concurrent.SynchronousQueue<A> as) +
      Maps this function over a SynchronousQueue.
      +
      default java.util.TreeSet<B>mapJ(java.util.TreeSet<A> as) +
      Maps this function over a TreeSet.
      +
      default <X> F<Either<A,X>,Either<B,X>>mapLeft() +
      Promotes this function to map over the left side of an Either.
      +
      default F<List<A>,List<B>>mapList() +
      Promotes this function to map over a List.
      +
      default F<NonEmptyList<A>,NonEmptyList<B>>mapNel() +
      Promotes this function to map over a NonEmptyList.
      +
      default F<Option<A>,Option<B>>mapOption() +
      Promotes this function to map over an optional value.
      +
      default F<P1<A>,P1<B>>mapP1() +
      Promotes this function to map over a product-1.
      +
      default F<Promise<A>,Promise<B>>mapPromise() +
      Promotes this function to map over a Promise.
      +
      default <X> F<Either<X,A>,Either<X,B>>mapRight() +
      Promotes this function to map over the right side of an Either.
      +
      default F<Set<A>,Set<B>>mapSet(Ord<B> o) +
      Promotes this function to map over a Set.
      +
      default <C> F<P2<C,A>,P2<C,B>>mapSnd() +
      Promotes this function to map over the second element of a pair.
      +
      default F<Stream<A>,Stream<B>>mapStream() +
      Promotes this function to map over a Stream.
      +
      default <X> F<Validation<X,A>,Validation<X,B>>mapSuccess() +
      Promotes this function to map over the success side of a Validation.
      +
      default F<Tree<A>,Tree<B>>mapTree() +
      Promotes this function to map over a Tree.
      +
      default F<TreeZipper<A>,TreeZipper<B>>mapTreeZipper() +
      Promotes this function to map over a TreeZipper.
      +
      default F<Zipper<A>,Zipper<B>>mapZipper() +
      Promotes this function to map over a Zipper.
      +
      default F<A,NonEmptyList<B>>nelK() +
      Promotes this function to return its value in a NonEmptyList.
      +
      default <C> F<F<C,A>,F<C,B>>o() +
      First-class function composition
      +
      default <C> F<C,B>o(F<C,A> g) +
      Function composition
      +
      default <C> F<F<B,F<B,C>>,F<A,F<A,C>>>on() +
      Applies this function over the arguments of another function.
      +
      default <C> F<A,F<A,C>>on(F<B,F<B,C>> g) +
      Applies this function over the arguments of another function.
      +
      default F<Validation<B,A>,B>onFail() +
      Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
      +
      default F<Either<B,A>,B>onLeft() +
      Returns a function that returns the left side of a given Either, or this function applied to the right side.
      +
      default F<Either<A,B>,B>onRight() +
      Returns a function that returns the right side of a given Either, or this function applied to the left side.
      +
      default F<Validation<A,B>,B>onSuccess() +
      Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
      +
      default F<A,Option<B>>optionK() +
      Promotes this function so that it returns its result in an Option.
      +
      default P1<B>partial(A a) +
      Partial application.
      +
      default F<A,Promise<B>>promiseK(Strategy<Unit> s) +
      Promotes this function to a concurrent function that returns a Promise of a value.
      +
      default F<A,Set<B>>setK(Ord<B> o) +
      Promotes this function to return its value in a Set.
      +
      default F<A,Stream<B>>streamK() +
      Promotes this function so that it returns its result in a Stream.
      +
      default <C> F<A,Validation<C,B>>successK() +
      Promotes this function so that it returns its result on the success side of an Validation.
      +
      default F<A,Tree<B>>treeK() +
      Promotes this function to return its value in a Tree.
      +
      default F<A,TreeZipper<B>>treeZipperK() +
      Promotes this function to return its value in a TreeZipper.
      +
      default F<A,Zipper<B>>zipperK() +
      Promotes this function to return its value in a Zipper.
      +
      +
        +
      • + + +

        Methods inherited from interface java.util.function.Function

        +andThen, compose, identity
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
        +
        Transform A to B.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      + + + + + +
        +
      • +

        apply

        +
        default B apply(A a)
        +
        +
        Specified by:
        +
        apply in interface java.util.function.Function<A,B>
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        default <C> F<C,B> o(F<C,A> g)
        +
        Function composition
        +
        +
        Parameters:
        +
        g - A function to compose with this one.
        +
        Returns:
        +
        The composed function such that this function is applied last.
        +
        +
        • +
      + + + +
        +
      • +

        o

        +
        default <C> F<F<C,A>,F<C,B>> o()
        +
        First-class function composition
        +
        +
        Returns:
        +
        A function that composes this function with another.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        default <C> F<A,C> andThen(F<B,C> g)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function with which to compose this one.
        +
        Returns:
        +
        The composed function such that this function is applied first.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        default <C> F<F<B,C>,F<A,C>> andThen()
        +
        First-class composition flipped.
        +
        +
        Returns:
        +
        A function that invokes this function and then a given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        default <C> F<A,C> bind(F<B,F<A,C>> g)
        +
        Binds a given function across this function (Reader Monad).
        +
        +
        Parameters:
        +
        g - A function that takes the return value of this function as an argument, yielding a new function.
        +
        Returns:
        +
        A function that invokes this function on its argument and then the given function on the result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        default <C> F<F<B,F<A,C>>,F<A,C>> bind()
        +
        First-class function binding.
        +
        +
        Returns:
        +
        A function that binds another function across this function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        default <C> F<A,C> apply(F<A,F<B,C>> g)
        +
        Function application in an environment (Applicative Functor).
        +
        +
        Parameters:
        +
        g - A function with the same argument type as this function, yielding a function that takes the return + value of this function.
        +
        Returns:
        +
        A new function that invokes the given function on its argument, yielding a new function that is then + applied to the result of applying this function to the argument.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        default <C> F<F<A,F<B,C>>,F<A,C>> apply()
        +
        First-class function application in an environment.
        +
        +
        Returns:
        +
        A function that applies a given function within the environment of this function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        default <C> F<A,F<A,C>> on(F<B,F<B,C>> g)
        +
        Applies this function over the arguments of another function.
        +
        +
        Parameters:
        +
        g - The function over whose arguments to apply this function.
        +
        Returns:
        +
        A new function that invokes this function on its arguments before invoking the given function.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        default <C> F<F<B,F<B,C>>,F<A,F<A,C>>> on()
        +
        Applies this function over the arguments of another function.
        +
        +
        Returns:
        +
        A function that applies this function over the arguments of another function.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        default F<A,P1<B>> lazy()
        +
        Promotes this function so that it returns its result in a product-1. Kleisli arrow for P1.
        +
        +
        Returns:
        +
        This function promoted to return its result in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        partial

        +
        default P1<B> partial(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument to return a lazy value.
        +
        +
        • +
      + + + +
        +
      • +

        mapP1

        +
        default F<P1<A>,P1<B>> mapP1()
        +
        Promotes this function to map over a product-1.
        +
        +
        Returns:
        +
        This function promoted to map over a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        optionK

        +
        default F<A,Option<B>> optionK()
        +
        Promotes this function so that it returns its result in an Option. Kleisli arrow for Option.
        +
        +
        Returns:
        +
        This function promoted to return its result in an Option.
        +
        +
        • +
      + + + +
        +
      • +

        mapOption

        +
        default F<Option<A>,Option<B>> mapOption()
        +
        Promotes this function to map over an optional value.
        +
        +
        Returns:
        +
        This function promoted to map over an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        listK

        +
        default F<A,List<B>> listK()
        +
        Promotes this function so that it returns its result in a List. Kleisli arrow for List.
        +
        +
        Returns:
        +
        This function promoted to return its result in a List.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        default F<List<A>,List<B>> mapList()
        +
        Promotes this function to map over a List.
        +
        +
        Returns:
        +
        This function promoted to map over a List.
        +
        +
        • +
      + + + +
        +
      • +

        streamK

        +
        default F<A,Stream<B>> streamK()
        +
        Promotes this function so that it returns its result in a Stream. Kleisli arrow for Stream.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        default F<Stream<A>,Stream<B>> mapStream()
        +
        Promotes this function to map over a Stream.
        +
        +
        Returns:
        +
        This function promoted to map over a Stream.
        +
        +
        • +
      + + + +
        +
      • +

        arrayK

        +
        default F<A,Array<B>> arrayK()
        +
        Promotes this function so that it returns its result in a Array. Kleisli arrow for Array.
        +
        +
        Returns:
        +
        This function promoted to return its result in a Array.
        +
        +
        • +
      + + + +
        +
      • +

        mapArray

        +
        default F<Array<A>,Array<B>> mapArray()
        +
        Promotes this function to map over a Array.
        +
        +
        Returns:
        +
        This function promoted to map over a Array.
        +
        +
        • +
      + + + +
        +
      • +

        contramapActor

        +
        default F<Actor<B>,Actor<A>> contramapActor()
        +
        Returns a function that contramaps over a given actor.
        +
        +
        Returns:
        +
        A function that contramaps over a given actor.
        +
        +
        • +
      + + + +
        +
      • +

        promiseK

        +
        default F<A,Promise<B>> promiseK(Strategy<Unit> s)
        +
        Promotes this function to a concurrent function that returns a Promise of a value.
        +
        +
        Parameters:
        +
        s - A parallel strategy for concurrent execution.
        +
        Returns:
        +
        A concurrent function that returns a Promise of a value.
        +
        +
        • +
      + + + +
        +
      • +

        mapPromise

        +
        default F<Promise<A>,Promise<B>> mapPromise()
        +
        Promotes this function to map over a Promise.
        +
        +
        Returns:
        +
        This function promoted to map over Promises.
        +
        +
        • +
      + + + +
        +
      • +

        eitherLeftK

        +
        default <C> F<A,Either<B,C>> eitherLeftK()
        +
        Promotes this function so that it returns its result on the left side of an Either. + Kleisli arrow for the Either left projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        eitherRightK

        +
        default <C> F<A,Either<C,B>> eitherRightK()
        +
        Promotes this function so that it returns its result on the right side of an Either. + Kleisli arrow for the Either right projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapLeft

        +
        default <X> F<Either<A,X>,Either<B,X>> mapLeft()
        +
        Promotes this function to map over the left side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the left side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        mapRight

        +
        default <X> F<Either<X,A>,Either<X,B>> mapRight()
        +
        Promotes this function to map over the right side of an Either.
        +
        +
        Returns:
        +
        This function promoted to map over the right side of an Either.
        +
        +
        • +
      + + + +
        +
      • +

        onLeft

        +
        default F<Either<B,A>,B> onLeft()
        +
        Returns a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        Returns:
        +
        a function that returns the left side of a given Either, or this function applied to the right side.
        +
        +
        • +
      + + + +
        +
      • +

        onRight

        +
        default F<Either<A,B>,B> onRight()
        +
        Returns a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        Returns:
        +
        a function that returns the right side of a given Either, or this function applied to the left side.
        +
        +
        • +
      + + + +
        +
      • +

        iterableK

        +
        default F<A,IterableW<B>> iterableK()
        +
        Promotes this function to return its value in an Iterable.
        +
        +
        Returns:
        +
        This function promoted to return its value in an Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        mapIterable

        +
        default F<java.lang.Iterable<A>,IterableW<B>> mapIterable()
        +
        Promotes this function to map over Iterables.
        +
        +
        Returns:
        +
        This function promoted to map over Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        nelK

        +
        default F<A,NonEmptyList<B>> nelK()
        +
        Promotes this function to return its value in a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to return its value in a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        mapNel

        +
        default F<NonEmptyList<A>,NonEmptyList<B>> mapNel()
        +
        Promotes this function to map over a NonEmptyList.
        +
        +
        Returns:
        +
        This function promoted to map over a NonEmptyList.
        +
        +
        • +
      + + + +
        +
      • +

        setK

        +
        default F<A,Set<B>> setK(Ord<B> o)
        +
        Promotes this function to return its value in a Set.
        +
        +
        Parameters:
        +
        o - An order for the set.
        +
        Returns:
        +
        This function promoted to return its value in a Set.
        +
        +
        • +
      + + + +
        +
      • +

        mapSet

        +
        default F<Set<A>,Set<B>> mapSet(Ord<B> o)
        +
        Promotes this function to map over a Set.
        +
        +
        Parameters:
        +
        o - An order for the resulting set.
        +
        Returns:
        +
        This function promoted to map over a Set.
        +
        +
        • +
      + + + +
        +
      • +

        treeK

        +
        default F<A,Tree<B>> treeK()
        +
        Promotes this function to return its value in a Tree.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        mapTree

        +
        default F<Tree<A>,Tree<B>> mapTree()
        +
        Promotes this function to map over a Tree.
        +
        +
        Returns:
        +
        This function promoted to map over a Tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapTree

        +
        default F<Tree<A>,B> foldMapTree(Monoid<B> m)
        +
        Returns a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        Parameters:
        +
        m - The monoid with which to fold the mapped tree.
        +
        Returns:
        +
        a function that maps this function over a tree and folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperK

        +
        default F<A,TreeZipper<B>> treeZipperK()
        +
        Promotes this function to return its value in a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapTreeZipper

        +
        default F<TreeZipper<A>,TreeZipper<B>> mapTreeZipper()
        +
        Promotes this function to map over a TreeZipper.
        +
        +
        Returns:
        +
        This function promoted to map over a TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        failK

        +
        default <C> F<A,Validation<B,C>> failK()
        +
        Promotes this function so that it returns its result on the failure side of a Validation. + Kleisli arrow for the Validation failure projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        successK

        +
        default <C> F<A,Validation<C,B>> successK()
        +
        Promotes this function so that it returns its result on the success side of an Validation. + Kleisli arrow for the Validation success projection.
        +
        +
        Returns:
        +
        This function promoted to return its result on the success side of an Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapFail

        +
        default <X> F<Validation<A,X>,Validation<B,X>> mapFail()
        +
        Promotes this function to map over the failure side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the failure side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        mapSuccess

        +
        default <X> F<Validation<X,A>,Validation<X,B>> mapSuccess()
        +
        Promotes this function to map over the success side of a Validation.
        +
        +
        Returns:
        +
        This function promoted to map over the success side of a Validation.
        +
        +
        • +
      + + + +
        +
      • +

        onFail

        +
        default F<Validation<B,A>,B> onFail()
        +
        Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        Returns:
        +
        a function that returns the failure side of a given Validation, + or this function applied to the success side.
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        default F<Validation<A,B>,B> onSuccess()
        +
        Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        Returns:
        +
        a function that returns the success side of a given Validation, + or this function applied to the failure side.
        +
        +
        • +
      + + + +
        +
      • +

        zipperK

        +
        default F<A,Zipper<B>> zipperK()
        +
        Promotes this function to return its value in a Zipper.
        +
        +
        Returns:
        +
        This function promoted to return its value in a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        mapZipper

        +
        default F<Zipper<A>,Zipper<B>> mapZipper()
        +
        Promotes this function to map over a Zipper.
        +
        +
        Returns:
        +
        This function promoted to map over a Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        contramapEqual

        +
        default F<Equal<B>,Equal<A>> contramapEqual()
        +
        Promotes this function to map over an Equal as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over an Equal as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapHash

        +
        default F<Hash<B>,Hash<A>> contramapHash()
        +
        Promotes this function to map over a Hash as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Hash as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        contramapShow

        +
        default F<Show<B>,Show<A>> contramapShow()
        +
        Promotes this function to map over a Show as a contravariant functor.
        +
        +
        Returns:
        +
        This function promoted to map over a Show as a contravariant functor.
        +
        +
        • +
      + + + +
        +
      • +

        mapFst

        +
        default <C> F<P2<A,C>,P2<B,C>> mapFst()
        +
        Promotes this function to map over the first element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the first element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapSnd

        +
        default <C> F<P2<C,A>,P2<C,B>> mapSnd()
        +
        Promotes this function to map over the second element of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over the second element of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapBoth

        +
        default F<P2<A,A>,P2<B,B>> mapBoth()
        +
        Promotes this function to map over both elements of a pair.
        +
        +
        Returns:
        +
        This function promoted to map over both elements of a pair.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.SynchronousQueue<B> mapJ(java.util.concurrent.SynchronousQueue<A> as)
        +
        Maps this function over a SynchronousQueue.
        +
        +
        Parameters:
        +
        as - A SynchronousQueue to map this function over.
        +
        Returns:
        +
        A new SynchronousQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.PriorityBlockingQueue<B> mapJ(java.util.concurrent.PriorityBlockingQueue<A> as)
        +
        Maps this function over a PriorityBlockingQueue.
        +
        +
        Parameters:
        +
        as - A PriorityBlockingQueue to map this function over.
        +
        Returns:
        +
        A new PriorityBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.LinkedBlockingQueue<B> mapJ(java.util.concurrent.LinkedBlockingQueue<A> as)
        +
        Maps this function over a LinkedBlockingQueue.
        +
        +
        Parameters:
        +
        as - A LinkedBlockingQueue to map this function over.
        +
        Returns:
        +
        A new LinkedBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.CopyOnWriteArraySet<B> mapJ(java.util.concurrent.CopyOnWriteArraySet<A> as)
        +
        Maps this function over a CopyOnWriteArraySet.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArraySet to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArraySet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.CopyOnWriteArrayList<B> mapJ(java.util.concurrent.CopyOnWriteArrayList<A> as)
        +
        Maps this function over a CopyOnWriteArrayList.
        +
        +
        Parameters:
        +
        as - A CopyOnWriteArrayList to map this function over.
        +
        Returns:
        +
        A new CopyOnWriteArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.ConcurrentLinkedQueue<B> mapJ(java.util.concurrent.ConcurrentLinkedQueue<A> as)
        +
        Maps this function over a ConcurrentLinkedQueue.
        +
        +
        Parameters:
        +
        as - A ConcurrentLinkedQueue to map this function over.
        +
        Returns:
        +
        A new ConcurrentLinkedQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.concurrent.ArrayBlockingQueue<B> mapJ(java.util.concurrent.ArrayBlockingQueue<A> as)
        +
        Maps this function over an ArrayBlockingQueue.
        +
        +
        Parameters:
        +
        as - An ArrayBlockingQueue to map this function over.
        +
        Returns:
        +
        A new ArrayBlockingQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.TreeSet<B> mapJ(java.util.TreeSet<A> as)
        +
        Maps this function over a TreeSet.
        +
        +
        Parameters:
        +
        as - A TreeSet to map this function over.
        +
        Returns:
        +
        A new TreeSet with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.PriorityQueue<B> mapJ(java.util.PriorityQueue<A> as)
        +
        Maps this function over a PriorityQueue.
        +
        +
        Parameters:
        +
        as - A PriorityQueue to map this function over.
        +
        Returns:
        +
        A new PriorityQueue with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.LinkedList<B> mapJ(java.util.LinkedList<A> as)
        +
        Maps this function over a LinkedList.
        +
        +
        Parameters:
        +
        as - A LinkedList to map this function over.
        +
        Returns:
        +
        A new LinkedList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapJ

        +
        default java.util.ArrayList<B> mapJ(java.util.ArrayList<A> as)
        +
        Maps this function over an ArrayList.
        +
        +
        Parameters:
        +
        as - An ArrayList to map this function over.
        +
        Returns:
        +
        A new ArrayList with this function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        default <C> F<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        default <C> F<C,B> contramap(F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        dimap

        +
        default <C,D> F<C,D> dimap(F<C,A> f,
+                           F<B,D> g)
        +
        Both map (with g) and contramap (with f) the target function. (Profunctor pattern)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F0.html b/javadoc/5.0/functionaljava/fj/F0.html new file mode 100644 index 0000000..f13c7e2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F0.html @@ -0,0 +1,301 @@ + + + + + +F0 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F0<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.Supplier<A>
    +
    +
    +
    All Known Implementing Classes:
    +
    $, P1
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F0<A>
+extends java.util.function.Supplier<A>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
        +
        • +
      + + + +
        +
      • +

        get

        +
        default A get()
        +
        +
        Specified by:
        +
        get in interface java.util.function.Supplier<A>
        +
        +
        • +
      + + + +
        +
      • +

        toEffect0

        +
        default Effect0 toEffect0()
        +
        • +
      + + + +
        +
      • +

        toTryEffect0

        +
        default <Z extends java.lang.Exception> TryEffect0<Z> toTryEffect0()
        +
        • +
      + + + +
        +
      • +

        toTry0

        +
        default <Z extends java.lang.Exception> Try0<A,Z> toTry0()
        +
        • +
      + + + +
        +
      • +

        toP1

        +
        default P1<A> toP1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F2.html b/javadoc/5.0/functionaljava/fj/F2.html new file mode 100644 index 0000000..2ebdf56 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F2.html @@ -0,0 +1,776 @@ + + + + + +F2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F2<A,B,C>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.BiFunction<A,B,C>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F2<A,B,C>
+extends java.util.function.BiFunction<A,B,C>
    +
    A transformation function of arity-2 from A and B to C.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
        +
        Transform A and B to C.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      + + + + + +
        +
      • +

        apply

        +
        default C apply(A a,
+                B b)
        +
        +
        Specified by:
        +
        apply in interface java.util.function.BiFunction<A,B,C>
        +
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        default F<B,C> f(A a)
        +
        Partial application.
        +
        +
        Parameters:
        +
        a - The A to which to apply this function.
        +
        Returns:
        +
        The function partially applied to the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        default F<A,F<B,C>> curry()
        +
        Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        Returns:
        +
        a wrapped function of arity-1 that returns another wrapped function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        default F2<B,A,C> flip()
        +
        Flips the arguments of this function.
        +
        +
        Returns:
        +
        A new function with the arguments of this function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        default F<P2<A,B>,C> tuple()
        +
        Uncurries this function to a function on tuples.
        +
        +
        Returns:
        +
        A new function that calls this function with the elements of a given tuple.
        +
        +
        • +
      + + + +
        +
      • +

        arrayM

        +
        default F2<Array<A>,Array<B>,Array<C>> arrayM()
        +
        Promotes this function to a function on Arrays.
        +
        +
        Returns:
        +
        This function promoted to transform Arrays.
        +
        +
        • +
      + + + +
        +
      • +

        promiseM

        +
        default F2<Promise<A>,Promise<B>,Promise<C>> promiseM()
        +
        Promotes this function to a function on Promises.
        +
        +
        Returns:
        +
        This function promoted to transform Promises.
        +
        +
        • +
      + + + +
        +
      • +

        iterableM

        +
        default F2<java.lang.Iterable<A>,java.lang.Iterable<B>,IterableW<C>> iterableM()
        +
        Promotes this function to a function on Iterables.
        +
        +
        Returns:
        +
        This function promoted to transform Iterables.
        +
        +
        • +
      + + + +
        +
      • +

        listM

        +
        default F2<List<A>,List<B>,List<C>> listM()
        +
        Promotes this function to a function on Lists.
        +
        +
        Returns:
        +
        This function promoted to transform Lists.
        +
        +
        • +
      + + + +
        +
      • +

        nelM

        +
        default F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> nelM()
        +
        Promotes this function to a function on non-empty lists.
        +
        +
        Returns:
        +
        This function promoted to transform non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionM

        +
        default F2<Option<A>,Option<B>,Option<C>> optionM()
        +
        Promotes this function to a function on Options.
        +
        +
        Returns:
        +
        This function promoted to transform Options.
        +
        +
        • +
      + + + +
        +
      • +

        setM

        +
        default F2<Set<A>,Set<B>,Set<C>> setM(Ord<C> o)
        +
        Promotes this function to a function on Sets.
        +
        +
        Parameters:
        +
        o - An ordering for the result of the promoted function.
        +
        Returns:
        +
        This function promoted to transform Sets.
        +
        +
        • +
      + + + +
        +
      • +

        streamM

        +
        default F2<Stream<A>,Stream<B>,Stream<C>> streamM()
        +
        Promotes this function to a function on Streams.
        +
        +
        Returns:
        +
        This function promoted to transform Streams.
        +
        +
        • +
      + + + +
        +
      • +

        treeM

        +
        default F2<Tree<A>,Tree<B>,Tree<C>> treeM()
        +
        Promotes this function to a function on Trees.
        +
        +
        Returns:
        +
        This function promoted to transform Trees.
        +
        +
        • +
      + + + +
        +
      • +

        zipArrayM

        +
        default F2<Array<A>,Array<B>,Array<C>> zipArrayM()
        +
        Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
        +
        +
        Returns:
        +
        A function that zips two arrays with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipIterableM

        +
        default F2<java.lang.Iterable<A>,java.lang.Iterable<B>,java.lang.Iterable<C>> zipIterableM()
        +
        Promotes this function to zip two iterables, applying the function lock-step over both iterables.
        +
        +
        Returns:
        +
        A function that zips two iterables with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipListM

        +
        default F2<List<A>,List<B>,List<C>> zipListM()
        +
        Promotes this function to zip two lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipStreamM

        +
        default F2<Stream<A>,Stream<B>,Stream<C>> zipStreamM()
        +
        Promotes this function to zip two streams, applying the function lock-step over both streams.
        +
        +
        Returns:
        +
        A function that zips two streams with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipNelM

        +
        default F2<NonEmptyList<A>,NonEmptyList<B>,NonEmptyList<C>> zipNelM()
        +
        Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
        +
        +
        Returns:
        +
        A function that zips two non-empty lists with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipSetM

        +
        default F2<Set<A>,Set<B>,Set<C>> zipSetM(Ord<C> o)
        +
        Promotes this function to zip two sets, applying the function lock-step over both sets.
        +
        +
        Parameters:
        +
        o - An ordering for the resulting set.
        +
        Returns:
        +
        A function that zips two sets with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeM

        +
        default F2<Tree<A>,Tree<B>,Tree<C>> zipTreeM()
        +
        Promotes this function to zip two trees, applying the function lock-step over both trees. + The structure of the resulting tree is the structural intersection of the two trees.
        +
        +
        Returns:
        +
        A function that zips two trees with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipZipperM

        +
        default F2<Zipper<A>,Zipper<B>,Zipper<C>> zipZipperM()
        +
        Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions. + The structure of the resulting zipper is the structural intersection of the two zippers.
        +
        +
        Returns:
        +
        A function that zips two zippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        zipTreeZipperM

        +
        default F2<TreeZipper<A>,TreeZipper<B>,TreeZipper<C>> zipTreeZipperM()
        +
        Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Returns:
        +
        A function that zips two TreeZippers with this function.
        +
        +
        • +
      + + + +
        +
      • +

        contramapFirst

        +
        default <Z> F2<Z,B,C> contramapFirst(F<Z,A> f)
        +
        • +
      + + + +
        +
      • +

        contramapSecond

        +
        default <Z> F2<A,Z,C> contramapSecond(F<Z,B> f)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        default <X,Y> F2<X,Y,C> contramap(F<X,A> f,
+                                  F<Y,B> g)
        +
        • +
      + + + +
        +
      • +

        map

        +
        default <Z> F2<A,B,Z> map(F<C,Z> f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F3.html b/javadoc/5.0/functionaljava/fj/F3.html new file mode 100644 index 0000000..157fd06 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F3.html @@ -0,0 +1,242 @@ + + + + + +F3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F3<A,B,C,D>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F3<A,B,C,D>
    +
    A transformation function of arity-3 from A, B and C to + D.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
        +
        Transform A, B and C to D.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F4.html b/javadoc/5.0/functionaljava/fj/F4.html new file mode 100644 index 0000000..85ad3af --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F4.html @@ -0,0 +1,245 @@ + + + + + +F4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F4<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F4<A,B,C,D,E>
    +
    A transformation function of arity-4 from A, B, C and + D to E.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
        +
        Transform A, B, C and D to E.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F5.html b/javadoc/5.0/functionaljava/fj/F5.html new file mode 100644 index 0000000..790e642 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F5.html @@ -0,0 +1,250 @@ + + + + + +F5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F5<A,B,C,D,E,F$>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F5<A,B,C,D,E,F$>
    +
    A transformation function of arity-5 from A, B, C, + D and E to F$.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F$ f(A a,
+     B b,
+     C c,
+     D d,
+     E e)
        +
        Transform A, B, C, D and E to + F$.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F6.html b/javadoc/5.0/functionaljava/fj/F6.html new file mode 100644 index 0000000..4a90705 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F6.html @@ -0,0 +1,253 @@ + + + + + +F6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F6<A,B,C,D,E,F$,G>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F6<A,B,C,D,E,F$,G>
    +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Gf(A a, + B b, + C c, + D d, + E e, + F$ f) +
      Transform A, B, C, D, E and + F$ to G.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f)
        +
        Transform A, B, C, D, E and + F$ to G.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F7.html b/javadoc/5.0/functionaljava/fj/F7.html new file mode 100644 index 0000000..5198df0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F7.html @@ -0,0 +1,256 @@ + + + + + +F7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F7<A,B,C,D,E,F$,G,H>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F7<A,B,C,D,E,F$,G,H>
    +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      Hf(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      Transform A, B, C, D, E, + F$ and G to H.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g)
        +
        Transform A, B, C, D, E, + F$ and G to H.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/F8.html b/javadoc/5.0/functionaljava/fj/F8.html new file mode 100644 index 0000000..4d4d395 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/F8.html @@ -0,0 +1,260 @@ + + + + + +F8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface F8<A,B,C,D,E,F$,G,H,I>

+
+
+
+
    +
  • +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface F8<A,B,C,D,E,F$,G,H,I>
    +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      If(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      Transform A, B, C, D, E, + F$, G and H to I.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F$ f,
+    G g,
+    H h)
        +
        Transform A, B, C, D, E, + F$, G and H to I.
        +
        +
        Parameters:
        +
        a - The A to transform.
        +
        b - The B to transform.
        +
        c - The C to transform.
        +
        d - The D to transform.
        +
        e - The E to transform.
        +
        f - The F$ to transform.
        +
        g - The G to transform.
        +
        h - The H to transform.
        +
        Returns:
        +
        The result of the transformation.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Function.html b/javadoc/5.0/functionaljava/fj/Function.html new file mode 100644 index 0000000..78523bf --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Function.html @@ -0,0 +1,2161 @@ + + + + + +Function (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Function

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Function
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Function
+extends java.lang.Object
    +
    Transformations on functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>>andThen() +
      Function composition flipped.
      +
      static <A,B,C> F<A,C>andThen(F<A,B> g, + F<B,C> f) +
      Function composition flipped.
      +
      static <A,B> F<F<A,B>,B>apply(A a) +
      Function application with the arguments flipped.
      +
      static <A,B,C> F<C,B>apply(F<C,F<A,B>> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>apply(F2<C,A,B> cab, + F<C,A> ca) +
      Performs function application within a higher-order function (applicative functor pattern).
      +
      static <A,B,C> F<C,B>bind(F<C,A> ma, + F<A,F<C,B>> f) +
      Binds the function in the second argument to the function in the first argument.
      +
      static <A,B,C,D> F<D,C>bind(F<D,A> ca, + F<D,B> cb, + F<A,F<B,C>> f) +
      Binds the given function f to the values of the given functions, with a final join.
      +
      static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>>compose() +
      Function composition.
      +
      static <A,B,C> F<A,C>compose(F<B,C> f, + F<A,B> g) +
      Function composition.
      +
      static <A,B,C,D> F<A,F<B,D>>compose2(F<C,D> f, + F<A,F<B,C>> g) +
      Function composition.
      +
      static <A,B> F<B,F<A,B>>constant() +
      Returns a function that given an argument, returns a function that ignores its argument.
      +
      static <A,B> F<A,B>constant(B b) +
      Returns a function that ignores its argument to constantly produce the given value.
      +
      static <A,B,C> F<A,F<B,C>>curry(F2<A,B,C> f) +
      Curry a function of arity-2.
      +
      static <A,B,C> F<B,C>curry(F2<A,B,C> f, + A a) +
      Curry a function of arity-2.
      +
      static <A,B,C,D> F<A,F<B,F<C,D>>>curry(F3<A,B,C,D> f) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<B,F<C,D>>curry(F3<A,B,C,D> f, + A a) +
      Curry a function of arity-3.
      +
      static <A,B,C,D> F<C,D>curry(F3<A,B,C,D> f, + A a, + B b) +
      Curry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,E>>>>      		curry(F4<A,B,C,D,E> f) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<B,F<C,F<D,E>>>      		curry(F4<A,B,C,D,E> f, + A a) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<C,F<D,E>>      		curry(F4<A,B,C,D,E> f, + A a, + B b) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E>
      F<D,E>      		curry(F4<A,B,C,D,E> f, + A a, + B b, + C c) +
      Curry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F$>>>>>      		curry(F5<A,B,C,D,E,F$> f) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<B,F<C,F<D,F<E,F$>>>>      		curry(F5<A,B,C,D,E,F$> f, + A a) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<C,F<D,F<E,F$>>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<D,F<E,F$>>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F<E,F$>      		curry(F5<A,B,C,D,E,F$> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-5.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>      		curry(F6<A,B,C,D,E,F$,G> f) +
      Curry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<C,F<D,F<E,F<F$,F<G,H>>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<D,F<E,F<F$,F<G,H>>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<E,F<F$,F<G,H>>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F$,F<G,H>>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<G,H>      		curry(F7<A,B,C,D,E,F$,G,H> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<D,F<E,F<F$,F<G,F<H,I>>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<E,F<F$,F<G,F<H,I>>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F$,F<G,F<H,I>>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<G,F<H,I>>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$) +
      Curry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<H,I>      		curry(F8<A,B,C,D,E,F$,G,H,I> f, + A a, + B b, + C c, + D d, + E e, + F$ f$, + G g) +
      Curry a function of arity-7.
      +
      static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>>flip() +
      Function argument flipping.
      +
      static <A,B,C> F<B,F<A,C>>flip(F<A,F<B,C>> f) +
      Function argument flipping.
      +
      static <A,B,C> F2<B,A,C>flip(F2<A,B,C> f) +
      Function argument flipping.
      +
      static <A,B,C> F<F2<A,B,C>,F2<B,A,C>>flip2() +
      Function argument flipping.
      +
      static <A> F<A,A>identity() +
      The identity transformation.
      +
      static <A,B> F<B,A>join(F<B,F<B,A>> f) +
      Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
      +
      static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>>lift(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a higher-order function.
      +
      static <A,B> F<A,Option<B>>nullable(F<A,B> f) +
      Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
      +
      static <A,B,C> F<B,F<B,C>>on(F<A,F<A,C>> a, + F<B,A> f) +
      Applies a given function over the arguments of another function of arity-2.
      +
      static <A,B,C> F<A,C>partialApply2(F<A,F<B,C>> f, + B b) +
      Partial application of the second argument to the supplied function to get a function of type + A -> C.
      +
      static <A,B,C,D> F<A,F<B,D>>partialApply3(F<A,F<B,F<C,D>>> f, + C c) +
      Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,E>>>      		partialApply4(F<A,F<B,F<C,F<D,E>>>> f, + D d) +
      Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F$>>>>      		partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f, + E e) +
      Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,G>>>>>      		partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f, + F$ f$) +
      Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>>      		partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f, + G g) +
      Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>>      		partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f, + H h) +
      Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
      +
      static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>>uncurryF2() +
      Uncurry a function of arity-2.
      +
      static <A,B,C> F2<A,B,C>uncurryF2(F<A,F<B,C>> f) +
      Uncurry a function of arity-2.
      +
      static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>>uncurryF3() +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D> F3<A,B,C,D>uncurryF3(F<A,F<B,F<C,D>>> f) +
      Uncurry a function of arity-3.
      +
      static <A,B,C,D,E>
      F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>>      		uncurryF4() +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E>
      F4<A,B,C,D,E>      		uncurryF4(F<A,F<B,F<C,F<D,E>>>> f) +
      Uncurry a function of arity-4.
      +
      static <A,B,C,D,E,F$>
      F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>>      		uncurryF5() +
      Uncurry a function of arity-5.
      +
      static <A,B,C,D,E,F$>
      F5<A,B,C,D,E,F$>      		uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>>      		uncurryF6() +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G>
      F6<A,B,C,D,E,F$,G>      		uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Uncurry a function of arity-6.
      +
      static <A,B,C,D,E,F$,G,H>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>>      		uncurryF7() +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F7<A,B,C,D,E,F$,G,H>      		uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Uncurry a function of arity-7.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>>      		uncurryF8() +
      Uncurry a function of arity-8.
      +
      static <A,B,C,D,E,F$,G,H,I>
      F8<A,B,C,D,E,F$,G,H,I>      		uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Uncurry a function of arity-8.
      +
      static <C,A extends C,B,D extends B>
      F<F<C,D>,F<A,B>>      		vary() +
      Simultaneously covaries and contravaries a function.
      +
      static <A,B> F<A,B>vary(F<? super A,? extends B> f) +
      Simultaneously covaries and contravaries a function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public static <A,B> F<F<A,B>,B> apply(A a)
        +
        Function application with the arguments flipped.
        +
        +
        Parameters:
        +
        a - The value to apply the function to.
        +
        Returns:
        +
        A function that is partially-applied to the given value.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<F<B,C>,F<F<A,B>,F<A,C>>> compose()
        +
        Function composition.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public static <A,B,C> F<A,C> compose(F<B,C> f,
+                                     F<A,B> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        compose2

        +
        public static <A,B,C,D> F<A,F<B,D>> compose2(F<C,D> f,
+                                             F<A,F<B,C>> g)
        +
        Function composition.
        +
        +
        Parameters:
        +
        f - A function to compose with another.
        +
        g - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<F<A,B>,F<F<B,C>,F<A,C>>> andThen()
        +
        Function composition flipped.
        +
        +
        Returns:
        +
        A function that composes two functions to produce a new function.
        +
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public static <A,B,C> F<A,C> andThen(F<A,B> g,
+                                     F<B,C> f)
        +
        Function composition flipped.
        +
        +
        Parameters:
        +
        g - A function to compose with another.
        +
        f - A function to compose with another.
        +
        Returns:
        +
        A function that is the composition of the given arguments.
        +
        +
        • +
      + + + +
        +
      • +

        identity

        +
        public static <A> F<A,A> identity()
        +
        The identity transformation.
        +
        +
        Returns:
        +
        The identity transformation.
        +
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public static <A,B> F<B,F<A,B>> constant()
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> F<A,B> constant(B b)
        +
        Returns a function that ignores its argument to constantly produce the given value.
        +
        +
        Parameters:
        +
        b - The value to return when the returned function is applied.
        +
        Returns:
        +
        A function that ignores its argument to constantly produce the given value.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <A,B> F<A,B> vary(F<? super A,? extends B> f)
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Parameters:
        +
        f - The function to vary.
        +
        Returns:
        +
        A co- and contravariant function that invokes f on its argument.
        +
        +
        • +
      + + + +
        +
      • +

        vary

        +
        public static <C,A extends C,B,D extends B> F<F<C,D>,F<A,B>> vary()
        +
        Simultaneously covaries and contravaries a function.
        +
        +
        Returns:
        +
        A function that varies and covaries a function.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<F<A,F<B,C>>,F<B,F<A,C>>> flip()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that takes a function and flips its arguments.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F<B,F<A,C>> flip(F<A,F<B,C>> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip

        +
        public static <A,B,C> F2<B,A,C> flip(F2<A,B,C> f)
        +
        Function argument flipping.
        +
        +
        Parameters:
        +
        f - The function to flip.
        +
        Returns:
        +
        The given function flipped.
        +
        +
        • +
      + + + +
        +
      • +

        flip2

        +
        public static <A,B,C> F<F2<A,B,C>,F2<B,A,C>> flip2()
        +
        Function argument flipping.
        +
        +
        Returns:
        +
        A function that flips the arguments of a given function.
        +
        +
        • +
      + + + +
        +
      • +

        nullable

        +
        public static <A,B> F<A,Option<B>> nullable(F<A,B> f)
        +
        Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        Parameters:
        +
        f - The function to check for a null argument.
        +
        Returns:
        +
        A function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<A,F<B,C>> curry(F2<A,B,C> f)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C> F<B,C> curry(F2<A,B,C> f,
+                                   A a)
        +
        Curry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F<F<A,F<B,C>>,F2<A,B,C>> uncurryF2()
        +
        Uncurry a function of arity-2.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF2

        +
        public static <A,B,C> F2<A,B,C> uncurryF2(F<A,F<B,C>> f)
        +
        Uncurry a function of arity-2.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<A,F<B,F<C,D>>> curry(F3<A,B,C,D> f)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<B,F<C,D>> curry(F3<A,B,C,D> f,
+                                          A a)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D> F<C,D> curry(F3<A,B,C,D> f,
+                                     A a,
+                                     B b)
        +
        Curry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F<F<A,F<B,F<C,D>>>,F3<A,B,C,D>> uncurryF3()
        +
        Uncurry a function of arity-3.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF3

        +
        public static <A,B,C,D> F3<A,B,C,D> uncurryF3(F<A,F<B,F<C,D>>> f)
        +
        Uncurry a function of arity-3.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,E>>>> curry(F4<A,B,C,D,E> f)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<B,F<C,F<D,E>>> curry(F4<A,B,C,D,E> f,
+                                                 A a)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<C,F<D,E>> curry(F4<A,B,C,D,E> f,
+                                            A a,
+                                            B b)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E> F<D,E> curry(F4<A,B,C,D,E> f,
+                                       A a,
+                                       B b,
+                                       C c)
        +
        Curry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F<F<A,F<B,F<C,F<D,E>>>>,F4<A,B,C,D,E>> uncurryF4()
        +
        Uncurry a function of arity-4.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF4

        +
        public static <A,B,C,D,E> F4<A,B,C,D,E> uncurryF4(F<A,F<B,F<C,F<D,E>>>> f)
        +
        Uncurry a function of arity-4.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F$>>>>> curry(F5<A,B,C,D,E,F$> f)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<B,F<C,F<D,F<E,F$>>>> curry(F5<A,B,C,D,E,F$> f,
+                                                          A a)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<C,F<D,F<E,F$>>> curry(F5<A,B,C,D,E,F$> f,
+                                                     A a,
+                                                     B b)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<D,F<E,F$>> curry(F5<A,B,C,D,E,F$> f,
+                                                A a,
+                                                B b,
+                                                C c)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$> F<E,F$> curry(F5<A,B,C,D,E,F$> f,
+                                           A a,
+                                           B b,
+                                           C c,
+                                           D d)
        +
        Curry a function of arity-5.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F<F<A,F<B,F<C,F<D,F<E,F$>>>>>,F5<A,B,C,D,E,F$>> uncurryF5()
        +
        Uncurry a function of arity-5.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF5

        +
        public static <A,B,C,D,E,F$> F5<A,B,C,D,E,F$> uncurryF5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> curry(F6<A,B,C,D,E,F$,G> f)
        +
        Curry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F<F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>>,F6<A,B,C,D,E,F$,G>> uncurryF6()
        +
        Uncurry a function of arity-6.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF6

        +
        public static <A,B,C,D,E,F$,G> F6<A,B,C,D,E,F$,G> uncurryF6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Uncurry a function of arity-6.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                        A a)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<C,F<D,F<E,F<F$,F<G,H>>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                                   A a,
+                                                                   B b)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<D,F<E,F<F$,F<G,H>>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                              A a,
+                                                              B b,
+                                                              C c)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<E,F<F$,F<G,H>>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                         A a,
+                                                         B b,
+                                                         C c,
+                                                         D d)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<F$,F<G,H>> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                                    A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H> F<G,H> curry(F7<A,B,C,D,E,F$,G,H> f,
+                                              A a,
+                                              B b,
+                                              C c,
+                                              D d,
+                                              E e,
+                                              F$ f$)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>>,F7<A,B,C,D,E,F$,G,H>> uncurryF7()
        +
        Uncurry a function of arity-7.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF7

        +
        public static <A,B,C,D,E,F$,G,H> F7<A,B,C,D,E,F$,G,H> uncurryF7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Uncurry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                               A a)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                          A a,
+                                                                          B b)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<D,F<E,F<F$,F<G,F<H,I>>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                     A a,
+                                                                     B b,
+                                                                     C c)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<E,F<F$,F<G,F<H,I>>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                                A a,
+                                                                B b,
+                                                                C c,
+                                                                D d)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F$,F<G,F<H,I>>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                           A a,
+                                                           B b,
+                                                           C c,
+                                                           D d,
+                                                           E e)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<G,F<H,I>> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                     A a,
+                                                     B b,
+                                                     C c,
+                                                     D d,
+                                                     E e,
+                                                     F$ f$)
        +
        Curry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        curry

        +
        public static <A,B,C,D,E,F$,G,H,I> F<H,I> curry(F8<A,B,C,D,E,F$,G,H,I> f,
+                                                A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f$,
+                                                G g)
        +
        Curry a function of arity-7.
        +
        +
        Parameters:
        +
        f - The function to curry.
        +
        a - An argument to the curried function.
        +
        b - An argument to the curried function.
        +
        c - An argument to the curried function.
        +
        d - An argument to the curried function.
        +
        e - An argument to the curried function.
        +
        f$ - An argument to the curried function.
        +
        g - An argument to the curried function.
        +
        Returns:
        +
        A curried form of the given function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>>,F8<A,B,C,D,E,F$,G,H,I>> uncurryF8()
        +
        Uncurry a function of arity-8.
        +
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        uncurryF8

        +
        public static <A,B,C,D,E,F$,G,H,I> F8<A,B,C,D,E,F$,G,H,I> uncurryF8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Uncurry a function of arity-8.
        +
        +
        Parameters:
        +
        f - The function to uncurry.
        +
        Returns:
        +
        An uncurried function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> F<C,B> bind(F<C,A> ma,
+                                  F<A,F<C,B>> f)
        +
        Binds the function in the second argument to the function in the first argument.
        +
        +
        Parameters:
        +
        ma - A function whose argument type is the same as the argument type of the return value.
        +
        f - A function whose argument type is the same as the return type of ma, + and yields the return value.
        +
        Returns:
        +
        A function that chains the given functions together such that the result of applying + ma to the argument is given to f, yielding a function + that is applied to the argument again.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F<C,F<A,B>> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B,C> F<C,B> apply(F2<C,A,B> cab,
+                                   F<C,A> ca)
        +
        Performs function application within a higher-order function (applicative functor pattern).
        +
        +
        Parameters:
        +
        cab - The higher-order function to apply a function to.
        +
        ca - A function to apply within a higher-order function.
        +
        Returns:
        +
        A new function after applying the given higher-order function to the given function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C,D> F<D,C> bind(F<D,A> ca,
+                                    F<D,B> cb,
+                                    F<A,F<B,C>> f)
        +
        Binds the given function f to the values of the given functions, with a final join.
        +
        +
        Parameters:
        +
        ca - A function to bind f function to.
        +
        cb - A function to bind f function to.
        +
        f - The bound function to be composed with ca and then applied with cb
        +
        Returns:
        +
        A new function after performing the composition, then application.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public static <A,B,C> F<B,F<B,C>> on(F<A,F<A,C>> a,
+                                     F<B,A> f)
        +
        Applies a given function over the arguments of another function of arity-2.
        +
        +
        Parameters:
        +
        a - The function whose arguments to apply another function over.
        +
        f - The function to apply over the arguments of another function.
        +
        Returns:
        +
        A function whose arguments are fed through function f, before being passed to function a.
        +
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C,D> F<F<D,A>,F<F<D,B>,F<D,C>>> lift(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a higher-order function.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to compose with two functions.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,B> F<B,A> join(F<B,F<B,A>> f)
        +
        Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
        +
        +
        Parameters:
        +
        f - A function whose arguments to join.
        +
        Returns:
        +
        A function of arity-1 whose argument is substituted for both parameters of f.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply2

        +
        public static <A,B,C> F<A,C> partialApply2(F<A,F<B,C>> f,
+                                           B b)
        +
        Partial application of the second argument to the supplied function to get a function of type + A -> C. Same as flip(f).f(b).
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        b - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its second argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply3

        +
        public static <A,B,C,D> F<A,F<B,D>> partialApply3(F<A,F<B,F<C,D>>> f,
+                                                  C c)
        +
        Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        c - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its third argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply4

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,E>>> partialApply4(F<A,F<B,F<C,F<D,E>>>> f,
+                                                         D d)
        +
        Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        d - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fourth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply5

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F$>>>> partialApply5(F<A,F<B,F<C,F<D,F<E,F$>>>>> f,
+                                                                  E e)
        +
        Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        e - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its fifth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply6

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,G>>>>> partialApply6(F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f,
+                                                                        F$ f$)
        +
        Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        f$ - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its sixth argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply7

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,H>>>>>> partialApply7(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f,
+                                                                                G g)
        +
        Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        g - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its seventh argument applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        partialApply8

        +
        public static <A,B,C,D,E,F$,G,H,I> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,I>>>>>>> partialApply8(F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f,
+                                                                                       H h)
        +
        Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
        +
        +
        Parameters:
        +
        f - The function to partially apply.
        +
        h - The value to apply to the function.
        +
        Returns:
        +
        A new function based on f with its eigth argument applied.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Hash.html b/javadoc/5.0/functionaljava/fj/Hash.html new file mode 100644 index 0000000..13630a0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Hash.html @@ -0,0 +1,1280 @@ + + + + + +Hash (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Hash<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Hash<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Hash<A>
+extends java.lang.Object
    +
    Produces a hash code for an object which should attempt uniqueness.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanHash

        +
        public static final Hash<java.lang.Boolean> booleanHash
        +
        A hash instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteHash

        +
        public static final Hash<java.lang.Byte> byteHash
        +
        A hash instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charHash

        +
        public static final Hash<java.lang.Character> charHash
        +
        A hash instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleHash

        +
        public static final Hash<java.lang.Double> doubleHash
        +
        A hash instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatHash

        +
        public static final Hash<java.lang.Float> floatHash
        +
        A hash instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intHash

        +
        public static final Hash<java.lang.Integer> intHash
        +
        A hash instance for the int type.
        +
        • +
      + + + +
        +
      • +

        longHash

        +
        public static final Hash<java.lang.Long> longHash
        +
        A hash instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortHash

        +
        public static final Hash<java.lang.Short> shortHash
        +
        A hash instance for the short type.
        +
        • +
      + + + +
        +
      • +

        bigintHash

        +
        public static final Hash<java.math.BigInteger> bigintHash
        +
        A hash instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalHash

        +
        public static final Hash<java.math.BigDecimal> bigdecimalHash
        +
        A hash instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        naturalHash

        +
        public static final Hash<Natural> naturalHash
        +
        A hash instance for the Natural type.
        +
        • +
      + + + +
        +
      • +

        stringHash

        +
        public static final Hash<java.lang.String> stringHash
        +
        A hash instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferHash

        +
        public static final Hash<java.lang.StringBuffer> stringBufferHash
        +
        A hash instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderHash

        +
        public static final Hash<java.lang.StringBuilder> stringBuilderHash
        +
        A hash instance for the StringBuilder type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value.
        +
        +
        Parameters:
        +
        a - The value to compute the hash value for.
        +
        Returns:
        +
        The hash value.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Hash<B> contramap(F<B,A> g)
        +
        Maps the given function across this hash as a contra-variant functor.
        +
        +
        Parameters:
        +
        g - The function to map.
        +
        Returns:
        +
        A new hash.
        +
        +
        • +
      + + + +
        +
      • +

        hash

        +
        public static <A> Hash<A> hash(F<A,java.lang.Integer> f)
        +
        Construct a hash with the given hash function.
        +
        +
        Parameters:
        +
        f - The function to construct the hash with.
        +
        Returns:
        +
        A hash that uses the given function.
        +
        +
        • +
      + + + +
        +
      • +

        anyHash

        +
        public static <A> Hash<A> anyHash()
        +
        A hash that uses Object.hashCode().
        +
        +
        Returns:
        +
        A hash that uses Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        eitherHash

        +
        public static <A,B> Hash<Either<A,B>> eitherHash(Hash<A> ha,
+                                                 Hash<B> hb)
        +
        A hash instance for the Either type.
        +
        +
        Parameters:
        +
        ha - Hash the left side of Either.
        +
        hb - Hash the right side of Either.
        +
        Returns:
        +
        A hash instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        either3Hash

        +
        public static <A,B,C> Hash<Either3<A,B,C>> either3Hash(Hash<A> ha,
+                                                       Hash<B> hb,
+                                                       Hash<C> hc)
        +
        • +
      + + + +
        +
      • +

        resultHash

        +
        public static <I,A> Hash<Result<I,A>> resultHash(Hash<A> ha,
+                                                 Hash<I> hi)
        +
        A hash instance for the Result type.
        +
        +
        Parameters:
        +
        ha - Hash the Result value.
        +
        hi - Hash the Result remainder.
        +
        Returns:
        +
        A hash instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationHash

        +
        public static <A,B> Hash<Validation<A,B>> validationHash(Hash<A> ha,
+                                                         Hash<B> hb)
        +
        A hash instance for the Validation type.
        +
        +
        Parameters:
        +
        ha - Hash the failing side of Validation.
        +
        hb - Hash the succeeding side of Validation.
        +
        Returns:
        +
        A hash instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listHash

        +
        public static <A> Hash<List<A>> listHash(Hash<A> ha)
        +
        A hash instance for the List type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the list.
        +
        Returns:
        +
        A hash instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListHash

        +
        public static <A> Hash<NonEmptyList<A>> nonEmptyListHash(Hash<A> ha)
        +
        A hash instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the non-empty list.
        +
        Returns:
        +
        A hash instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        optionHash

        +
        public static <A> Hash<Option<A>> optionHash(Hash<A> ha)
        +
        A hash instance for the Option type.
        +
        +
        Parameters:
        +
        ha - A hash for the element of the optional value.
        +
        Returns:
        +
        A hash instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        seqHash

        +
        public static <A> Hash<Seq<A>> seqHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        setHash

        +
        public static <A> Hash<Set<A>> setHash(Hash<A> h)
        +
        • +
      + + + +
        +
      • +

        streamHash

        +
        public static <A> Hash<Stream<A>> streamHash(Hash<A> ha)
        +
        A hash instance for the Stream type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the stream.
        +
        Returns:
        +
        A hash instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayHash

        +
        public static <A> Hash<Array<A>> arrayHash(Hash<A> ha)
        +
        A hash instance for the Array type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the array.
        +
        Returns:
        +
        A hash instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        zipperHash

        +
        public static <A> Hash<Zipper<A>> zipperHash(Hash<A> ha)
        +
        A hash instance for the Zipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the zipper.
        +
        Returns:
        +
        A hash instance for the Zipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipperHash

        +
        public static <A> Hash<TreeZipper<A>> treeZipperHash(Hash<A> ha)
        +
        A hash instance for the TreeZipper type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree zipper.
        +
        Returns:
        +
        A hash instance for the TreeZipper type.
        +
        +
        • +
      + + + +
        +
      • +

        treeHash

        +
        public static <A> Hash<Tree<A>> treeHash(Hash<A> ha)
        +
        A hash instance for the Tree type.
        +
        +
        Parameters:
        +
        ha - A hash for the elements of the tree.
        +
        Returns:
        +
        A hash instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapHash

        +
        public static <K,V> Hash<TreeMap<K,V>> treeMapHash(Hash<K> h,
+                                                   Hash<V> v)
        +
        • +
      + + + +
        +
      • +

        p1Hash

        +
        public static <A> Hash<P1<A>> p1Hash(Hash<A> ha)
        +
        A hash instance for a product-1.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        Returns:
        +
        A hash instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Hash

        +
        public static <A,B> Hash<P2<A,B>> p2Hash(Hash<A> ha,
+                                         Hash<B> hb)
        +
        A hash instance for a product-2.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        Returns:
        +
        A hash instance for a product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3Hash

        +
        public static <A,B,C> Hash<P3<A,B,C>> p3Hash(Hash<A> ha,
+                                             Hash<B> hb,
+                                             Hash<C> hc)
        +
        A hash instance for a product-3.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        Returns:
        +
        A hash instance for a product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4Hash

        +
        public static <A,B,C,D> Hash<P4<A,B,C,D>> p4Hash(Hash<A> ha,
+                                                 Hash<B> hb,
+                                                 Hash<C> hc,
+                                                 Hash<D> hd)
        +
        A hash instance for a product-4.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        Returns:
        +
        A hash instance for a product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5Hash

        +
        public static <A,B,C,D,E> Hash<P5<A,B,C,D,E>> p5Hash(Hash<A> ha,
+                                                     Hash<B> hb,
+                                                     Hash<C> hc,
+                                                     Hash<D> hd,
+                                                     Hash<E> he)
        +
        A hash instance for a product-5.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        Returns:
        +
        A hash instance for a product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6Hash

        +
        public static <A,B,C,D,E,F$> Hash<P6<A,B,C,D,E,F$>> p6Hash(Hash<A> ha,
+                                                           Hash<B> hb,
+                                                           Hash<C> hc,
+                                                           Hash<D> hd,
+                                                           Hash<E> he,
+                                                           Hash<F$> hf)
        +
        A hash instance for a product-6.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        Returns:
        +
        A hash instance for a product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7Hash

        +
        public static <A,B,C,D,E,F$,G> Hash<P7<A,B,C,D,E,F$,G>> p7Hash(Hash<A> ha,
+                                                               Hash<B> hb,
+                                                               Hash<C> hc,
+                                                               Hash<D> hd,
+                                                               Hash<E> he,
+                                                               Hash<F$> hf,
+                                                               Hash<G> hg)
        +
        A hash instance for a product-7.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        Returns:
        +
        A hash instance for a product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8Hash

        +
        public static <A,B,C,D,E,F$,G,H> Hash<P8<A,B,C,D,E,F$,G,H>> p8Hash(Hash<A> ha,
+                                                                   Hash<B> hb,
+                                                                   Hash<C> hc,
+                                                                   Hash<D> hd,
+                                                                   Hash<E> he,
+                                                                   Hash<F$> hf,
+                                                                   Hash<G> hg,
+                                                                   Hash<H> hh)
        +
        A hash instance for a product-8.
        +
        +
        Parameters:
        +
        ha - A hash for the first element of the product.
        +
        hb - A hash for the second element of the product.
        +
        hc - A hash for the third element of the product.
        +
        hd - A hash for the fourth element of the product.
        +
        he - A hash for the fifth element of the product.
        +
        hf - A hash for the sixth element of the product.
        +
        hg - A hash for the seventh element of the product.
        +
        hh - A hash for the eighth element of the product.
        +
        Returns:
        +
        A hash instance for a product-8.
        +
        +
        • +
      + + + +
        +
      • +

        v2Hash

        +
        public static <A> Hash<V2<A>> v2Hash(Hash<A> ea)
        +
        A hash instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Hash

        +
        public static <A> Hash<V3<A>> v3Hash(Hash<A> ea)
        +
        A hash instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Hash

        +
        public static <A> Hash<V4<A>> v4Hash(Hash<A> ea)
        +
        A hash instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Hash

        +
        public static <A> Hash<V5<A>> v5Hash(Hash<A> ea)
        +
        A hash instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Hash

        +
        public static <A> Hash<V6<A>> v6Hash(Hash<A> ea)
        +
        A hash instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Hash

        +
        public static <A> Hash<V7<A>> v7Hash(Hash<A> ea)
        +
        A hash instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Hash

        +
        public static <A> Hash<V8<A>> v8Hash(Hash<A> ea)
        +
        A hash instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A hash for the elements of the vector.
        +
        Returns:
        +
        A hash instance for a vector-8.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/LcgRng.html b/javadoc/5.0/functionaljava/fj/LcgRng.html new file mode 100644 index 0000000..f3ca653 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/LcgRng.html @@ -0,0 +1,327 @@ + + + + + +LcgRng (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class LcgRng

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    +
    public class LcgRng
+extends Rng
    +
    https://en.wikipedia.org/wiki/Linear_congruential_generator
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      LcgRng() 
      LcgRng(long s) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng()
        +
        • +
      + + + +
        +
      • +

        LcgRng

        +
        public LcgRng(long s)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSeed

        +
        public final long getSeed()
        +
        • +
      + + + +
        +
      • +

        nextInt

        +
        public final P2<Rng,java.lang.Integer> nextInt()
        +
        +
        Specified by:
        +
        nextInt in class Rng
        +
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public final P2<Rng,java.lang.Long> nextLong()
        +
        +
        Specified by:
        +
        nextLong in class Rng
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Monoid.AltDefinition.html b/javadoc/5.0/functionaljava/fj/Monoid.AltDefinition.html new file mode 100644 index 0000000..edcc3ac --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Monoid.AltDefinition.html @@ -0,0 +1,262 @@ + + + + + +Monoid.AltDefinition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Monoid.Definition.html b/javadoc/5.0/functionaljava/fj/Monoid.Definition.html new file mode 100644 index 0000000..2ee1f76 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Monoid.Definition.html @@ -0,0 +1,328 @@ + + + + + +Monoid.Definition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Monoid.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Monoid.html b/javadoc/5.0/functionaljava/fj/Monoid.html new file mode 100644 index 0000000..6fe7a52 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Monoid.html @@ -0,0 +1,1343 @@ + + + + + +Monoid (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Monoid<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Monoid<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Monoid<A>
+extends java.lang.Object
    +
    A monoid abstraction to be defined across types of the given type argument. Implementations must + follow the monoidal laws: +
      +
    • Left Identity; forall x. sum(zero(), x) == x
      • +
    • Right Identity; forall x. sum(x, zero()) == x
      • +
    • Associativity; forall x y z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionMonoid

        +
        public static final Monoid<java.lang.Integer> intAdditionMonoid
        +
        A monoid that adds integers.
        +
        • +
      + + + +
        +
      • +

        intMultiplicationMonoid

        +
        public static final Monoid<java.lang.Integer> intMultiplicationMonoid
        +
        A monoid that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        bigintAdditionMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintAdditionMonoid
        +
        A monoid that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationMonoid

        +
        public static final Monoid<java.math.BigInteger> bigintMultiplicationMonoid
        +
        A monoid that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalAdditionMonoid
        +
        A monoid that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationMonoid

        +
        public static final Monoid<java.math.BigDecimal> bigdecimalMultiplicationMonoid
        +
        A monoid that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionMonoid

        +
        public static final Monoid<Natural> naturalAdditionMonoid
        +
        A monoid that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationMonoid

        +
        public static final Monoid<Natural> naturalMultiplicationMonoid
        +
        A monoid that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionMonoid

        +
        public static final Monoid<java.lang.Long> longAdditionMonoid
        +
        A monoid that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationMonoid

        +
        public static final Monoid<java.lang.Long> longMultiplicationMonoid
        +
        A monoid that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> disjunctionMonoid
        +
        A monoid that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> exclusiveDisjunctionMonoid
        +
        A monoid that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionMonoid

        +
        public static final Monoid<java.lang.Boolean> conjunctionMonoid
        +
        A monoid that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringMonoid

        +
        public static final Monoid<java.lang.String> stringMonoid
        +
        A monoid that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferMonoid

        +
        public static final Monoid<java.lang.StringBuffer> stringBufferMonoid
        +
        A monoid that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderMonoid

        +
        public static final Monoid<java.lang.StringBuilder> stringBuilderMonoid
        +
        A monoid that appends string builders.
        +
        • +
      + + + +
        +
      • +

        intMaxMonoid

        +
        public static final Monoid<java.lang.Integer> intMaxMonoid
        +
        A monoid for the maximum of two integers.
        +
        • +
      + + + +
        +
      • +

        intMinMonoid

        +
        public static final Monoid<java.lang.Integer> intMinMonoid
        +
        A monoid for the minimum of two integers.
        +
        • +
      + + + +
        +
      • +

        unitMonoid

        +
        public static final Monoid<Unit> unitMonoid
        +
        A monoid for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compose

        +
        public <B> Monoid<P2<A,B>> compose(Monoid<B> m)
        +
        Composes this monoid with another.
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public Semigroup<A> semigroup()
        +
        Returns a semigroup projection of this monoid.
        +
        +
        Returns:
        +
        A semigroup projection of this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Monoid<B> xmap(F<A,B> f,
+                          F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + +
        +
      • +

        compose

        +
        public <B,C> Monoid<C> compose(Monoid<B> mb,
+                               F<C,A> a,
+                               F<C,B> b,
+                               F2<A,B,C> c)
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this monoid.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this monoid.
        +
        +
        Returns:
        +
        A function that sums according to this monoid.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public A zero()
        +
        The zero value for this monoid.
        +
        +
        Returns:
        +
        The zero value for this monoid.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply

        +
        public A multiply(int n,
+                  A a)
        +
        Returns a value summed n times (a + a + ... + a). + The default definition uses peasant multiplication, exploiting + associativity to only require O(log n) uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(List<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public A sumRight(Stream<A> as)
        +
        Sums the given values with right-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(List<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public A sumLeft(Stream<A> as)
        +
        Sums the given values with left-fold.
        +
        +
        Parameters:
        +
        as - The values to sum.
        +
        Returns:
        +
        The sum of the given values.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeft

        +
        public F<List<A>,A> sumLeft()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumRight

        +
        public F<List<A>,A> sumRight()
        +
        Returns a function that sums the given values with right-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with right-fold.
        +
        +
        • +
      + + + +
        +
      • +

        sumLeftS

        +
        public F<Stream<A>,A> sumLeftS()
        +
        Returns a function that sums the given values with left-fold.
        +
        +
        Returns:
        +
        a function that sums the given values with left-fold.
        +
        +
        • +
      + + + + + +
        +
      • +

        join

        +
        public A join(java.lang.Iterable<A> as,
+              A a)
        +
        Intersperses the given value between each two elements of the iterable, and sums the result.
        +
        +
        Parameters:
        +
        as - An iterable of values to sum.
        +
        a - The value to intersperse between values of the given iterable.
        +
        Returns:
        +
        The sum of the given values and the interspersed value.
        +
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Monoid<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.Definition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Monoid.AltDefinition<A> def)
        +
        Constructs a monoid from the given definition, which must follow the monoidal + laws.
        +
        +
        Parameters:
        +
        def - The definition for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.Definition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoidDef

        +
        public static <A> Monoid<A> monoidDef(Semigroup.AltDefinition<A> s,
+                                      A zero)
        +
        Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        s - The semigroup definition for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F<A,F<A,A>> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + + + +
        +
      • +

        monoid

        +
        public static <A> Monoid<A> monoid(F2<A,A,A> sum,
+                                   A zero)
        +
        Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws. + + Java 8+ users: use monoidDef(Semigroup.Definition, Object) instead.
        +
        +
        Parameters:
        +
        sum - The sum function for the monoid.
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        functionMonoid

        +
        public static <A,B> Monoid<F<A,B>> functionMonoid(Monoid<B> mb)
        +
        A monoid for functions.
        +
        +
        Parameters:
        +
        mb - The monoid for the function codomain.
        +
        Returns:
        +
        A monoid for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listMonoid

        +
        public static <A> Monoid<List<A>> listMonoid()
        +
        A monoid for lists.
        +
        +
        Returns:
        +
        A monoid for lists.
        +
        +
        • +
      + + + +
        +
      • +

        optionMonoid

        +
        public static <A> Monoid<Option<A>> optionMonoid(Semigroup<A> aSemigroup)
        +
        Lift a Semigroup<A> for A to a Monoid<Option<A>>, using Option.none() as zero.
        +
        +
        Returns:
        +
        A monoid for option.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionMonoid

        +
        public static <A> Monoid<Option<A>> firstOptionMonoid()
        +
        A monoid for options that take the first available value.
        +
        +
        Returns:
        +
        A monoid for options that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionMonoid

        +
        public static <A> Monoid<Option<A>> lastOptionMonoid()
        +
        A monoid for options that take the last available value.
        +
        +
        Returns:
        +
        A monoid for options that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamMonoid

        +
        public static <A> Monoid<Stream<A>> streamMonoid()
        +
        A monoid for streams.
        +
        +
        Returns:
        +
        A monoid for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arrayMonoid

        +
        public static <A> Monoid<Array<A>> arrayMonoid()
        +
        A monoid for arrays.
        +
        +
        Returns:
        +
        A monoid for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        ioMonoid

        +
        public static <A> Monoid<IO<A>> ioMonoid(Monoid<A> ma)
        +
        A monoid for IO values.
        +
        • +
      + + + +
        +
      • +

        setMonoid

        +
        public static <A> Monoid<Set<A>> setMonoid(Ord<A> o)
        +
        A union monoid for sets.
        +
        +
        Parameters:
        +
        o - An order for set elements.
        +
        Returns:
        +
        A monoid for sets whose elements have the given order.
        +
        +
        • +
      + + + +
        +
      • +

        setIntersectionMonoid

        +
        public static <A> Monoid<Set<A>> setIntersectionMonoid(Bounded<A> bounded,
+                                                       Enumerator<A> enumerator)
        +
        A intersection monoid for sets.
        +
        +
        Parameters:
        +
        bounded - A bound for all possible elements
        +
        enumerator - An enumerator for all possible elements
        +
        Returns:
        +
        A monoid for sets whose elements have the given order.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Ord.AltDefinition.html b/javadoc/5.0/functionaljava/fj/Ord.AltDefinition.html new file mode 100644 index 0000000..2eff0ed --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Ord.AltDefinition.html @@ -0,0 +1,297 @@ + + + + + +Ord.AltDefinition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.AltDefinition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Ord.Definition.html b/javadoc/5.0/functionaljava/fj/Ord.Definition.html new file mode 100644 index 0000000..56c3c93 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Ord.Definition.html @@ -0,0 +1,426 @@ + + + + + +Ord.Definition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Ord.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Ord.html b/javadoc/5.0/functionaljava/fj/Ord.html new file mode 100644 index 0000000..0f61b08 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Ord.html @@ -0,0 +1,1409 @@ + + + + + +Ord (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Ord<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Ord<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Ord<A>
+extends java.lang.Object
    +
    Tests for ordering between two objects.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface Ord.AltDefinition<A> +
      Primitives functions of Ord: alternative minimal definition and overridable methods.
      +
      static interface Ord.Definition<A> +
      Primitives functions of Ord: minimal definition and overridable methods.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static Ord<java.math.BigDecimal>bigdecimalOrd +
      An order instance for the BigDecimal type.
      +
      static Ord<java.math.BigInteger>bigintOrd +
      An order instance for the BigInteger type.
      +
      static Ord<java.lang.Boolean>booleanOrd +
      An order instance for the boolean type.
      +
      static Ord<java.lang.Byte>byteOrd +
      An order instance for the byte type.
      +
      static Ord<java.lang.Character>charOrd +
      An order instance for the char type.
      +
      static Ord<java.lang.Double>doubleOrd +
      An order instance for the double type.
      +
      static Ord<java.lang.Float>floatOrd +
      An order instance for the float type.
      +
      static Ord<java.lang.Integer>intOrd +
      An order instance for the int type.
      +
      static Ord<java.lang.Long>longOrd +
      An order instance for the long type.
      +
      F<A,F<A,A>>max +
      A function that returns the greater of its two arguments.
      +
      F<A,F<A,A>>min +
      A function that returns the lesser of its two arguments.
      +
      static Ord<Natural>naturalOrd +
      An order instance for the Natural type.
      +
      static Ord<Ordering>orderingOrd +
      An order instance for the Ordering type.
      +
      static Ord<java.lang.Short>shortOrd +
      An order instance for the short type.
      +
      static Ord<java.lang.StringBuffer>stringBufferOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.StringBuilder>stringBuilderOrd +
      An order instance for the StringBuffer type.
      +
      static Ord<java.lang.String>stringOrd +
      An order instance for the String type.
      +
      static Ord<Unit>unitOrd +
      An order instance for the Unit type.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Ord<Array<A>>arrayOrd(Ord<A> oa) +
      An order instance for the Array type.
      +
      static <A extends java.lang.Comparable<A>>
      Ord<A>      		comparableOrd() +
      An order instance for the Comparable interface.
      +
      F<A,F<A,Ordering>>compare() +
      First-class ordering.
      +
      Orderingcompare(A a1, + A a2) +
      Returns an ordering for the given arguments.
      +
      static <A,B> Ord<A>contramap(F<A,B> f, + Ord<B> ord) +
      Static version of contramap(F)
      +
      <B> Ord<B>contramap(F<B,A> f) +
      Maps the given function across this ord as a contra-variant functor.
      +
      static <A,B> Ord<Either<A,B>>eitherOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Either type.
      +
      booleaneq(A a1, + A a2) +
      Returns true if the given arguments are equal, false otherwise.
      +
      Equal<A>equal() +
      Returns an Equal for this order.
      +
      F<A,java.lang.Boolean>isGreaterThan(A a) +
      Returns a function that returns true if its argument is greater than than the argument to this method.
      +
      booleanisGreaterThan(A a1, + A a2) +
      Returns true if the first given argument is greater than the second given + argument, false otherwise.
      +
      F<A,java.lang.Boolean>isLessThan(A a) +
      Returns a function that returns true if its argument is less than the argument to this method.
      +
      booleanisLessThan(A a1, + A a2) +
      Returns true if the first given argument is less than the second given argument, + false otherwise.
      +
      booleanisLessThanOrEqualTo(A a1, + A a2) +
      Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
      +
      static <A> Ord<List<A>>listOrd(Ord<A> oa) +
      An order instance for the List type.
      +
      Amax(A a1, + A a2) +
      Returns the greater of its two arguments.
      +
      Monoid<A>maxMonoid(A zero) 
      Semigroup<A>maxSemigroup() 
      Amin(A a1, + A a2) +
      Returns the lesser of its two arguments.
      +
      Monoid<A>minMonoid(A zero) 
      Semigroup<A>minSemigroup() 
      static <A> Ord<NonEmptyList<A>>nonEmptyListOrd(Ord<A> oa) +
      An order instance for the NonEmptyList type.
      +
      static <A,B> Ord.Definition<A>on(F<A,B> f, + Ord<B> ord) +
      Begin definition of an ord instance.
      +
      static <A> Ord<Option<A>>optionOrd(Ord<A> oa) +
      An order instance for the Option type.
      +
      static <A> Ord<A>ord(F<A,F<A,Ordering>> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ord(F2<A,A,Ordering> f) +
      Returns an order instance that uses the given equality test and ordering function.
      +
      static <A> Ord<A>ordDef(Ord.AltDefinition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<A>ordDef(Ord.Definition<A> def) +
      Returns an order instance that uses the given minimal equality test and ordering definition.
      +
      static <A> Ord<P1<A>>p1Ord(Ord<A> oa) +
      An order instance for a product-1.
      +
      static <A,B> Ord<P2<A,B>>p2Ord(Ord<A> oa, + Ord<B> ob) +
      An order instance for a product-2, with the first factor considered most significant.
      +
      static <A,B> Ord<P2<A,B>>p2Ord1(Ord<A> oa) 
      static <A,B> Ord<P2<A,B>>p2Ord2(Ord<B> ob) 
      static <A,B,C> Ord<P3<A,B,C>>p3Ord(Ord<A> oa, + Ord<B> ob, + Ord<C> oc) +
      An order instance for a product-3, with the first factor considered most significant.
      +
      Ord<A>reverse() 
      static <A> Ord<Seq<A>>seqOrd(Ord<A> ord) +
      Return a seq ord using the given value ord.
      +
      static <A> Ord<Set<A>>setOrd(Ord<A> oa) +
      An order instance for the Set type.
      +
      static <A> Ord<Stream<A>>streamOrd(Ord<A> oa) +
      An order instance for the Stream type.
      +
      java.util.Comparator<A>toComparator() 
      static <A,B> Ord<Validation<A,B>>validationOrd(Ord<A> oa, + Ord<B> ob) +
      An order instance for the Validation type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        max

        +
        public final F<A,F<A,A>> max
        +
        A function that returns the greater of its two arguments.
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final F<A,F<A,A>> min
        +
        A function that returns the lesser of its two arguments.
        +
        • +
      + + + +
        +
      • +

        booleanOrd

        +
        public static final Ord<java.lang.Boolean> booleanOrd
        +
        An order instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteOrd

        +
        public static final Ord<java.lang.Byte> byteOrd
        +
        An order instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charOrd

        +
        public static final Ord<java.lang.Character> charOrd
        +
        An order instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleOrd

        +
        public static final Ord<java.lang.Double> doubleOrd
        +
        An order instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatOrd

        +
        public static final Ord<java.lang.Float> floatOrd
        +
        An order instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intOrd

        +
        public static final Ord<java.lang.Integer> intOrd
        +
        An order instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintOrd

        +
        public static final Ord<java.math.BigInteger> bigintOrd
        +
        An order instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalOrd

        +
        public static final Ord<java.math.BigDecimal> bigdecimalOrd
        +
        An order instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longOrd

        +
        public static final Ord<java.lang.Long> longOrd
        +
        An order instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortOrd

        +
        public static final Ord<java.lang.Short> shortOrd
        +
        An order instance for the short type.
        +
        • +
      + + + +
        +
      • +

        orderingOrd

        +
        public static final Ord<Ordering> orderingOrd
        +
        An order instance for the Ordering type.
        +
        • +
      + + + +
        +
      • +

        stringOrd

        +
        public static final Ord<java.lang.String> stringOrd
        +
        An order instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferOrd

        +
        public static final Ord<java.lang.StringBuffer> stringBufferOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderOrd

        +
        public static final Ord<java.lang.StringBuilder> stringBuilderOrd
        +
        An order instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        unitOrd

        +
        public static final Ord<Unit> unitOrd
        +
        An order instance for the Unit type.
        +
        • +
      + + + +
        +
      • +

        naturalOrd

        +
        public static final Ord<Natural> naturalOrd
        +
        An order instance for the Natural type.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public F<A,F<A,Ordering>> compare()
        +
        First-class ordering.
        +
        +
        Returns:
        +
        A function that returns an ordering for its arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        compare

        +
        public Ordering compare(A a1,
+                        A a2)
        +
        Returns an ordering for the given arguments.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        An ordering for the given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Returns true if the given arguments are equal, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for equality to another.
        +
        a2 - An instance to compare for equality to another.
        +
        Returns:
        +
        true if the given arguments are equal, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equal

        +
        public Equal<A> equal()
        +
        Returns an Equal for this order.
        +
        +
        Returns:
        +
        An Equal for this order.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Ord<B> contramap(F<B,A> f)
        +
        Maps the given function across this ord as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new ord.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(A a1,
+                          A a2)
        +
        Returns true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThanOrEqualTo

        +
        public boolean isLessThanOrEqualTo(A a1,
+                                   A a2)
        +
        Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is less than or equal to the second given argument, + false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(A a1,
+                             A a2)
        +
        Returns true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        Parameters:
        +
        a1 - An instance to compare for ordering to another.
        +
        a2 - An instance to compare for ordering to another.
        +
        Returns:
        +
        true if the first given argument is greater than the second given + argument, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public F<A,java.lang.Boolean> isLessThan(A a)
        +
        Returns a function that returns true if its argument is less than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is less than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public F<A,java.lang.Boolean> isGreaterThan(A a)
        +
        Returns a function that returns true if its argument is greater than than the argument to this method.
        +
        +
        Parameters:
        +
        a - A value to compare against.
        +
        Returns:
        +
        A function that returns true if its argument is greater than the argument to this method.
        +
        +
        • +
      + + + + + +
        +
      • +

        max

        +
        public A max(A a1,
+             A a2)
        +
        Returns the greater of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The greater of the two values.
        +
        +
        • +
      + + + + + +
        +
      • +

        min

        +
        public A min(A a1,
+             A a2)
        +
        Returns the lesser of its two arguments.
        +
        +
        Parameters:
        +
        a1 - A value to compare with another.
        +
        a2 - A value to compare with another.
        +
        Returns:
        +
        The lesser of the two values.
        +
        +
        • +
      + + + +
        +
      • +

        minSemigroup

        +
        public final Semigroup<A> minSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        minMonoid

        +
        public final Monoid<A> minMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        maxSemigroup

        +
        public final Semigroup<A> maxSemigroup()
        +
        • +
      + + + + + +
        +
      • +

        maxMonoid

        +
        public final Monoid<A> maxMonoid(A zero)
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Ord<A> reverse()
        +
        • +
      + + + + + + + +
        +
      • +

        contramap

        +
        public static <A,B> Ord<A> contramap(F<A,B> f,
+                                     Ord<B> ord)
        +
        Static version of contramap(F)
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F<A,F<A,Ordering>> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(Definition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<A> ord(F2<A,A,Ordering> f)
        +
        Returns an order instance that uses the given equality test and ordering function. + + Java 8+ users: use ordDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        f - The order function.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.Definition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        ordDef

        +
        public static <A> Ord<A> ordDef(Ord.AltDefinition<A> def)
        +
        Returns an order instance that uses the given minimal equality test and ordering definition.
        +
        +
        Parameters:
        +
        def - The order definition.
        +
        Returns:
        +
        An order instance.
        +
        +
        • +
      + + + +
        +
      • +

        optionOrd

        +
        public static <A> Ord<Option<A>> optionOrd(Ord<A> oa)
        +
        An order instance for the Option type.
        +
        +
        Parameters:
        +
        oa - Order across the element of the option.
        +
        Returns:
        +
        An order instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherOrd

        +
        public static <A,B> Ord<Either<A,B>> eitherOrd(Ord<A> oa,
+                                               Ord<B> ob)
        +
        An order instance for the Either type.
        +
        +
        Parameters:
        +
        oa - Order across the left side of Either.
        +
        ob - Order across the right side of Either.
        +
        Returns:
        +
        An order instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        validationOrd

        +
        public static <A,B> Ord<Validation<A,B>> validationOrd(Ord<A> oa,
+                                                       Ord<B> ob)
        +
        An order instance for the Validation type.
        +
        +
        Parameters:
        +
        oa - Order across the failing side of Validation.
        +
        ob - Order across the succeeding side of Validation.
        +
        Returns:
        +
        An order instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listOrd

        +
        public static <A> Ord<List<A>> listOrd(Ord<A> oa)
        +
        An order instance for the List type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the list.
        +
        Returns:
        +
        An order instance for the List type.
        +
        +
        • +
      + + + +
        +
      • +

        seqOrd

        +
        public static <A> Ord<Seq<A>> seqOrd(Ord<A> ord)
        +
        Return a seq ord using the given value ord.
        +
        +
        Type Parameters:
        +
        A - the type of the seq value
        +
        Parameters:
        +
        ord - the given value ord
        +
        Returns:
        +
        the seq ord
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListOrd

        +
        public static <A> Ord<NonEmptyList<A>> nonEmptyListOrd(Ord<A> oa)
        +
        An order instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the non-empty list.
        +
        Returns:
        +
        An order instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        streamOrd

        +
        public static <A> Ord<Stream<A>> streamOrd(Ord<A> oa)
        +
        An order instance for the Stream type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the stream.
        +
        Returns:
        +
        An order instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        arrayOrd

        +
        public static <A> Ord<Array<A>> arrayOrd(Ord<A> oa)
        +
        An order instance for the Array type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the array.
        +
        Returns:
        +
        An order instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        setOrd

        +
        public static <A> Ord<Set<A>> setOrd(Ord<A> oa)
        +
        An order instance for the Set type.
        +
        +
        Parameters:
        +
        oa - Order across the elements of the set.
        +
        Returns:
        +
        An order instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Ord

        +
        public static <A> Ord<P1<A>> p1Ord(Ord<A> oa)
        +
        An order instance for a product-1.
        +
        +
        Parameters:
        +
        oa - Order across the produced type.
        +
        Returns:
        +
        An order instance for a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord

        +
        public static <A,B> Ord<P2<A,B>> p2Ord(Ord<A> oa,
+                                       Ord<B> ob)
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        Returns:
        +
        An order instance for a product-2, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        p2Ord1

        +
        public static <A,B> Ord<P2<A,B>> p2Ord1(Ord<A> oa)
        +
        • +
      + + + +
        +
      • +

        p2Ord2

        +
        public static <A,B> Ord<P2<A,B>> p2Ord2(Ord<B> ob)
        +
        • +
      + + + +
        +
      • +

        p3Ord

        +
        public static <A,B,C> Ord<P3<A,B,C>> p3Ord(Ord<A> oa,
+                                           Ord<B> ob,
+                                           Ord<C> oc)
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        Parameters:
        +
        oa - An order instance for the first factor.
        +
        ob - An order instance for the second factor.
        +
        oc - An order instance for the third factor.
        +
        Returns:
        +
        An order instance for a product-3, with the first factor considered most significant.
        +
        +
        • +
      + + + +
        +
      • +

        comparableOrd

        +
        public static <A extends java.lang.Comparable<A>> Ord<A> comparableOrd()
        +
        An order instance for the Comparable interface.
        +
        +
        Returns:
        +
        An order instance for the Comparable interface.
        +
        +
        • +
      + + + +
        +
      • +

        toComparator

        +
        public java.util.Comparator<A> toComparator()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Ordering.html b/javadoc/5.0/functionaljava/fj/Ordering.html new file mode 100644 index 0000000..76e01f9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Ordering.html @@ -0,0 +1,400 @@ + + + + + +Ordering (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Enum Ordering

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<Ordering>
      • +
    • +
        +
      • fj.Ordering
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Ordering>
    +
    +
    +
    +
    public enum Ordering
+extends java.lang.Enum<Ordering>
    +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EQ +
      Equal.
      +
      GT +
      Greater than.
      +
      LT +
      Less than.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static OrderingfromInt(int cmp) 
      Orderingreverse() 
      inttoInt() 
      static OrderingvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Ordering[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        LT

        +
        public static final Ordering LT
        +
        Less than.
        +
        • +
      + + + +
        +
      • +

        EQ

        +
        public static final Ordering EQ
        +
        Equal.
        +
        • +
      + + + +
        +
      • +

        GT

        +
        public static final Ordering GT
        +
        Greater than.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Ordering[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Ordering c : Ordering.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Ordering valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public int toInt()
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Ordering reverse()
        +
        • +
      + + + +
        +
      • +

        fromInt

        +
        public static Ordering fromInt(int cmp)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P.html b/javadoc/5.0/functionaljava/fj/P.html new file mode 100644 index 0000000..c4c9fa9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P.html @@ -0,0 +1,1072 @@ + + + + + +P (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class P
+extends java.lang.Object
    +
    Functions across products.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> P1<A>hardMemo(F0<A> f) +
      Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
      +
      static <A> P1<A>lazy(F<Unit,A> f) 
      static <A,B> P2<A,B>lazy(F<Unit,A> fa, + F<Unit,B> fb) 
      static <A,B,C> P3<A,B,C>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe) 
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff) 
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg) 
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		lazy(F<Unit,A> fa, + F<Unit,B> fb, + F<Unit,C> fc, + F<Unit,D> fd, + F<Unit,E> fe, + F<Unit,F$> ff, + F<Unit,G> fg, + F<Unit,H> fh) 
      static <A> P1<A>lazy(F0<A> f) +
      Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
      +
      static <A,B> P2<A,B>lazy(F0<A> pa, + F0<B> pb) 
      static <A,B,C> P3<A,B,C>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc) 
      static <A,B,C,D> P4<A,B,C,D>lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd) 
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe) 
      static <A,B,C,D,E,F>
      P6<A,B,C,D,E,F>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf) 
      static <A,B,C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg) 
      static <A,B,C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		lazy(F0<A> pa, + F0<B> pb, + F0<C> pc, + F0<D> pd, + F0<E> pe, + F0<F> pf, + F0<G> pg, + F0<H> ph) 
      static <A,B> P2<A,B>lazyProduct(F0<P2<A,B>> f) 
      static <A> P1<A>memo(F0<A> f) +
      Convert a F0 into a P1, using weak call-by-need semantic using weakMemo(F0).
      +
      static <A> P1<A>p(A a) +
      A function that puts an element in a product-1.
      +
      static <A,B> P2<A,B>p(A a, + B b) +
      A function that puts elements in a product-2.
      +
      static <A,B,C> P3<A,B,C>p(A a, + B b, + C c) +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> P4<A,B,C,D>p(A a, + B b, + C c, + D d) +
      A function that puts elements in a product-4.
      +
      static <A,B,C,D,E>
      P5<A,B,C,D,E>      		p(A a, + B b, + C c, + D d, + E e) +
      A function that puts elements in a product-5.
      +
      static <A,B,C,D,E,F$>
      P6<A,B,C,D,E,F$>      		p(A a, + B b, + C c, + D d, + E e, + F$ f) +
      A function that puts elements in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      P7<A,B,C,D,E,F$,G>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g) +
      A function that puts elements in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      P8<A,B,C,D,E,F$,G,H>      		p(A a, + B b, + C c, + D d, + E e, + F$ f, + G g, + H h) +
      A function that puts elements in a product-8.
      +
      static <A> F<A,P1<A>>p1() +
      A function that puts an element in a product-1.
      +
      static <A,B> F<A,F<B,P2<A,B>>>p2() +
      A function that puts an element in a product-2.
      +
      static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>>p3() +
      A function that puts elements in a product-3.
      +
      static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>>p4() +
      A function that puts an element in a product-4.
      +
      static <A,B,C,D,E>
      F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>>      		p5() +
      A function that puts an element in a product-5.
      +
      static <A,B,C,D,E,F$>
      F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>>      		p6() +
      A function that puts an element in a product-6.
      +
      static <A,B,C,D,E,F$,G>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>>      		p7() +
      A function that puts an element in a product-7.
      +
      static <A,B,C,D,E,F$,G,H>
      F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>>      		p8() +
      A function that puts an element in a product-8.
      +
      static <A> P1<A>softMemo(F0<A> f) +
      Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
      +
      static <A> P1<A>weakMemo(F0<A> f) +
      Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        p1

        +
        public static <A> F<A,P1<A>> p1()
        +
        A function that puts an element in a product-1.
        +
        +
        Returns:
        +
        A function that puts an element in a product-1.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A> P1<A> p(A a)
        +
        A function that puts an element in a product-1.
        +
        +
        Parameters:
        +
        a - The element.
        +
        Returns:
        +
        The product-1.
        +
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public static <A> P1<A> hardMemo(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public static <A> P1<A> weakMemo(F0<A> f)
        +
        Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public static <A> P1<A> softMemo(F0<A> f)
        +
        Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie. to avoid OutOfMemoryErrors).
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public static <A> P1<A> memo(F0<A> f)
        +
        Convert a F0 into a P1, using weak call-by-need semantic using weakMemo(F0).
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F0<A> f)
        +
        Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F0<A> pa,
+                                 F0<B> pb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F0<A> pa,
+                                     F0<B> pb,
+                                     F0<C> pc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F0<A> pa,
+                                         F0<B> pb,
+                                         F0<C> pc,
+                                         F0<D> pd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F0<A> pa,
+                                             F0<B> pb,
+                                             F0<C> pc,
+                                             F0<D> pd,
+                                             F0<E> pe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F> P6<A,B,C,D,E,F> lazy(F0<A> pa,
+                                                 F0<B> pb,
+                                                 F0<C> pc,
+                                                 F0<D> pd,
+                                                 F0<E> pe,
+                                                 F0<F> pf)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G> P7<A,B,C,D,E,F,G> lazy(F0<A> pa,
+                                                     F0<B> pb,
+                                                     F0<C> pc,
+                                                     F0<D> pd,
+                                                     F0<E> pe,
+                                                     F0<F> pf,
+                                                     F0<G> pg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> lazy(F0<A> pa,
+                                                         F0<B> pb,
+                                                         F0<C> pc,
+                                                         F0<D> pd,
+                                                         F0<E> pe,
+                                                         F0<F> pf,
+                                                         F0<G> pg,
+                                                         F0<H> ph)
        +
        • +
      + + + +
        +
      • +

        lazyProduct

        +
        public static <A,B> P2<A,B> lazyProduct(F0<P2<A,B>> f)
        +
        • +
      + + + +
        +
      • +

        p2

        +
        public static <A,B> F<A,F<B,P2<A,B>>> p2()
        +
        A function that puts an element in a product-2.
        +
        +
        Returns:
        +
        A function that puts an element in a product-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B> P2<A,B> p(A a,
+                              B b)
        +
        A function that puts elements in a product-2.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        Returns:
        +
        The product-2.
        +
        +
        • +
      + + + +
        +
      • +

        p3

        +
        public static <A,B,C> F<A,F<B,F<C,P3<A,B,C>>>> p3()
        +
        A function that puts elements in a product-3.
        +
        +
        Returns:
        +
        A function that puts elements in a product-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C> P3<A,B,C> p(A a,
+                                  B b,
+                                  C c)
        +
        A function that puts elements in a product-3.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        Returns:
        +
        The product-3.
        +
        +
        • +
      + + + +
        +
      • +

        p4

        +
        public static <A,B,C,D> F<A,F<B,F<C,F<D,P4<A,B,C,D>>>>> p4()
        +
        A function that puts an element in a product-4.
        +
        +
        Returns:
        +
        A function that puts an element in a product-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D> P4<A,B,C,D> p(A a,
+                                      B b,
+                                      C c,
+                                      D d)
        +
        A function that puts elements in a product-4.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        Returns:
        +
        The product-4.
        +
        +
        • +
      + + + +
        +
      • +

        p5

        +
        public static <A,B,C,D,E> F<A,F<B,F<C,F<D,F<E,P5<A,B,C,D,E>>>>>> p5()
        +
        A function that puts an element in a product-5.
        +
        +
        Returns:
        +
        A function that puts an element in a product-5.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> p(A a,
+                                          B b,
+                                          C c,
+                                          D d,
+                                          E e)
        +
        A function that puts elements in a product-5.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        Returns:
        +
        The product-5.
        +
        +
        • +
      + + + +
        +
      • +

        p6

        +
        public static <A,B,C,D,E,F$> F<A,F<B,F<C,F<D,F<E,F<F$,P6<A,B,C,D,E,F$>>>>>>> p6()
        +
        A function that puts an element in a product-6.
        +
        +
        Returns:
        +
        A function that puts an element in a product-6.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> p(A a,
+                                                B b,
+                                                C c,
+                                                D d,
+                                                E e,
+                                                F$ f)
        +
        A function that puts elements in a product-6.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        Returns:
        +
        The product-6.
        +
        +
        • +
      + + + +
        +
      • +

        p7

        +
        public static <A,B,C,D,E,F$,G> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,P7<A,B,C,D,E,F$,G>>>>>>>> p7()
        +
        A function that puts an element in a product-7.
        +
        +
        Returns:
        +
        A function that puts an element in a product-7.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> p(A a,
+                                                    B b,
+                                                    C c,
+                                                    D d,
+                                                    E e,
+                                                    F$ f,
+                                                    G g)
        +
        A function that puts elements in a product-7.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        Returns:
        +
        The product-7.
        +
        +
        • +
      + + + +
        +
      • +

        p8

        +
        public static <A,B,C,D,E,F$,G,H> F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,P8<A,B,C,D,E,F$,G,H>>>>>>>>> p8()
        +
        A function that puts an element in a product-8.
        +
        +
        Returns:
        +
        A function that puts an element in a product-8.
        +
        +
        • +
      + + + + + +
        +
      • +

        p

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> p(A a,
+                                                        B b,
+                                                        C c,
+                                                        D d,
+                                                        E e,
+                                                        F$ f,
+                                                        G g,
+                                                        H h)
        +
        A function that puts elements in a product-8.
        +
        +
        Parameters:
        +
        a - An element.
        +
        b - An element.
        +
        c - An element.
        +
        d - An element.
        +
        e - An element.
        +
        f - An element.
        +
        g - An element.
        +
        h - An element.
        +
        Returns:
        +
        The product-8.
        +
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> P1<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B> P2<A,B> lazy(F<Unit,A> fa,
+                                 F<Unit,B> fb)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C> P3<A,B,C> lazy(F<Unit,A> fa,
+                                     F<Unit,B> fb,
+                                     F<Unit,C> fc)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D> P4<A,B,C,D> lazy(F<Unit,A> fa,
+                                         F<Unit,B> fb,
+                                         F<Unit,C> fc,
+                                         F<Unit,D> fd)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E> P5<A,B,C,D,E> lazy(F<Unit,A> fa,
+                                             F<Unit,B> fb,
+                                             F<Unit,C> fc,
+                                             F<Unit,D> fd,
+                                             F<Unit,E> fe)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$> P6<A,B,C,D,E,F$> lazy(F<Unit,A> fa,
+                                                   F<Unit,B> fb,
+                                                   F<Unit,C> fc,
+                                                   F<Unit,D> fd,
+                                                   F<Unit,E> fe,
+                                                   F<Unit,F$> ff)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G> P7<A,B,C,D,E,F$,G> lazy(F<Unit,A> fa,
+                                                       F<Unit,B> fb,
+                                                       F<Unit,C> fc,
+                                                       F<Unit,D> fd,
+                                                       F<Unit,E> fe,
+                                                       F<Unit,F$> ff,
+                                                       F<Unit,G> fg)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A,B,C,D,E,F$,G,H> P8<A,B,C,D,E,F$,G,H> lazy(F<Unit,A> fa,
+                                                           F<Unit,B> fb,
+                                                           F<Unit,C> fc,
+                                                           F<Unit,D> fd,
+                                                           F<Unit,E> fe,
+                                                           F<Unit,F$> ff,
+                                                           F<Unit,G> fg,
+                                                           F<Unit,H> fh)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P1.html b/javadoc/5.0/functionaljava/fj/P1.html new file mode 100644 index 0000000..850d30f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P1.html @@ -0,0 +1,891 @@ + + + + + +P1 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P1<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<A>, java.util.function.Supplier<A>
    +
    +
    +
    Direct Known Subclasses:
    +
    $
    +
    +
    +
    +
    public abstract class P1<A>
+extends java.lang.Object
+implements F0<A>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P1() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<P1<A>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      <B> P1<B>apply(P1<F<A,B>> cf) +
      Performs function application within a P1 (applicative functor pattern).
      +
      <B> P1<B>bind(F<A,P1<B>> f) +
      Binds the given function to the value in a product-1 with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B,C> P1<C>bind(P1<B> cb, + F2<A,B,C> f) +
      Binds the given function to the values in the given P1s with a final join.
      +
      <B> F<B,A>constant() +
      Returns a constant function that always uses this value.
      +
      static <A,B> F<A,P1<B>>curry(F<A,B> f) +
      Promotes the given function so that it returns its value in a P1.
      +
      booleanequals(java.lang.Object other) 
      Af() 
      P1<A>hardMemo() +
      Returns a P1 that remembers its value.
      +
      inthashCode() 
      static <A> P1<A>join(P1<P1<A>> a) +
      Joins a P1 of a P1 with a bind operation.
      +
      static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on P1s.
      +
      <B,C> P1<C>liftM2(P1<B> pb, + F2<A,B,C> f) 
      static <A,B> F<P1<A>,P1<B>>map_(F<A,B> f) +
      Promote any function to a transformation between P1s.
      +
      <B> P1<B>map(F<A,B> f) +
      Map the element of the product.
      +
      P1<A>memo() +
      Wrap the memoized value into a WeakReference.
      +
      static <A> P1<Array<A>>sequence(Array<P1<A>> as) +
      Turns an array of P1s into a single P1 of an array.
      +
      static <A> P1<List<A>>sequence(List<P1<A>> as) +
      Turns a List of P1s into a single P1 of a List.
      +
      static <A> P1<Option<A>>sequence(Option<P1<A>> o) +
      Turns an optional P1 into a lazy option.
      +
      static <A> P1<Stream<A>>sequence(Stream<P1<A>> as) +
      Turns a stream of P1s into a single P1 of a stream.
      +
      static <A> F<List<P1<A>>,P1<List<A>>>sequenceList() +
      A first-class version of the sequence method for lists of P1s.
      +
      P1<A>softMemo() +
      Like memo, but the memoized value is wrapped into a SoftReference
      +
      java.lang.StringtoString() 
      <B,X> Either<X,P1<B>>traverseEither(F<A,Either<X,B>> f) +
      Traversable instance of P1 for Either
      +
      <B> List<P1<B>>traverseList(F<A,List<B>> f) +
      Traversable instance of P1 for List
      +
      <B> Option<P1<B>>traverseOption(F<A,Option<B>> f) +
      Traversable instance of P1 for Option
      +
      <B> Stream<P1<B>>traverseStream(F<A,Stream<B>> f) +
      Traversable instance of P1 for Stream
      +
      <B,E> Validation<E,P1<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traversable instance of P1 for Validation
      +
      P1<A>weakMemo() +
      Like memo, but the memoized value is wrapped into a WeakReference
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P1

        +
        public P1()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        public final A f()
        +
        +
        Specified by:
        +
        f in interface F0<A>
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<P1<A>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<P1<A>,P1<B>> map_(F<A,B> f)
        +
        Promote any function to a transformation between P1s.
        +
        +
        Parameters:
        +
        f - A function to promote to a transformation between P1s.
        +
        Returns:
        +
        A function promoted to operate on P1s.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> P1<B> bind(F<A,P1<B>> f)
        +
        Binds the given function to the value in a product-1 with a final join.
        +
        +
        Parameters:
        +
        f - A function to apply to the value in a product-1.
        +
        Returns:
        +
        The result of applying the given function to the value of given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        curry

        +
        public static <A,B> F<A,P1<B>> curry(F<A,B> f)
        +
        Promotes the given function so that it returns its value in a P1.
        +
        +
        Parameters:
        +
        f - A function to have its result wrapped in a P1.
        +
        Returns:
        +
        A function whose result is wrapped in a P1.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> P1<B> apply(P1<F<A,B>> cf)
        +
        Performs function application within a P1 (applicative functor pattern).
        +
        +
        Parameters:
        +
        cf - The P1 function to apply.
        +
        Returns:
        +
        A new P1 after applying the given P1 function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        +
        Parameters:
        +
        cb - A given P1 to bind the given function with.
        +
        f - The function to apply to the values in the given P1s.
        +
        Returns:
        +
        A new P1 after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> P1<C> bind(P1<B> cb,
+                              F2<A,B,C> f)
        +
        Binds the given function to the values in the given P1s with a final join.
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> P1<A> join(P1<P1<A>> a)
        +
        Joins a P1 of a P1 with a bind operation.
        +
        +
        Parameters:
        +
        a - The P1 of a P1 to join.
        +
        Returns:
        +
        A new P1 that is the join of the given P1.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<P1<A>,F<P1<B>,P1<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on P1s.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over P1s.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> P1<C> liftM2(P1<B> pb,
+                                F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<List<A>> sequence(List<P1<A>> as)
        +
        Turns a List of P1s into a single P1 of a List.
        +
        +
        Parameters:
        +
        as - The list of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static <A> F<List<P1<A>>,P1<List<A>>> sequenceList()
        +
        A first-class version of the sequence method for lists of P1s.
        +
        +
        Returns:
        +
        A function from a List of P1s to a single P1 of a List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Stream<A>> sequence(Stream<P1<A>> as)
        +
        Turns a stream of P1s into a single P1 of a stream.
        +
        +
        Parameters:
        +
        as - The stream of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Option<A>> sequence(Option<P1<A>> o)
        +
        Turns an optional P1 into a lazy option.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> P1<Array<A>> sequence(Array<P1<A>> as)
        +
        Turns an array of P1s into a single P1 of an array.
        +
        +
        Parameters:
        +
        as - The array of P1s to transform.
        +
        Returns:
        +
        A single P1 for the given array.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<P1<B>> traverseList(F<A,List<B>> f)
        +
        Traversable instance of P1 for List
        +
        +
        Parameters:
        +
        f - The function that takes A and produces a List (non-deterministic result)
        +
        Returns:
        +
        A List of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,X> Either<X,P1<B>> traverseEither(F<A,Either<X,B>> f)
        +
        Traversable instance of P1 for Either
        +
        +
        Parameters:
        +
        f - The function produces Either
        +
        Returns:
        +
        An Either of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<P1<B>> traverseOption(F<A,Option<B>> f)
        +
        Traversable instance of P1 for Option
        +
        +
        Parameters:
        +
        f - The function that produces Option
        +
        Returns:
        +
        An Option of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <B,E> Validation<E,P1<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traversable instance of P1 for Validation
        +
        +
        Parameters:
        +
        f - The function might produces Validation
        +
        Returns:
        +
        An Validation of P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<P1<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traversable instance of P1 for Stream
        +
        +
        Parameters:
        +
        f - The function that produces Stream
        +
        Returns:
        +
        An Stream of P1
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> P1<B> map(F<A,B> f)
        +
        Map the element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P1<A> memo()
        +
        Wrap the memoized value into a WeakReference.
        +
        • +
      + + + +
        +
      • +

        hardMemo

        +
        public P1<A> hardMemo()
        +
        Returns a P1 that remembers its value.
        +
        +
        Returns:
        +
        A P1 that calls this P1 once and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        weakMemo

        +
        public P1<A> weakMemo()
        +
        Like memo, but the memoized value is wrapped into a WeakReference
        +
        • +
      + + + +
        +
      • +

        softMemo

        +
        public P1<A> softMemo()
        +
        Like memo, but the memoized value is wrapped into a SoftReference
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public final <B> F<B,A> constant()
        +
        Returns a constant function that always uses this value.
        +
        +
        Returns:
        +
        A constant function that always uses this value.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P2.Optic.html b/javadoc/5.0/functionaljava/fj/P2.Optic.html new file mode 100644 index 0000000..1e8b65e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P2.Optic.html @@ -0,0 +1,290 @@ + + + + + +P2.Optic (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class P2.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    P2<A,B>
    +
    +
    +
    +
    public static final class P2.Optic
+extends java.lang.Object
    +
    Optic factory methods for a P2
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Lens<P2<A,B>,A>_1() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C>_1p() +
      Polyomorphic lens targeted on _1.
      +
      static <A,B> Lens<P2<A,B>,B>_2() +
      Monomorphic lens targeted on _1.
      +
      static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C>_2p() +
      Polyomorphic lens targeted on _2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        _1p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<C,B>,A,C> _1p()
        +
        Polyomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public static <A,B> Lens<P2<A,B>,A> _1()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      + + + +
        +
      • +

        _2p

        +
        public static <A,B,C> PLens<P2<A,B>,P2<A,C>,B,C> _2p()
        +
        Polyomorphic lens targeted on _2.
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public static <A,B> Lens<P2<A,B>,B> _2()
        +
        Monomorphic lens targeted on _1.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P2.html b/javadoc/5.0/functionaljava/fj/P2.html new file mode 100644 index 0000000..7f9a2f0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P2.html @@ -0,0 +1,1078 @@ + + + + + +P2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class P2<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P2<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P2<A,B>
+extends java.lang.Object
    +
    A product-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class P2.Optic +
      Optic factory methods for a P2
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P2() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<P2<A,B>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B> F<P2<A,B>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      <C> P3<A,B,C>append(C el) +
      Creates a P3 by adding the given element to the current P2
      +
      <C,D> P4<A,B,C,D>append(P2<C,D> el) +
      Creates a P4 by adding the given element to the current P2
      +
      <C,D,E> P5<A,B,C,D,E>append(P3<C,D,E> el) +
      Creates a P5 by adding the given element to the current P2
      +
      <C,D,E,F> P6<A,B,C,D,E,F>append(P4<C,D,E,F> el) +
      Creates a P6 by adding the given element to the current P2
      +
      <C,D,E,F,G>
      P7<A,B,C,D,E,F,G>      		append(P5<C,D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P2
      +
      <C,D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P6<C,D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P2
      +
      <C> P2<C,B>cobind(F<P2<A,B>,C> k) +
      Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
      +
      P2<P2<A,B>,B>duplicate() +
      Duplicates this product into the first element (Comonad pattern).
      +
      booleanequals(java.lang.Object other) 
      static <B,C,D> P2<C,D>fanout(F<B,C> f, + F<B,D> g, + B b) +
      Sends the given input value to both argument functions and combines their output.
      +
      inthashCode() 
      <C> P2<C,B>inject(C c) +
      Replaces the first element of this product with the given value.
      +
      static <A,B> P2<B,B>map(F<A,B> f, + P2<A,A> p) +
      Maps the given function across both the elements of the given product.
      +
      static <A,B,X> F<P2<A,B>,P2<X,B>>map1_(F<A,X> f) +
      Promotes a function so that it maps the first element of a product.
      +
      <X> P2<X,B>map1(F<A,X> f) +
      Map the first element of the product.
      +
      static <A,B,X> F<P2<A,B>,P2<A,X>>map2_(F<B,X> f) +
      Promotes a function so that it maps the second element of a product.
      +
      <X> P2<A,X>map2(F<B,X> f) +
      Map the second element of the product.
      +
      P2<A,B>memo() +
      Provides a memoising P2 that remembers its values.
      +
      <C> List<C>sequenceW(List<F<P2<A,B>,C>> fs) +
      Applies a list of comonadic functions to this product, returning a list of values.
      +
      <C> Stream<C>sequenceW(Stream<F<P2<A,B>,C>> fs) +
      Applies a stream of comonadic functions to this product, returning a stream of values.
      +
      static <A,B,C,D> F<P2<A,B>,P2<C,D>>split_(F<A,C> f, + F<B,D> g) +
      A first-class version of the split function.
      +
      <C,D> P2<C,D>split(F<A,C> f, + F<B,D> g) +
      Split this product between two argument functions and combine their output.
      +
      static <A,B> F<P2<A,B>,P2<B,A>>swap_() +
      Returns a curried form of swap().
      +
      P2<B,A>swap() +
      Swaps the elements around in this product.
      +
      java.lang.StringtoString() 
      <C,X> Either<X,P2<A,C>>traverseEither(F<B,Either<X,C>> f) 
      <C> IO<P2<A,C>>traverseIO(F<B,IO<C>> f) 
      <C> List<P2<A,C>>traverseList(F<B,List<C>> f) 
      <C> Option<P2<A,C>>traverseOption(F<B,Option<C>> f) 
      <C> Stream<P2<A,C>>traverseStream(F<B,Stream<C>> f) 
      static <A,B,C> F<P2<A,B>,C>tuple(F<A,F<B,C>> f) +
      Transforms a curried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F<P2<A,B>,C>tuple(F2<A,B,C> f) +
      Transforms an uncurried function of arity-2 to a function of a product-2
      +
      static <A,B,C> F2<A,B,C>untuple(F<P2<A,B>,C> f) +
      Transforms a function of a product-2 to an uncurried function or arity-2.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P2

        +
        public P2()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final P2<B,A> swap()
        +
        Swaps the elements around in this product.
        +
        +
        Returns:
        +
        A new product-2 with the elements swapped.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P2<X,B> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P2<A,X> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final <C,D> P2<C,D> split(F<A,C> f,
+                                 F<B,D> g)
        +
        Split this product between two argument functions and combine their output.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of this product.
        +
        g - A function that will map the second element of this product.
        +
        Returns:
        +
        A new product with the first function applied to the second element + and the second function applied to the second element.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <C> P2<C,B> cobind(F<P2<A,B>,C> k)
        +
        Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
        +
        +
        Parameters:
        +
        k - A function to map over the duplicated product.
        +
        Returns:
        +
        A new product with the result of the given function applied to this product as the first element, + and with the second element intact.
        +
        +
        • +
      + + + +
        +
      • +

        duplicate

        +
        public final P2<P2<A,B>,B> duplicate()
        +
        Duplicates this product into the first element (Comonad pattern).
        +
        +
        Returns:
        +
        A new product with this product in its first element and with the second element intact.
        +
        +
        • +
      + + + + + +
        +
      • +

        inject

        +
        public final <C> P2<C,B> inject(C c)
        +
        Replaces the first element of this product with the given value.
        +
        +
        Parameters:
        +
        c - The value with which to replace the first element of this product.
        +
        Returns:
        +
        A new product with the first element replaced with the given value.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> List<C> sequenceW(List<F<P2<A,B>,C>> fs)
        +
        Applies a list of comonadic functions to this product, returning a list of values.
        +
        +
        Parameters:
        +
        fs - A list of functions to apply to this product.
        +
        Returns:
        +
        A list of the results of applying the given list of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <C> List<P2<A,C>> traverseList(F<B,List<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <C> Stream<P2<A,C>> traverseStream(F<B,Stream<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<P2<A,C>> traverseIO(F<B,IO<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <C> Option<P2<A,C>> traverseOption(F<B,Option<C>> f)
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <C,X> Either<X,P2<A,C>> traverseEither(F<B,Either<X,C>> f)
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <C> Stream<C> sequenceW(Stream<F<P2<A,B>,C>> fs)
        +
        Applies a stream of comonadic functions to this product, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this product.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this product.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <C> P3<A,B,C> append(C el)
        +
        Creates a P3 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P3 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D> P4<A,B,C,D> append(P2<C,D> el)
        +
        Creates a P4 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E> P5<A,B,C,D,E> append(P3<C,D,E> el)
        +
        Creates a P5 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F> P6<A,B,C,D,E,F> append(P4<C,D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G> P7<A,B,C,D,E,F,G> append(P5<C,D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <C,D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P6<C,D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P2
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P2 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P2<A,B> memo()
        +
        Provides a memoising P2 that remembers its values.
        +
        +
        Returns:
        +
        A P2 that calls this P2 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        split_

        +
        public static <A,B,C,D> F<P2<A,B>,P2<C,D>> split_(F<A,C> f,
+                                                  F<B,D> g)
        +
        A first-class version of the split function.
        +
        +
        Parameters:
        +
        f - A function that will map the first element of the given product.
        +
        g - A function that will map the second element of the given product.
        +
        Returns:
        +
        A function that splits a given product between the two given functions and combines their output.
        +
        +
        • +
      + + + +
        +
      • +

        map1_

        +
        public static <A,B,X> F<P2<A,B>,P2<X,B>> map1_(F<A,X> f)
        +
        Promotes a function so that it maps the first element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the first element of products.
        +
        +
        • +
      + + + +
        +
      • +

        map2_

        +
        public static <A,B,X> F<P2<A,B>,P2<A,X>> map2_(F<B,X> f)
        +
        Promotes a function so that it maps the second element of a product.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        The given function, promoted to map the second element of products.
        +
        +
        • +
      + + + + + +
        +
      • +

        fanout

        +
        public static <B,C,D> P2<C,D> fanout(F<B,C> f,
+                                     F<B,D> g,
+                                     B b)
        +
        Sends the given input value to both argument functions and combines their output.
        +
        +
        Parameters:
        +
        f - A function to receive an input value.
        +
        g - A function to receive an input value.
        +
        b - An input value to send to both functions.
        +
        Returns:
        +
        The product of the two functions applied to the input value.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> P2<B,B> map(F<A,B> f,
+                                P2<A,A> p)
        +
        Maps the given function across both the elements of the given product.
        +
        +
        Parameters:
        +
        f - A function to map over a product.
        +
        p - A product over which to map.
        +
        Returns:
        +
        A new product with the given function applied to both elements.
        +
        +
        • +
      + + + +
        +
      • +

        swap_

        +
        public static <A,B> F<P2<A,B>,P2<B,A>> swap_()
        +
        Returns a curried form of swap().
        +
        +
        Returns:
        +
        A curried form of swap().
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B> F<P2<A,B>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B> F<P2<A,B>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F<A,F<B,C>> f)
        +
        Transforms a curried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - a curried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        tuple

        +
        public static <A,B,C> F<P2<A,B>,C> tuple(F2<A,B,C> f)
        +
        Transforms an uncurried function of arity-2 to a function of a product-2
        +
        +
        Parameters:
        +
        f - an uncurried function of arity-2 to transform into a function of a product-2
        +
        Returns:
        +
        The function, transformed to operate on on a product-2
        +
        +
        • +
      + + + +
        +
      • +

        untuple

        +
        public static <A,B,C> F2<A,B,C> untuple(F<P2<A,B>,C> f)
        +
        Transforms a function of a product-2 to an uncurried function or arity-2.
        +
        +
        Parameters:
        +
        f - A function of a product-2 to transform into an uncurried function.
        +
        Returns:
        +
        The function, transformed to an uncurried function of arity-2.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P3.html b/javadoc/5.0/functionaljava/fj/P3.html new file mode 100644 index 0000000..9bcdc72 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P3.html @@ -0,0 +1,685 @@ + + + + + +P3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P3<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P3<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P3<A,B,C>
+extends java.lang.Object
    +
    A product-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P3() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C> F<P3<A,B,C>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C> F<P3<A,B,C>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      <D> P4<A,B,C,D>append(D el) +
      Creates a P4 by adding the given element to the current P3
      +
      <D,E> P5<A,B,C,D,E>append(P2<D,E> el) +
      Creates a P5 by adding the given element to the current P3
      +
      <D,E,F> P6<A,B,C,D,E,F>append(P3<D,E,F> el) +
      Creates a P6 by adding the given element to the current P3
      +
      <D,E,F,G> P7<A,B,C,D,E,F,G>append(P4<D,E,F,G> el) +
      Creates a P7 by adding the given element to the current P3
      +
      <D,E,F,G,H>
      P8<A,B,C,D,E,F,G,H>      		append(P5<D,E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P3
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P3<X,B,C>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P3<A,X,C>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P3<A,B,X>map3(F<C,X> f) +
      Map the third element of the product.
      +
      P3<A,B,C>memo() +
      Provides a memoising P3 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P3

        +
        public P3()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P3<X,B,C> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P3<A,X,C> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P3<A,B,X> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <D> P4<A,B,C,D> append(D el)
        +
        Creates a P4 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P4 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E> P5<A,B,C,D,E> append(P2<D,E> el)
        +
        Creates a P5 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F> P6<A,B,C,D,E,F> append(P3<D,E,F> el)
        +
        Creates a P6 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G> P7<A,B,C,D,E,F,G> append(P4<D,E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <D,E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P5<D,E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P3
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P3 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P3<A,B,C> memo()
        +
        Provides a memoising P3 that remembers its values.
        +
        +
        Returns:
        +
        A P3 that calls this P3 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C> F<P3<A,B,C>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C> F<P3<A,B,C>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C> F<P3<A,B,C>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P4.html b/javadoc/5.0/functionaljava/fj/P4.html new file mode 100644 index 0000000..e17f0c2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P4.html @@ -0,0 +1,745 @@ + + + + + +P4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P4<A,B,C,D>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P4<A,B,C,D>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P4<A,B,C,D>
+extends java.lang.Object
    +
    A product-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P4() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D> F<P4<A,B,C,D>,A>__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,B>__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,C>__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D> F<P4<A,B,C,D>,D>__4() +
      Returns a function that returns the fourth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      <E> P5<A,B,C,D,E>append(E el) +
      Creates a P5 by adding the given element to the current P4
      +
      <E,F> P6<A,B,C,D,E,F>append(P2<E,F> el) +
      Creates a P6 by adding the given element to the current P4
      +
      <E,F,G> P7<A,B,C,D,E,F,G>append(P3<E,F,G> el) +
      Creates a P7 by adding the given element to the current P4
      +
      <E,F,G,H> P8<A,B,C,D,E,F,G,H>append(P4<E,F,G,H> el) +
      Creates a P8 by adding the given element to the current P4
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P4<X,B,C,D>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P4<A,X,C,D>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P4<A,B,X,D>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P4<A,B,C,X>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      P4<A,B,C,D>memo() +
      Provides a memoising P4 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P4

        +
        public P4()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P4<X,B,C,D> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P4<A,X,C,D> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P4<A,B,X,D> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P4<A,B,C,X> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <E> P5<A,B,C,D,E> append(E el)
        +
        Creates a P5 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P5 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F> P6<A,B,C,D,E,F> append(P2<E,F> el)
        +
        Creates a P6 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G> P7<A,B,C,D,E,F,G> append(P3<E,F,G> el)
        +
        Creates a P7 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <E,F,G,H> P8<A,B,C,D,E,F,G,H> append(P4<E,F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P4
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P4 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P4<A,B,C,D> memo()
        +
        Provides a memoising P4 that remembers its values.
        +
        +
        Returns:
        +
        A P4 that calls this P4 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D> F<P4<A,B,C,D>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P5.html b/javadoc/5.0/functionaljava/fj/P5.html new file mode 100644 index 0000000..cf2eb1a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P5.html @@ -0,0 +1,805 @@ + + + + + +P5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P5<A,B,C,D,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P5<A,B,C,D,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P5<A,B,C,D,E>
+extends java.lang.Object
    +
    A product-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P5() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E>
      F<P5<A,B,C,D,E>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      <F> P6<A,B,C,D,E,F>append(F el) +
      Creates a P6 by adding the given element to the current P5
      +
      <F,G> P7<A,B,C,D,E,F,G>append(P2<F,G> el) +
      Creates a P7 by adding the given element to the current P5
      +
      <F,G,H> P8<A,B,C,D,E,F,G,H>append(P3<F,G,H> el) +
      Creates a P8 by adding the given element to the current P5
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P5<X,B,C,D,E>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P5<A,X,C,D,E>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P5<A,B,X,D,E>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P5<A,B,C,X,E>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P5<A,B,C,D,X>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      P5<A,B,C,D,E>memo() +
      Provides a memoising P5 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P5

        +
        public P5()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P5<X,B,C,D,E> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P5<A,X,C,D,E> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P5<A,B,X,D,E> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P5<A,B,C,X,E> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P5<A,B,C,D,X> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <F> P6<A,B,C,D,E,F> append(F el)
        +
        Creates a P6 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P6 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G> P7<A,B,C,D,E,F,G> append(P2<F,G> el)
        +
        Creates a P7 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <F,G,H> P8<A,B,C,D,E,F,G,H> append(P3<F,G,H> el)
        +
        Creates a P8 by adding the given element to the current P5
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P5 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P5<A,B,C,D,E> memo()
        +
        Provides a memoising P5 that remembers its values.
        +
        +
        Returns:
        +
        A P5 that calls this P5 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E> F<P5<A,B,C,D,E>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P6.html b/javadoc/5.0/functionaljava/fj/P6.html new file mode 100644 index 0000000..8e6764f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P6.html @@ -0,0 +1,865 @@ + + + + + +P6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P6<A,B,C,D,E,F>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P6<A,B,C,D,E,F>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P6<A,B,C,D,E,F>
+extends java.lang.Object
    +
    A product-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P6() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$>
      F<P6<A,B,C,D,E,F$>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      <G> P7<A,B,C,D,E,F,G>append(G el) +
      Creates a P7 by adding the given element to the current P6
      +
      <G,H> P8<A,B,C,D,E,F,G,H>append(P2<G,H> el) +
      Creates a P8 by adding the given element to the current P6
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P6<X,B,C,D,E,F>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P6<A,X,C,D,E,F>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P6<A,B,X,D,E,F>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P6<A,B,C,X,E,F>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P6<A,B,C,D,X,F>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P6<A,B,C,D,E,X>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      P6<A,B,C,D,E,F>memo() +
      Provides a memoising P6 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P6

        +
        public P6()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P6<X,B,C,D,E,F> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P6<A,X,C,D,E,F> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P6<A,B,X,D,E,F> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P6<A,B,C,X,E,F> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P6<A,B,C,D,X,F> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P6<A,B,C,D,E,X> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <G> P7<A,B,C,D,E,F,G> append(G el)
        +
        Creates a P7 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P7 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final <G,H> P8<A,B,C,D,E,F,G,H> append(P2<G,H> el)
        +
        Creates a P8 by adding the given element to the current P6
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P6 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P6<A,B,C,D,E,F> memo()
        +
        Provides a memoising P6 that remembers its values.
        +
        +
        Returns:
        +
        A P6 that calls this P6 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$> F<P6<A,B,C,D,E,F$>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P7.html b/javadoc/5.0/functionaljava/fj/P7.html new file mode 100644 index 0000000..c1d9fb5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P7.html @@ -0,0 +1,925 @@ + + + + + +P7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P7<A,B,C,D,E,F,G>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P7<A,B,C,D,E,F,G>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P7<A,B,C,D,E,F,G>
+extends java.lang.Object
    +
    A product-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P7() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G>
      F<P7<A,B,C,D,E,F$,G>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      <H> P8<A,B,C,D,E,F,G,H>append(H el) +
      Creates a P8 by adding the given element to the current P7
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P7<X,B,C,D,E,F,G>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P7<A,X,C,D,E,F,G>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P7<A,B,X,D,E,F,G>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P7<A,B,C,X,E,F,G>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P7<A,B,C,D,X,F,G>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P7<A,B,C,D,E,X,G>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P7<A,B,C,D,E,F,X>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      P7<A,B,C,D,E,F,G>memo() +
      Provides a memoising P7 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P7

        +
        public P7()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P7<X,B,C,D,E,F,G> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P7<A,X,C,D,E,F,G> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P7<A,B,X,D,E,F,G> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P7<A,B,C,X,E,F,G> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P7<A,B,C,D,X,F,G> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P7<A,B,C,D,E,X,G> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P7<A,B,C,D,E,F,X> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public final <H> P8<A,B,C,D,E,F,G,H> append(H el)
        +
        Creates a P8 by adding the given element to the current P7
        +
        +
        Parameters:
        +
        el - the element to append
        +
        Returns:
        +
        A P8 containing the original P7 with the extra element added at the end
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P7<A,B,C,D,E,F,G> memo()
        +
        Provides a memoising P7 that remembers its values.
        +
        +
        Returns:
        +
        A P7 that calls this P7 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G> F<P7<A,B,C,D,E,F$,G>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/P8.html b/javadoc/5.0/functionaljava/fj/P8.html new file mode 100644 index 0000000..9d14e18 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/P8.html @@ -0,0 +1,983 @@ + + + + + +P8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class P8<A,B,C,D,E,F,G,H>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P8<A,B,C,D,E,F,G,H>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class P8<A,B,C,D,E,F,G,H>
+extends java.lang.Object
    +
    A product-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      P8() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,A>      		__1() +
      Returns a function that returns the first element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,B>      		__2() +
      Returns a function that returns the second element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,C>      		__3() +
      Returns a function that returns the third element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,D>      		__4() +
      Returns a function that returns the fourth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,E>      		__5() +
      Returns a function that returns the fifth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,F$>      		__6() +
      Returns a function that returns the sixth element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,G>      		__7() +
      Returns a function that returns the seventh element of a product.
      +
      static <A,B,C,D,E,F$,G,H>
      F<P8<A,B,C,D,E,F$,G,H>,H>      		__8() +
      Returns a function that returns the eighth element of a product.
      +
      P1<A>_1_() +
      Returns the 1-product projection over the first element.
      +
      abstract A_1() +
      Access the first element of the product.
      +
      P1<B>_2_() +
      Returns the 1-product projection over the second element.
      +
      abstract B_2() +
      Access the second element of the product.
      +
      P1<C>_3_() +
      Returns the 1-product projection over the third element.
      +
      abstract C_3() +
      Access the third element of the product.
      +
      P1<D>_4_() +
      Returns the 1-product projection over the fourth element.
      +
      abstract D_4() +
      Access the fourth element of the product.
      +
      P1<E>_5_() +
      Returns the 1-product projection over the fifth element.
      +
      abstract E_5() +
      Access the fifth element of the product.
      +
      P1<F>_6_() +
      Returns the 1-product projection over the sixth element.
      +
      abstract F_6() +
      Access the sixth element of the product.
      +
      P1<G>_7_() +
      Returns the 1-product projection over the seventh element.
      +
      abstract G_7() +
      Access the seventh element of the product.
      +
      P1<H>_8_() +
      Returns the 1-product projection over the eighth element.
      +
      abstract H_8() +
      Access the eighth element of the product.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      <X> P8<X,B,C,D,E,F,G,H>map1(F<A,X> f) +
      Map the first element of the product.
      +
      <X> P8<A,X,C,D,E,F,G,H>map2(F<B,X> f) +
      Map the second element of the product.
      +
      <X> P8<A,B,X,D,E,F,G,H>map3(F<C,X> f) +
      Map the third element of the product.
      +
      <X> P8<A,B,C,X,E,F,G,H>map4(F<D,X> f) +
      Map the fourth element of the product.
      +
      <X> P8<A,B,C,D,X,F,G,H>map5(F<E,X> f) +
      Map the fifth element of the product.
      +
      <X> P8<A,B,C,D,E,X,G,H>map6(F<F,X> f) +
      Map the sixth element of the product.
      +
      <X> P8<A,B,C,D,E,F,X,H>map7(F<G,X> f) +
      Map the seventh element of the product.
      +
      <X> P8<A,B,C,D,E,F,G,X>map8(F<H,X> f) +
      Map the eighth element of the product.
      +
      P8<A,B,C,D,E,F,G,H>memo() +
      Provides a memoising P8 that remembers its values.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        P8

        +
        public P8()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        _1

        +
        public abstract A _1()
        +
        Access the first element of the product.
        +
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public abstract B _2()
        +
        Access the second element of the product.
        +
        +
        Returns:
        +
        The second element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public abstract C _3()
        +
        Access the third element of the product.
        +
        +
        Returns:
        +
        The third element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public abstract D _4()
        +
        Access the fourth element of the product.
        +
        +
        Returns:
        +
        The fourth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public abstract E _5()
        +
        Access the fifth element of the product.
        +
        +
        Returns:
        +
        The fifth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public abstract F _6()
        +
        Access the sixth element of the product.
        +
        +
        Returns:
        +
        The sixth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public abstract G _7()
        +
        Access the seventh element of the product.
        +
        +
        Returns:
        +
        The seventh element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public abstract H _8()
        +
        Access the eighth element of the product.
        +
        +
        Returns:
        +
        The eighth element of the product.
        +
        +
        • +
      + + + +
        +
      • +

        map1

        +
        public final <X> P8<X,B,C,D,E,F,G,H> map1(F<A,X> f)
        +
        Map the first element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map2

        +
        public final <X> P8<A,X,C,D,E,F,G,H> map2(F<B,X> f)
        +
        Map the second element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public final <X> P8<A,B,X,D,E,F,G,H> map3(F<C,X> f)
        +
        Map the third element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map4

        +
        public final <X> P8<A,B,C,X,E,F,G,H> map4(F<D,X> f)
        +
        Map the fourth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map5

        +
        public final <X> P8<A,B,C,D,X,F,G,H> map5(F<E,X> f)
        +
        Map the fifth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map6

        +
        public final <X> P8<A,B,C,D,E,X,G,H> map6(F<F,X> f)
        +
        Map the sixth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map7

        +
        public final <X> P8<A,B,C,D,E,F,X,H> map7(F<G,X> f)
        +
        Map the seventh element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        map8

        +
        public final <X> P8<A,B,C,D,E,F,G,X> map8(F<H,X> f)
        +
        Map the eighth element of the product.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A product with the given function applied.
        +
        +
        • +
      + + + +
        +
      • +

        _1_

        +
        public final P1<A> _1_()
        +
        Returns the 1-product projection over the first element.
        +
        +
        Returns:
        +
        the 1-product projection over the first element.
        +
        +
        • +
      + + + +
        +
      • +

        _2_

        +
        public final P1<B> _2_()
        +
        Returns the 1-product projection over the second element.
        +
        +
        Returns:
        +
        the 1-product projection over the second element.
        +
        +
        • +
      + + + +
        +
      • +

        _3_

        +
        public final P1<C> _3_()
        +
        Returns the 1-product projection over the third element.
        +
        +
        Returns:
        +
        the 1-product projection over the third element.
        +
        +
        • +
      + + + +
        +
      • +

        _4_

        +
        public final P1<D> _4_()
        +
        Returns the 1-product projection over the fourth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fourth element.
        +
        +
        • +
      + + + +
        +
      • +

        _5_

        +
        public final P1<E> _5_()
        +
        Returns the 1-product projection over the fifth element.
        +
        +
        Returns:
        +
        the 1-product projection over the fifth element.
        +
        +
        • +
      + + + +
        +
      • +

        _6_

        +
        public final P1<F> _6_()
        +
        Returns the 1-product projection over the sixth element.
        +
        +
        Returns:
        +
        the 1-product projection over the sixth element.
        +
        +
        • +
      + + + +
        +
      • +

        _7_

        +
        public final P1<G> _7_()
        +
        Returns the 1-product projection over the seventh element.
        +
        +
        Returns:
        +
        the 1-product projection over the seventh element.
        +
        +
        • +
      + + + +
        +
      • +

        _8_

        +
        public final P1<H> _8_()
        +
        Returns the 1-product projection over the eighth element.
        +
        +
        Returns:
        +
        the 1-product projection over the eighth element.
        +
        +
        • +
      + + + +
        +
      • +

        memo

        +
        public final P8<A,B,C,D,E,F,G,H> memo()
        +
        Provides a memoising P8 that remembers its values.
        +
        +
        Returns:
        +
        A P8 that calls this P8 once for any given element and remembers the value for subsequent calls.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,A> __1()
        +
        Returns a function that returns the first element of a product.
        +
        +
        Returns:
        +
        A function that returns the first element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,B> __2()
        +
        Returns a function that returns the second element of a product.
        +
        +
        Returns:
        +
        A function that returns the second element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,C> __3()
        +
        Returns a function that returns the third element of a product.
        +
        +
        Returns:
        +
        A function that returns the third element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,D> __4()
        +
        Returns a function that returns the fourth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fourth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,E> __5()
        +
        Returns a function that returns the fifth element of a product.
        +
        +
        Returns:
        +
        A function that returns the fifth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,F$> __6()
        +
        Returns a function that returns the sixth element of a product.
        +
        +
        Returns:
        +
        A function that returns the sixth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,G> __7()
        +
        Returns a function that returns the seventh element of a product.
        +
        +
        Returns:
        +
        A function that returns the seventh element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A,B,C,D,E,F$,G,H> F<P8<A,B,C,D,E,F$,G,H>,H> __8()
        +
        Returns a function that returns the eighth element of a product.
        +
        +
        Returns:
        +
        A function that returns the eighth element of a product.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Primitive.html b/javadoc/5.0/functionaljava/fj/Primitive.html new file mode 100644 index 0000000..6b38774 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Primitive.html @@ -0,0 +1,1120 @@ + + + + + +Primitive (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Primitive

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Primitive
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Primitive
+extends java.lang.Object
    +
    Functions that convert between Java primitive types.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,java.lang.Byte>Boolean_Byte +
      A function that converts booleans to bytes.
      +
      static F<java.lang.Boolean,java.lang.Character>Boolean_Character +
      A function that converts booleans to characters.
      +
      static F<java.lang.Boolean,java.lang.Double>Boolean_Double +
      A function that converts booleans to doubles.
      +
      static F<java.lang.Boolean,java.lang.Float>Boolean_Float +
      A function that converts booleans to floats.
      +
      static F<java.lang.Boolean,java.lang.Integer>Boolean_Integer +
      A function that converts booleans to integers.
      +
      static F<java.lang.Boolean,java.lang.Long>Boolean_Long +
      A function that converts booleans to longs.
      +
      static F<java.lang.Boolean,java.lang.Short>Boolean_Short +
      A function that converts booleans to shorts.
      +
      static F<java.lang.Byte,java.lang.Boolean>Byte_Boolean +
      A function that converts bytes to booleans.
      +
      static F<java.lang.Byte,java.lang.Character>Byte_Character +
      A function that converts bytes to characters.
      +
      static F<java.lang.Byte,java.lang.Double>Byte_Double +
      A function that converts bytes to doubles.
      +
      static F<java.lang.Byte,java.lang.Float>Byte_Float +
      A function that converts bytes to floats.
      +
      static F<java.lang.Byte,java.lang.Integer>Byte_Integer +
      A function that converts bytes to integers.
      +
      static F<java.lang.Byte,java.lang.Long>Byte_Long +
      A function that converts bytes to longs.
      +
      static F<java.lang.Byte,java.lang.Short>Byte_Short +
      A function that converts bytes to shorts.
      +
      static F<java.lang.Character,java.lang.Boolean>Character_Boolean +
      A function that converts characters to booleans.
      +
      static F<java.lang.Character,java.lang.Byte>Character_Byte +
      A function that converts characters to bytes.
      +
      static F<java.lang.Character,java.lang.Double>Character_Double +
      A function that converts characters to doubles.
      +
      static F<java.lang.Character,java.lang.Float>Character_Float +
      A function that converts characters to floats.
      +
      static F<java.lang.Character,java.lang.Integer>Character_Integer +
      A function that converts characters to integers.
      +
      static F<java.lang.Character,java.lang.Long>Character_Long +
      A function that converts characters to longs.
      +
      static F<java.lang.Character,java.lang.Short>Character_Short +
      A function that converts characters to shorts.
      +
      static F<java.lang.Double,java.lang.Boolean>Double_Boolean +
      A function that converts doubles to booleans.
      +
      static F<java.lang.Double,java.lang.Byte>Double_Byte +
      A function that converts doubles to bytes.
      +
      static F<java.lang.Double,java.lang.Character>Double_Character +
      A function that converts doubles to characters.
      +
      static F<java.lang.Double,java.lang.Float>Double_Float +
      A function that converts doubles to floats.
      +
      static F<java.lang.Double,java.lang.Integer>Double_Integer +
      A function that converts doubles to integers.
      +
      static F<java.lang.Double,java.lang.Long>Double_Long +
      A function that converts doubles to longs.
      +
      static F<java.lang.Double,java.lang.Short>Double_Short +
      A function that converts doubles to shorts.
      +
      static F<java.lang.Float,java.lang.Boolean>Float_Boolean +
      A function that converts floats to booleans.
      +
      static F<java.lang.Float,java.lang.Byte>Float_Byte +
      A function that converts floats to bytes.
      +
      static F<java.lang.Float,java.lang.Character>Float_Character +
      A function that converts floats to characters.
      +
      static F<java.lang.Float,java.lang.Double>Float_Double +
      A function that converts floats to doubles.
      +
      static F<java.lang.Float,java.lang.Integer>Float_Integer +
      A function that converts floats to integers.
      +
      static F<java.lang.Float,java.lang.Long>Float_Long +
      A function that converts floats to longs.
      +
      static F<java.lang.Float,java.lang.Short>Float_Short +
      A function that converts floats to shorts.
      +
      static F<java.lang.Integer,java.lang.Boolean>Integer_Boolean +
      A function that converts integers to booleans.
      +
      static F<java.lang.Integer,java.lang.Byte>Integer_Byte +
      A function that converts integers to bytes.
      +
      static F<java.lang.Integer,java.lang.Character>Integer_Character +
      A function that converts integers to characters.
      +
      static F<java.lang.Integer,java.lang.Double>Integer_Double +
      A function that converts integers to doubles.
      +
      static F<java.lang.Integer,java.lang.Float>Integer_Float +
      A function that converts integers to floats.
      +
      static F<java.lang.Integer,java.lang.Long>Integer_Long +
      A function that converts integers to longs.
      +
      static F<java.lang.Integer,java.lang.Short>Integer_Short +
      A function that converts integers to shorts.
      +
      static F<java.lang.Long,java.lang.Boolean>Long_Boolean +
      A function that converts longs to booleans.
      +
      static F<java.lang.Long,java.lang.Byte>Long_Byte +
      A function that converts longs to bytes.
      +
      static F<java.lang.Long,java.lang.Character>Long_Character +
      A function that converts longs to characters.
      +
      static F<java.lang.Long,java.lang.Double>Long_Double +
      A function that converts longs to doubles.
      +
      static F<java.lang.Long,java.lang.Float>Long_Float +
      A function that converts longs to floats.
      +
      static F<java.lang.Long,java.lang.Integer>Long_Integer +
      A function that converts longs to integers.
      +
      static F<java.lang.Long,java.lang.Short>Long_Short +
      A function that converts longs to shorts.
      +
      static F<java.lang.Short,java.lang.Boolean>Short_Boolean +
      A function that converts shorts to booleans.
      +
      static F<java.lang.Short,java.lang.Byte>Short_Byte +
      A function that converts shorts to bytes.
      +
      static F<java.lang.Short,java.lang.Character>Short_Character +
      A function that converts shorts to characters.
      +
      static F<java.lang.Short,java.lang.Double>Short_Double +
      A function that converts shorts to doubles.
      +
      static F<java.lang.Short,java.lang.Float>Short_Float +
      A function that converts shorts to floats.
      +
      static F<java.lang.Short,java.lang.Integer>Short_Integer +
      A function that converts shorts to integers.
      +
      static F<java.lang.Short,java.lang.Long>Short_Long +
      A function that converts shorts to longs.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        Boolean_Byte

        +
        public static final F<java.lang.Boolean,java.lang.Byte> Boolean_Byte
        +
        A function that converts booleans to bytes.
        +
        • +
      + + + +
        +
      • +

        Boolean_Character

        +
        public static final F<java.lang.Boolean,java.lang.Character> Boolean_Character
        +
        A function that converts booleans to characters.
        +
        • +
      + + + +
        +
      • +

        Boolean_Double

        +
        public static final F<java.lang.Boolean,java.lang.Double> Boolean_Double
        +
        A function that converts booleans to doubles.
        +
        • +
      + + + +
        +
      • +

        Boolean_Float

        +
        public static final F<java.lang.Boolean,java.lang.Float> Boolean_Float
        +
        A function that converts booleans to floats.
        +
        • +
      + + + +
        +
      • +

        Boolean_Integer

        +
        public static final F<java.lang.Boolean,java.lang.Integer> Boolean_Integer
        +
        A function that converts booleans to integers.
        +
        • +
      + + + +
        +
      • +

        Boolean_Long

        +
        public static final F<java.lang.Boolean,java.lang.Long> Boolean_Long
        +
        A function that converts booleans to longs.
        +
        • +
      + + + +
        +
      • +

        Boolean_Short

        +
        public static final F<java.lang.Boolean,java.lang.Short> Boolean_Short
        +
        A function that converts booleans to shorts.
        +
        • +
      + + + +
        +
      • +

        Byte_Boolean

        +
        public static final F<java.lang.Byte,java.lang.Boolean> Byte_Boolean
        +
        A function that converts bytes to booleans.
        +
        • +
      + + + +
        +
      • +

        Byte_Character

        +
        public static final F<java.lang.Byte,java.lang.Character> Byte_Character
        +
        A function that converts bytes to characters.
        +
        • +
      + + + +
        +
      • +

        Byte_Double

        +
        public static final F<java.lang.Byte,java.lang.Double> Byte_Double
        +
        A function that converts bytes to doubles.
        +
        • +
      + + + +
        +
      • +

        Byte_Float

        +
        public static final F<java.lang.Byte,java.lang.Float> Byte_Float
        +
        A function that converts bytes to floats.
        +
        • +
      + + + +
        +
      • +

        Byte_Integer

        +
        public static final F<java.lang.Byte,java.lang.Integer> Byte_Integer
        +
        A function that converts bytes to integers.
        +
        • +
      + + + +
        +
      • +

        Byte_Long

        +
        public static final F<java.lang.Byte,java.lang.Long> Byte_Long
        +
        A function that converts bytes to longs.
        +
        • +
      + + + +
        +
      • +

        Byte_Short

        +
        public static final F<java.lang.Byte,java.lang.Short> Byte_Short
        +
        A function that converts bytes to shorts.
        +
        • +
      + + + +
        +
      • +

        Character_Boolean

        +
        public static final F<java.lang.Character,java.lang.Boolean> Character_Boolean
        +
        A function that converts characters to booleans.
        +
        • +
      + + + +
        +
      • +

        Character_Byte

        +
        public static final F<java.lang.Character,java.lang.Byte> Character_Byte
        +
        A function that converts characters to bytes.
        +
        • +
      + + + +
        +
      • +

        Character_Double

        +
        public static final F<java.lang.Character,java.lang.Double> Character_Double
        +
        A function that converts characters to doubles.
        +
        • +
      + + + +
        +
      • +

        Character_Float

        +
        public static final F<java.lang.Character,java.lang.Float> Character_Float
        +
        A function that converts characters to floats.
        +
        • +
      + + + +
        +
      • +

        Character_Integer

        +
        public static final F<java.lang.Character,java.lang.Integer> Character_Integer
        +
        A function that converts characters to integers.
        +
        • +
      + + + +
        +
      • +

        Character_Long

        +
        public static final F<java.lang.Character,java.lang.Long> Character_Long
        +
        A function that converts characters to longs.
        +
        • +
      + + + +
        +
      • +

        Character_Short

        +
        public static final F<java.lang.Character,java.lang.Short> Character_Short
        +
        A function that converts characters to shorts.
        +
        • +
      + + + +
        +
      • +

        Double_Boolean

        +
        public static final F<java.lang.Double,java.lang.Boolean> Double_Boolean
        +
        A function that converts doubles to booleans.
        +
        • +
      + + + +
        +
      • +

        Double_Byte

        +
        public static final F<java.lang.Double,java.lang.Byte> Double_Byte
        +
        A function that converts doubles to bytes.
        +
        • +
      + + + +
        +
      • +

        Double_Character

        +
        public static final F<java.lang.Double,java.lang.Character> Double_Character
        +
        A function that converts doubles to characters.
        +
        • +
      + + + +
        +
      • +

        Double_Float

        +
        public static final F<java.lang.Double,java.lang.Float> Double_Float
        +
        A function that converts doubles to floats.
        +
        • +
      + + + +
        +
      • +

        Double_Integer

        +
        public static final F<java.lang.Double,java.lang.Integer> Double_Integer
        +
        A function that converts doubles to integers.
        +
        • +
      + + + +
        +
      • +

        Double_Long

        +
        public static final F<java.lang.Double,java.lang.Long> Double_Long
        +
        A function that converts doubles to longs.
        +
        • +
      + + + +
        +
      • +

        Double_Short

        +
        public static final F<java.lang.Double,java.lang.Short> Double_Short
        +
        A function that converts doubles to shorts.
        +
        • +
      + + + +
        +
      • +

        Float_Boolean

        +
        public static final F<java.lang.Float,java.lang.Boolean> Float_Boolean
        +
        A function that converts floats to booleans.
        +
        • +
      + + + +
        +
      • +

        Float_Byte

        +
        public static final F<java.lang.Float,java.lang.Byte> Float_Byte
        +
        A function that converts floats to bytes.
        +
        • +
      + + + +
        +
      • +

        Float_Character

        +
        public static final F<java.lang.Float,java.lang.Character> Float_Character
        +
        A function that converts floats to characters.
        +
        • +
      + + + +
        +
      • +

        Float_Double

        +
        public static final F<java.lang.Float,java.lang.Double> Float_Double
        +
        A function that converts floats to doubles.
        +
        • +
      + + + +
        +
      • +

        Float_Integer

        +
        public static final F<java.lang.Float,java.lang.Integer> Float_Integer
        +
        A function that converts floats to integers.
        +
        • +
      + + + +
        +
      • +

        Float_Long

        +
        public static final F<java.lang.Float,java.lang.Long> Float_Long
        +
        A function that converts floats to longs.
        +
        • +
      + + + +
        +
      • +

        Float_Short

        +
        public static final F<java.lang.Float,java.lang.Short> Float_Short
        +
        A function that converts floats to shorts.
        +
        • +
      + + + +
        +
      • +

        Integer_Boolean

        +
        public static final F<java.lang.Integer,java.lang.Boolean> Integer_Boolean
        +
        A function that converts integers to booleans.
        +
        • +
      + + + +
        +
      • +

        Integer_Byte

        +
        public static final F<java.lang.Integer,java.lang.Byte> Integer_Byte
        +
        A function that converts integers to bytes.
        +
        • +
      + + + +
        +
      • +

        Integer_Character

        +
        public static final F<java.lang.Integer,java.lang.Character> Integer_Character
        +
        A function that converts integers to characters.
        +
        • +
      + + + +
        +
      • +

        Integer_Double

        +
        public static final F<java.lang.Integer,java.lang.Double> Integer_Double
        +
        A function that converts integers to doubles.
        +
        • +
      + + + +
        +
      • +

        Integer_Float

        +
        public static final F<java.lang.Integer,java.lang.Float> Integer_Float
        +
        A function that converts integers to floats.
        +
        • +
      + + + +
        +
      • +

        Integer_Long

        +
        public static final F<java.lang.Integer,java.lang.Long> Integer_Long
        +
        A function that converts integers to longs.
        +
        • +
      + + + +
        +
      • +

        Integer_Short

        +
        public static final F<java.lang.Integer,java.lang.Short> Integer_Short
        +
        A function that converts integers to shorts.
        +
        • +
      + + + +
        +
      • +

        Long_Boolean

        +
        public static final F<java.lang.Long,java.lang.Boolean> Long_Boolean
        +
        A function that converts longs to booleans.
        +
        • +
      + + + +
        +
      • +

        Long_Byte

        +
        public static final F<java.lang.Long,java.lang.Byte> Long_Byte
        +
        A function that converts longs to bytes.
        +
        • +
      + + + +
        +
      • +

        Long_Character

        +
        public static final F<java.lang.Long,java.lang.Character> Long_Character
        +
        A function that converts longs to characters.
        +
        • +
      + + + +
        +
      • +

        Long_Double

        +
        public static final F<java.lang.Long,java.lang.Double> Long_Double
        +
        A function that converts longs to doubles.
        +
        • +
      + + + +
        +
      • +

        Long_Float

        +
        public static final F<java.lang.Long,java.lang.Float> Long_Float
        +
        A function that converts longs to floats.
        +
        • +
      + + + +
        +
      • +

        Long_Integer

        +
        public static final F<java.lang.Long,java.lang.Integer> Long_Integer
        +
        A function that converts longs to integers.
        +
        • +
      + + + +
        +
      • +

        Long_Short

        +
        public static final F<java.lang.Long,java.lang.Short> Long_Short
        +
        A function that converts longs to shorts.
        +
        • +
      + + + +
        +
      • +

        Short_Boolean

        +
        public static final F<java.lang.Short,java.lang.Boolean> Short_Boolean
        +
        A function that converts shorts to booleans.
        +
        • +
      + + + +
        +
      • +

        Short_Byte

        +
        public static final F<java.lang.Short,java.lang.Byte> Short_Byte
        +
        A function that converts shorts to bytes.
        +
        • +
      + + + +
        +
      • +

        Short_Character

        +
        public static final F<java.lang.Short,java.lang.Character> Short_Character
        +
        A function that converts shorts to characters.
        +
        • +
      + + + +
        +
      • +

        Short_Double

        +
        public static final F<java.lang.Short,java.lang.Double> Short_Double
        +
        A function that converts shorts to doubles.
        +
        • +
      + + + +
        +
      • +

        Short_Float

        +
        public static final F<java.lang.Short,java.lang.Float> Short_Float
        +
        A function that converts shorts to floats.
        +
        • +
      + + + +
        +
      • +

        Short_Integer

        +
        public static final F<java.lang.Short,java.lang.Integer> Short_Integer
        +
        A function that converts shorts to integers.
        +
        • +
      + + + +
        +
      • +

        Short_Long

        +
        public static final F<java.lang.Short,java.lang.Long> Short_Long
        +
        A function that converts shorts to longs.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Rng.html b/javadoc/5.0/functionaljava/fj/Rng.html new file mode 100644 index 0000000..cf2c14e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Rng.html @@ -0,0 +1,313 @@ + + + + + +Rng (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Rng

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Rng
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    LcgRng
    +
    +
    +
    +
    public abstract class Rng
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Rng() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Rng

        +
        public Rng()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextInt

        +
        public abstract P2<Rng,java.lang.Integer> nextInt()
        +
        • +
      + + + +
        +
      • +

        nextLong

        +
        public abstract P2<Rng,java.lang.Long> nextLong()
        +
        • +
      + + + +
        +
      • +

        range

        +
        public final P2<Rng,java.lang.Integer> range(int low,
+                                             int high)
        +
        • +
      + + + +
        +
      • +

        nextNatural

        +
        public final P2<Rng,java.lang.Integer> nextNatural()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Semigroup.AltDefinition.html b/javadoc/5.0/functionaljava/fj/Semigroup.AltDefinition.html new file mode 100644 index 0000000..56fe0de --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Semigroup.AltDefinition.html @@ -0,0 +1,262 @@ + + + + + +Semigroup.AltDefinition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.AltDefinition<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Semigroup.Definition<A>
    +
    +
    +
    Enclosing class:
    +
    Semigroup<A>
    +
    +
    +
    +
    public static interface Semigroup.AltDefinition<A>
+extends Semigroup.Definition<A>
    +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Semigroup.Definition.html b/javadoc/5.0/functionaljava/fj/Semigroup.Definition.html new file mode 100644 index 0000000..fe5aa77 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Semigroup.Definition.html @@ -0,0 +1,293 @@ + + + + + +Semigroup.Definition (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Interface Semigroup.Definition<A>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Semigroup.html b/javadoc/5.0/functionaljava/fj/Semigroup.html new file mode 100644 index 0000000..6abc038 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Semigroup.html @@ -0,0 +1,1313 @@ + + + + + +Semigroup (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj
+

Class Semigroup<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Semigroup<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Semigroup<A>
+extends java.lang.Object
    +
    Implementations must satisfy the law of associativity: +
      +
    • Associativity; forall x. forall y. forall z. sum(sum(x, y), z) == sum(x, sum(y, z))
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        intAdditionSemigroup

        +
        public static final Semigroup<java.lang.Integer> intAdditionSemigroup
        +
        A semigroup that adds integers.
        +
        • +
      + + + +
        +
      • +

        intMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMultiplicationSemigroup
        +
        A semigroup that multiplies integers.
        +
        • +
      + + + +
        +
      • +

        intMaximumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMaximumSemigroup
        +
        A semigroup that yields the maximum of integers.
        +
        • +
      + + + +
        +
      • +

        intMinimumSemigroup

        +
        public static final Semigroup<java.lang.Integer> intMinimumSemigroup
        +
        A semigroup that yields the minimum of integers.
        +
        • +
      + + + +
        +
      • +

        bigintAdditionSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintAdditionSemigroup
        +
        A semigroup that adds big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMultiplicationSemigroup
        +
        A semigroup that multiplies big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMaximumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMaximumSemigroup
        +
        A semigroup that yields the maximum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigintMinimumSemigroup

        +
        public static final Semigroup<java.math.BigInteger> bigintMinimumSemigroup
        +
        A semigroup that yields the minimum of big integers.
        +
        • +
      + + + +
        +
      • +

        bigdecimalAdditionSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalAdditionSemigroup
        +
        A semigroup that adds big decimals.
        +
        • +
      + + + +
        +
      • +

        bigdecimalMultiplicationSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigdecimalMultiplicationSemigroup
        +
        A semigroup that multiplies big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMaximumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMaximumSemigroup
        +
        A semigroup that yields the maximum of big decimals.
        +
        • +
      + + + +
        +
      • +

        bigDecimalMinimumSemigroup

        +
        public static final Semigroup<java.math.BigDecimal> bigDecimalMinimumSemigroup
        +
        A semigroup that yields the minimum of big decimals.
        +
        • +
      + + + +
        +
      • +

        naturalMultiplicationSemigroup

        +
        public static final Semigroup<Natural> naturalMultiplicationSemigroup
        +
        A semigroup that multiplies natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalAdditionSemigroup

        +
        public static final Semigroup<Natural> naturalAdditionSemigroup
        +
        A semigroup that adds natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMaximumSemigroup

        +
        public static final Semigroup<Natural> naturalMaximumSemigroup
        +
        A semigroup that yields the maximum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        naturalMinimumSemigroup

        +
        public static final Semigroup<Natural> naturalMinimumSemigroup
        +
        A semigroup that yields the minimum of natural numbers.
        +
        • +
      + + + +
        +
      • +

        longAdditionSemigroup

        +
        public static final Semigroup<java.lang.Long> longAdditionSemigroup
        +
        A semigroup that adds longs.
        +
        • +
      + + + +
        +
      • +

        longMultiplicationSemigroup

        +
        public static final Semigroup<java.lang.Long> longMultiplicationSemigroup
        +
        A semigroup that multiplies longs.
        +
        • +
      + + + +
        +
      • +

        longMaximumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMaximumSemigroup
        +
        A semigroup that yields the maximum of longs.
        +
        • +
      + + + +
        +
      • +

        longMinimumSemigroup

        +
        public static final Semigroup<java.lang.Long> longMinimumSemigroup
        +
        A semigroup that yields the minimum of longs.
        +
        • +
      + + + +
        +
      • +

        disjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> disjunctionSemigroup
        +
        A semigroup that ORs booleans.
        +
        • +
      + + + +
        +
      • +

        exclusiveDisjunctionSemiGroup

        +
        public static final Semigroup<java.lang.Boolean> exclusiveDisjunctionSemiGroup
        +
        A semigroup that XORs booleans.
        +
        • +
      + + + +
        +
      • +

        conjunctionSemigroup

        +
        public static final Semigroup<java.lang.Boolean> conjunctionSemigroup
        +
        A semigroup that ANDs booleans.
        +
        • +
      + + + +
        +
      • +

        stringSemigroup

        +
        public static final Semigroup<java.lang.String> stringSemigroup
        +
        A semigroup that appends strings.
        +
        • +
      + + + +
        +
      • +

        stringBufferSemigroup

        +
        public static final Semigroup<java.lang.StringBuffer> stringBufferSemigroup
        +
        A semigroup that appends string buffers.
        +
        • +
      + + + +
        +
      • +

        stringBuilderSemigroup

        +
        public static final Semigroup<java.lang.StringBuilder> stringBuilderSemigroup
        +
        A semigroup that appends string builders.
        +
        • +
      + + + +
        +
      • +

        unitSemigroup

        +
        public static final Semigroup<Unit> unitSemigroup
        +
        A semigroup for the Unit value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        sum

        +
        public A sum(A a1,
+             A a2)
        +
        Sums the two given arguments.
        +
        +
        Parameters:
        +
        a1 - A value to sum with another.
        +
        a2 - A value to sum with another.
        +
        Returns:
        +
        The of the two given arguments.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public F<A,A> sum(A a1)
        +
        Returns a function that sums the given value according to this semigroup.
        +
        +
        Parameters:
        +
        a1 - The value to sum.
        +
        Returns:
        +
        A function that sums the given value according to this semigroup.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public F<A,F<A,A>> sum()
        +
        Returns a function that sums according to this semigroup.
        +
        +
        Returns:
        +
        A function that sums according to this semigroup.
        +
        +
        • +
      + + + + + +
        +
      • +

        multiply1p

        +
        public A multiply1p(int n,
+                    A a)
        +
        Returns a value summed n + 1 times ( + a + a + ... + a) The default definition uses peasant + multiplication, exploiting associativity to only require O(log n) uses of + sum(Object, Object).
        +
        +
        Parameters:
        +
        n - multiplier
        +
        a - the value to be reapeatly summed n + 1 times
        +
        Returns:
        +
        a summed n times. If n <= 0, returns + zero()
        +
        +
        • +
      + + + +
        +
      • +

        sumNel

        +
        public A sumNel(NonEmptyList<A> as)
        +
        Sums the given values with left-fold.
        +
        • +
      + + + + + +
        +
      • +

        sumStream

        +
        public A sumStream(A a,
+                   F0<Stream<A>> as)
        +
        Sums the given values with left-fold, shortcutting the computation as early as possible.
        +
        • +
      + + + +
        +
      • +

        dual

        +
        public Semigroup<A> dual()
        +
        Swaps the arguments when summing.
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public Monoid<Option<A>> lift()
        +
        Lifts the semigroup to obtain a trivial monoid.
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Semigroup<B> xmap(F<A,B> f,
+                             F<B,A> g)
        +
        Maps the given functions across this monoid as an invariant functor.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        A new monoid.
        +
        +
        • +
      + + + + + + + + + +
        +
      • +

        monoid

        +
        public Monoid<A> monoid(A zero)
        +
        Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
        +
        +
        Parameters:
        +
        zero - The zero for the monoid.
        +
        Returns:
        +
        A monoid instance that uses the given sun function and zero value.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.Definition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroupDef

        +
        public static <A> Semigroup<A> semigroupDef(Semigroup.AltDefinition<A> def)
        +
        Constructs a semigroup from the given definition.
        +
        +
        Parameters:
        +
        def - The definition to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given definition.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F<A,F<A,A>> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(AltDefinition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        semigroup

        +
        public static <A> Semigroup<A> semigroup(F2<A,A,A> sum)
        +
        Constructs a semigroup from the given function. + Java 8+ users: use semigroupDef(Definition) instead.
        +
        +
        Parameters:
        +
        sum - The function to construct this semigroup with.
        +
        Returns:
        +
        A semigroup from the given function.
        +
        +
        • +
      + + + +
        +
      • +

        firstSemigroup

        +
        public static <A> Semigroup<A> firstSemigroup()
        +
        A semigroup which always uses the "first" (left-hand side) value.
        +
        • +
      + + + +
        +
      • +

        lastSemigroup

        +
        public static <A> Semigroup<A> lastSemigroup()
        +
        A semigroup which always uses the "last" (right-hand side) value.
        +
        • +
      + + + +
        +
      • +

        functionSemigroup

        +
        public static <A,B> Semigroup<F<A,B>> functionSemigroup(Semigroup<B> sb)
        +
        A semigroup for functions.
        +
        +
        Parameters:
        +
        sb - The smeigroup for the codomain.
        +
        Returns:
        +
        A semigroup for functions.
        +
        +
        • +
      + + + +
        +
      • +

        listSemigroup

        +
        public static <A> Semigroup<List<A>> listSemigroup()
        +
        A semigroup for lists.
        +
        +
        Returns:
        +
        A semigroup for lists.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListSemigroup

        +
        public static <A> Semigroup<NonEmptyList<A>> nonEmptyListSemigroup()
        +
        A semigroup for non-empty lists.
        +
        +
        Returns:
        +
        A semigroup for non-empty lists.
        +
        +
        • +
      + + + +
        +
      • +

        firstOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> firstOptionSemigroup()
        +
        A semigroup for optional values that take the first available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the first available value.
        +
        +
        • +
      + + + +
        +
      • +

        lastOptionSemigroup

        +
        public static <A> Semigroup<Option<A>> lastOptionSemigroup()
        +
        A semigroup for optional values that take the last available value.
        +
        +
        Returns:
        +
        A semigroup for optional values that take the last available value.
        +
        +
        • +
      + + + +
        +
      • +

        streamSemigroup

        +
        public static <A> Semigroup<Stream<A>> streamSemigroup()
        +
        A semigroup for streams.
        +
        +
        Returns:
        +
        A semigroup for streams.
        +
        +
        • +
      + + + +
        +
      • +

        arraySemigroup

        +
        public static <A> Semigroup<Array<A>> arraySemigroup()
        +
        A semigroup for arrays.
        +
        +
        Returns:
        +
        A semigroup for arrays.
        +
        +
        • +
      + + + +
        +
      • +

        p1Semigroup

        +
        public static <A> Semigroup<P1<A>> p1Semigroup(Semigroup<A> sa)
        +
        A lazy semigroup for unary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's type.
        +
        Returns:
        +
        A semigroup for unary products.
        +
        +
        • +
      + + + +
        +
      • +

        p2Semigroup

        +
        public static <A,B> Semigroup<P2<A,B>> p2Semigroup(Semigroup<A> sa,
+                                                   Semigroup<B> sb)
        +
        A lazy semigroup for binary products.
        +
        +
        Parameters:
        +
        sa - A semigroup for the product's first type.
        +
        sb - A semigroup for the product's second type.
        +
        Returns:
        +
        A semigroup for binary products.
        +
        +
        • +
      + + + +
        +
      • +

        ioSemigroup

        +
        public static <A> Semigroup<IO<A>> ioSemigroup(Semigroup<A> sa)
        +
        A semigroup for IO values.
        +
        • +
      + + + +
        +
      • +

        setSemigroup

        +
        public static <A> Semigroup<Set<A>> setSemigroup()
        +
        A union semigroup for sets.
        +
        +
        Returns:
        +
        a semigroup for sets.
        +
        +
        • +
      + + + +
        +
      • +

        setIntersectionSemigroup

        +
        public static <A> Semigroup<Set<A>> setIntersectionSemigroup()
        +
        A intersection semigroup for sets.
        +
        +
        Returns:
        +
        a semigroup for sets.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Show.html b/javadoc/5.0/functionaljava/fj/Show.html new file mode 100644 index 0000000..5463143 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Show.html @@ -0,0 +1,1775 @@ + + + + + +Show (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj
+

Class Show<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Show<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Show<A>
+extends java.lang.Object
    +
    Renders an object for display.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanShow

        +
        public static final Show<java.lang.Boolean> booleanShow
        +
        A show instance for the boolean type.
        +
        • +
      + + + +
        +
      • +

        byteShow

        +
        public static final Show<java.lang.Byte> byteShow
        +
        A show instance for the byte type.
        +
        • +
      + + + +
        +
      • +

        charShow

        +
        public static final Show<java.lang.Character> charShow
        +
        A show instance for the char type.
        +
        • +
      + + + +
        +
      • +

        doubleShow

        +
        public static final Show<java.lang.Double> doubleShow
        +
        A show instance for the double type.
        +
        • +
      + + + +
        +
      • +

        floatShow

        +
        public static final Show<java.lang.Float> floatShow
        +
        A show instance for the float type.
        +
        • +
      + + + +
        +
      • +

        intShow

        +
        public static final Show<java.lang.Integer> intShow
        +
        A show instance for the int type.
        +
        • +
      + + + +
        +
      • +

        bigintShow

        +
        public static final Show<java.math.BigInteger> bigintShow
        +
        A show instance for the BigInteger type.
        +
        • +
      + + + +
        +
      • +

        bigdecimalShow

        +
        public static final Show<java.math.BigDecimal> bigdecimalShow
        +
        A show instance for the BigDecimal type.
        +
        • +
      + + + +
        +
      • +

        longShow

        +
        public static final Show<java.lang.Long> longShow
        +
        A show instance for the long type.
        +
        • +
      + + + +
        +
      • +

        shortShow

        +
        public static final Show<java.lang.Short> shortShow
        +
        A show instance for the short type.
        +
        • +
      + + + +
        +
      • +

        stringShow

        +
        public static final Show<java.lang.String> stringShow
        +
        A show instance for the String type.
        +
        • +
      + + + +
        +
      • +

        stringBufferShow

        +
        public static final Show<java.lang.StringBuffer> stringBufferShow
        +
        A show instance for the StringBuffer type.
        +
        • +
      + + + +
        +
      • +

        stringBuilderShow

        +
        public static final Show<java.lang.StringBuilder> stringBuilderShow
        +
        A show instance for the StringBuilder type.
        +
        • +
      + + + +
        +
      • +

        naturalShow

        +
        public static final Show<Natural> naturalShow
        +
        A show instance for natural numbers.
        +
        • +
      + + + +
        +
      • +

        lazyStringShow

        +
        public static final Show<LazyString> lazyStringShow
        +
        A show instance for lazy strings.
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static final Show<HList.HNil> HListShow
        +
        A show instance for the empty heterogeneous Stream.
        +
        • +
      + + + +
        +
      • +

        bitSetShow

        +
        public static final Show<BitSet> bitSetShow
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        contramap

        +
        public <B> Show<B> contramap(F<B,A> f)
        +
        Maps the given function across this show as a contra-variant functor.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new show.
        +
        +
        • +
      + + + + + +
        +
      • +

        show

        +
        public Stream<java.lang.Character> show(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showl

        +
        public List<java.lang.Character> showl(A a)
        +
        Returns the display rendering of the given argument.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        showS

        +
        public java.lang.String showS(A a)
        +
        Returns the display rendering of the given argument as a String.
        +
        +
        Parameters:
        +
        a - The argument to display.
        +
        Returns:
        +
        The display rendering of the given argument as a String.
        +
        +
        • +
      + + + +
        +
      • +

        showS_

        +
        public F<A,java.lang.String> showS_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + +
        +
      • +

        show_

        +
        public F<A,Stream<java.lang.Character>> show_()
        +
        Returns the transformation equivalent to this show.
        +
        +
        Returns:
        +
        the transformation equivalent to this show.
        +
        +
        • +
      + + + + + +
        +
      • +

        println

        +
        public Unit println(A a)
        +
        Prints the given argument to the standard output stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        print

        +
        public Unit print(A a)
        +
        Prints the given argument to the standard output stream.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        printlnE

        +
        public void printlnE(A a)
        +
        Prints the given argument to the standard error stream with a new line.
        +
        +
        Parameters:
        +
        a - The argument to print.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<A> show(F<A,Stream<java.lang.Character>> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        showS

        +
        public static <A> Show<A> showS(F<A,java.lang.String> f)
        +
        Returns a show instance using the given function.
        +
        +
        Parameters:
        +
        f - The function to use for the returned show instance.
        +
        Returns:
        +
        A show instance.
        +
        +
        • +
      + + + +
        +
      • +

        anyShow

        +
        public static <A> Show<A> anyShow()
        +
        Returns a show instance that uses Object.toString() to perform the display rendering.
        +
        +
        Returns:
        +
        A show instance that uses Object.toString() to perform the display rendering.
        +
        +
        • +
      + + + +
        +
      • +

        optionShow

        +
        public static <A> Show<Option<A>> optionShow(Show<A> sa)
        +
        A show instance for the Option type.
        +
        +
        Parameters:
        +
        sa - Show for the element of the option.
        +
        Returns:
        +
        A show instance for the Option type.
        +
        +
        • +
      + + + +
        +
      • +

        eitherShow

        +
        public static <A,B> Show<Either<A,B>> eitherShow(Show<A> sa,
+                                                 Show<B> sb)
        +
        A show instance for the Either type.
        +
        +
        Parameters:
        +
        sa - Show for the left side of the Either.
        +
        sb - Show for the right side of the Either.
        +
        Returns:
        +
        A show instance for the Either type.
        +
        +
        • +
      + + + +
        +
      • +

        either3Show

        +
        public static <A,B,C> Show<Either3<A,B,C>> either3Show(Show<A> sa,
+                                                       Show<B> sb,
+                                                       Show<C> sc)
        +
        • +
      + + + +
        +
      • +

        resultShow

        +
        public static <I,A> Show<Result<I,A>> resultShow(Show<A> sa,
+                                                 Show<I> si)
        +
        A show instance for the Result type.
        +
        +
        Parameters:
        +
        sa - Show for the Result value.
        +
        si - Show for the Result remainder.
        +
        Returns:
        +
        A show instance for the Result type.
        +
        +
        • +
      + + + +
        +
      • +

        validationShow

        +
        public static <A,B> Show<Validation<A,B>> validationShow(Show<A> sa,
+                                                         Show<B> sb)
        +
        A show instance for the Validation type.
        +
        +
        Parameters:
        +
        sa - Show for the fail side of the Validation.
        +
        sb - Show for the success side of the Validation.
        +
        Returns:
        +
        A show instance for the Validation type.
        +
        +
        • +
      + + + +
        +
      • +

        listShow

        +
        public static <A> Show<List<A>> listShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the Stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        nonEmptyListShow

        +
        public static <A> Show<NonEmptyList<A>> nonEmptyListShow(Show<A> sa)
        +
        A show instance for the NonEmptyList type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the non-empty Stream.
        +
        Returns:
        +
        A show instance for the NonEmptyList type.
        +
        +
        • +
      + + + +
        +
      • +

        treeShow

        +
        public static <A> Show<Tree<A>> treeShow(Show<A> sa)
        +
        A show instance for the Tree type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the tree.
        +
        Returns:
        +
        A show instance for the Tree type.
        +
        +
        • +
      + + + +
        +
      • +

        digitShow

        +
        public static <V,A> Show<Digit<V,A>> digitShow(Show<V> sv,
+                                               Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        nodeShow

        +
        public static <V,A> Show<Node<V,A>> nodeShow(Show<V> sv,
+                                             Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        fingerTreeShow

        +
        public static <V,A> Show<FingerTree<V,A>> fingerTreeShow(Show<V> sv,
+                                                         Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        seqShow

        +
        public static <A> Show<Seq<A>> seqShow(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        setShow

        +
        public static <A> Show<Set<A>> setShow(Show<A> sa)
        +
        A show instance for the Set type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the set.
        +
        Returns:
        +
        A show instance for the Set type.
        +
        +
        • +
      + + + +
        +
      • +

        treeMapShow

        +
        public static <K,V> Show<TreeMap<K,V>> treeMapShow(Show<K> sk,
+                                                   Show<V> sv)
        +
        A show instance for the TreeMap type.
        +
        +
        Parameters:
        +
        sk - Show for the keys of the TreeMap.
        +
        sv - Show for the values of the TreeMap.
        +
        Returns:
        +
        A show instance for the TreeMap type.
        +
        +
        • +
      + + + +
        +
      • +

        p2MapShow

        +
        public static <A,B> Show<P2<A,B>> p2MapShow(Show<A> sa,
+                                            Show<B> sb)
        +
        A show instance for the tuple-2 type in the style of a mapping from A to B.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb,
+                                         java.lang.String start,
+                                         java.lang.String sep,
+                                         java.lang.String end)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the tuple.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the stream.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow

        +
        public static <A> Show<Stream<A>> streamShow(Show<A> sa,
+                                             java.lang.String start,
+                                             java.lang.String sep,
+                                             java.lang.String end)
        +
        A show instance for the Stream type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        start - Prefix string for the show.
        +
        sep - Separator string between elements of the stream.
        +
        end - Suffix string for the show.
        +
        Returns:
        +
        A show instance for the Stream type.
        +
        +
        • +
      + + + +
        +
      • +

        streamShow_

        +
        public static <A> F<Stream<A>,Stream<java.lang.Character>> streamShow_(Show<A> sa,
+                                                                       java.lang.String start,
+                                                                       java.lang.String sep,
+                                                                       java.lang.String end)
        +
        Returns the transformation equivalent for the stream show.
        +
        • +
      + + + +
        +
      • +

        arrayShow

        +
        public static <A> Show<Array<A>> arrayShow(Show<A> sa)
        +
        A show instance for the Array type.
        +
        +
        Parameters:
        +
        sa - Show for the elements of the array.
        +
        Returns:
        +
        A show instance for the Array type.
        +
        +
        • +
      + + + +
        +
      • +

        classShow

        +
        public static <A> Show<Class<A>> classShow()
        +
        A show instance for the Class type.
        +
        +
        Returns:
        +
        A show instance for the Class type.
        +
        +
        • +
      + + + +
        +
      • +

        p1Show

        +
        public static <A> Show<P1<A>> p1Show(Show<A> sa)
        +
        A show instance for the tuple-1 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-1 type.
        +
        +
        • +
      + + + +
        +
      • +

        p1ShowLazy

        +
        public static <A> Show<P1<A>> p1ShowLazy(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p1ShowEager

        +
        public static <A> Show<P1<A>> p1ShowEager(Show<A> sa)
        +
        • +
      + + + +
        +
      • +

        p2Show

        +
        public static <A,B> Show<P2<A,B>> p2Show(Show<A> sa,
+                                         Show<B> sb)
        +
        A show instance for the tuple-2 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-2 type.
        +
        +
        • +
      + + + +
        +
      • +

        p3Show

        +
        public static <A,B,C> Show<P3<A,B,C>> p3Show(Show<A> sa,
+                                             Show<B> sb,
+                                             Show<C> sc)
        +
        A show instance for the tuple-3 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-3 type.
        +
        +
        • +
      + + + +
        +
      • +

        p4Show

        +
        public static <A,B,C,D> Show<P4<A,B,C,D>> p4Show(Show<A> sa,
+                                                 Show<B> sb,
+                                                 Show<C> sc,
+                                                 Show<D> sd)
        +
        A show instance for the tuple-4 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-4 type.
        +
        +
        • +
      + + + +
        +
      • +

        p5Show

        +
        public static <A,B,C,D,E> Show<P5<A,B,C,D,E>> p5Show(Show<A> sa,
+                                                     Show<B> sb,
+                                                     Show<C> sc,
+                                                     Show<D> sd,
+                                                     Show<E> se)
        +
        A show instance for the tuple-5 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-5 type.
        +
        +
        • +
      + + + +
        +
      • +

        p6Show

        +
        public static <A,B,C,D,E,F$> Show<P6<A,B,C,D,E,F$>> p6Show(Show<A> sa,
+                                                           Show<B> sb,
+                                                           Show<C> sc,
+                                                           Show<D> sd,
+                                                           Show<E> se,
+                                                           Show<F$> sf)
        +
        A show instance for the tuple-6 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-6 type.
        +
        +
        • +
      + + + +
        +
      • +

        p7Show

        +
        public static <A,B,C,D,E,F$,G> Show<P7<A,B,C,D,E,F$,G>> p7Show(Show<A> sa,
+                                                               Show<B> sb,
+                                                               Show<C> sc,
+                                                               Show<D> sd,
+                                                               Show<E> se,
+                                                               Show<F$> sf,
+                                                               Show<G> sg)
        +
        A show instance for the tuple-7 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-7 type.
        +
        +
        • +
      + + + +
        +
      • +

        p8Show

        +
        public static <A,B,C,D,E,F$,G,H> Show<P8<A,B,C,D,E,F$,G,H>> p8Show(Show<A> sa,
+                                                                   Show<B> sb,
+                                                                   Show<C> sc,
+                                                                   Show<D> sd,
+                                                                   Show<E> se,
+                                                                   Show<F$> sf,
+                                                                   Show<G> sg,
+                                                                   Show<H> sh)
        +
        A show instance for the tuple-8 type.
        +
        +
        Parameters:
        +
        sa - Show for the first element of the tuple.
        +
        sb - Show for the second element of the tuple.
        +
        sc - Show for the third element of the tuple.
        +
        sd - Show for the fourth element of the tuple.
        +
        se - Show for the fifth element of the tuple.
        +
        sf - Show for the sixth element of the tuple.
        +
        sg - Show for the seventh element of the tuple.
        +
        sh - Show for the eighth element of the tuple.
        +
        Returns:
        +
        A show instance for the tuple-8 type.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        v2Show

        +
        public static <A> Show<V2<A>> v2Show(Show<A> ea)
        +
        A show instance for a vector-2.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v3Show

        +
        public static <A> Show<V3<A>> v3Show(Show<A> ea)
        +
        A show instance for a vector-3.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v4Show

        +
        public static <A> Show<V4<A>> v4Show(Show<A> ea)
        +
        A show instance for a vector-4.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v5Show

        +
        public static <A> Show<V5<A>> v5Show(Show<A> ea)
        +
        A show instance for a vector-5.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v6Show

        +
        public static <A> Show<V6<A>> v6Show(Show<A> ea)
        +
        A show instance for a vector-6.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        v7Show

        +
        public static <A> Show<V7<A>> v7Show(Show<A> ea)
        +
        A show instance for a vector-7.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        v8Show

        +
        public static <A> Show<V8<A>> v8Show(Show<A> ea)
        +
        A show instance for a vector-8.
        +
        +
        Parameters:
        +
        ea - A show for the elements of the vector.
        +
        Returns:
        +
        A show instance for a vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        unlineShow

        +
        public static <A> Show<Stream<A>> unlineShow(Show<A> sa)
        +
        A show instance for streams that splits into lines.
        +
        +
        Parameters:
        +
        sa - A show instance for the elements of a stream.
        +
        Returns:
        +
        A show instance for streams that splits into lines.
        +
        +
        • +
      + + + +
        +
      • +

        HListShow

        +
        public static <E,L extends HList<L>> Show<HList.HCons<E,L>> HListShow(Show<E> e,
+                                                                      Show<L> l)
        +
        A show instance for heterogeneous Streams.
        +
        +
        Parameters:
        +
        e - A show instance for the first element of the Stream.
        +
        l - A show instance for the rest of the Stream.
        +
        Returns:
        +
        a show instance for heterogeneous Streams.
        +
        +
        • +
      + + + +
        +
      • +

        hamtNodeShow

        +
        public static <K,V> Show<Node<K,V>> hamtNodeShow(Show<K> sk,
+                                                 Show<V> sv)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Try.html b/javadoc/5.0/functionaljava/fj/Try.html new file mode 100644 index 0000000..ab234a3 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Try.html @@ -0,0 +1,432 @@ + + + + + +Try (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Try

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Try
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Try
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,E extends java.lang.Exception>
      P1<Validation<E,A>>      		f(Try0<A,E> t) +
      Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,E extends java.lang.Exception>
      F<A,Validation<E,B>>      		f(Try1<A,B,E> t) +
      Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,E extends java.lang.Exception>
      F2<A,B,Validation<E,C>>      		f(Try2<A,B,C,E> t) +
      Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E extends java.lang.Exception>
      F3<A,B,C,Validation<E,D>>      		f(Try3<A,B,C,D,E> t) +
      Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,Z extends java.lang.Exception>
      F4<A,B,C,D,Validation<Z,E>>      		f(Try4<A,B,C,D,E,Z> t) +
      Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,Z extends java.lang.Exception>
      F5<A,B,C,D,E,Validation<Z,F>>      		f(Try5<A,B,C,D,E,F,Z> t) +
      Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,Z extends java.lang.Exception>
      F6<A,B,C,D,E,F,Validation<Z,G>>      		f(Try6<A,B,C,D,E,F,G,Z> t) +
      Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
      F7<A,B,C,D,E,F,G,Validation<Z,H>>      		f(Try7<A,B,C,D,E,F,G,H,Z> t) +
      Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
      F8<A,B,C,D,E,F,G,H,Validation<Z,I>>      		f(Try8<A,B,C,D,E,F,G,H,I,Z> t) +
      Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
      +
      static <A> IO<A>io(Try0<A,? extends java.io.IOException> t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public static <A,E extends java.lang.Exception> P1<Validation<E,A>> f(Try0<A,E> t)
        +
        Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try0 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,E extends java.lang.Exception> F<A,Validation<E,B>> f(Try1<A,B,E> t)
        +
        Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try1 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,E extends java.lang.Exception> F2<A,B,Validation<E,C>> f(Try2<A,B,C,E> t)
        +
        Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try2 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E extends java.lang.Exception> F3<A,B,C,Validation<E,D>> f(Try3<A,B,C,D,E> t)
        +
        Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try3 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,Z extends java.lang.Exception> F4<A,B,C,D,Validation<Z,E>> f(Try4<A,B,C,D,E,Z> t)
        +
        Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try4 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,Z extends java.lang.Exception> F5<A,B,C,D,E,Validation<Z,F>> f(Try5<A,B,C,D,E,F,Z> t)
        +
        Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try5 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,Z extends java.lang.Exception> F6<A,B,C,D,E,F,Validation<Z,G>> f(Try6<A,B,C,D,E,F,G,Z> t)
        +
        Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try6 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,Z extends java.lang.Exception> F7<A,B,C,D,E,F,G,Validation<Z,H>> f(Try7<A,B,C,D,E,F,G,H,Z> t)
        +
        Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try7 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> F8<A,B,C,D,E,F,G,H,Validation<Z,I>> f(Try8<A,B,C,D,E,F,G,H,I,Z> t)
        +
        Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
        +
        +
        Parameters:
        +
        t - A Try8 to promote
        +
        Returns:
        +
        A Validation with an Exception on the failure side and its result on the success side.
        +
        +
        • +
      + + + +
        +
      • +

        io

        +
        public static <A> IO<A> io(Try0<A,? extends java.io.IOException> t)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/TryEffect.html b/javadoc/5.0/functionaljava/fj/TryEffect.html new file mode 100644 index 0000000..9e377f5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/TryEffect.html @@ -0,0 +1,338 @@ + + + + + +TryEffect (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class TryEffect

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.TryEffect
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class TryEffect
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Unit.html b/javadoc/5.0/functionaljava/fj/Unit.html new file mode 100644 index 0000000..9cec5aa --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Unit.html @@ -0,0 +1,259 @@ + + + + + +Unit (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Unit

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Unit
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Unit
+extends java.lang.Object
    +
    The unit type which has only one value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringtoString() 
      static Unitunit() +
      The only value of the unit type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static Unit unit()
        +
        The only value of the unit type.
        +
        +
        Returns:
        +
        The only value of the unit type.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/Void.html b/javadoc/5.0/functionaljava/fj/Void.html new file mode 100644 index 0000000..af30ae4 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/Void.html @@ -0,0 +1,238 @@ + + + + + +Void (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj
+

Class Void

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.Void
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Void
+extends java.lang.Object
    +
    A logically uninhabited data type.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract <X> Xabsurd() +
      Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        absurd

        +
        public abstract <X> X absurd()
        +
        Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/Trampoline.html b/javadoc/5.0/functionaljava/fj/control/Trampoline.html new file mode 100644 index 0000000..305bf55 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/Trampoline.html @@ -0,0 +1,603 @@ + + + + + +Trampoline (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control
+

Class Trampoline<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.Trampoline<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Trampoline<A>
+extends java.lang.Object
    +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack. + It represents suspendable coroutines with subroutine calls, reified as a data structure.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Trampoline

        +
        public Trampoline()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pure

        +
        public static <A> F<A,Trampoline<A>> pure()
        +
        +
        Returns:
        +
        The first-class version of pure.
        +
        +
        • +
      + + + + + +
        +
      • +

        pure

        +
        public static <A> Trampoline<A> pure(A a)
        +
        Constructs a pure computation that results in the given value.
        +
        +
        Parameters:
        +
        a - The value of the result.
        +
        Returns:
        +
        A trampoline that results in the given value.
        +
        +
        • +
      + + + +
        +
      • +

        suspend

        +
        public static <A> Trampoline<A> suspend(F0<Trampoline<A>> a)
        +
        Suspends the given computation in a thunk.
        +
        +
        Parameters:
        +
        a - A trampoline suspended in a thunk.
        +
        Returns:
        +
        A trampoline whose next step runs the given thunk.
        +
        +
        • +
      + + + +
        +
      • +

        suspend

        +
        public static <A> Trampoline<A> suspend(P1<Trampoline<A>> a)
        +
        Suspends the given computation in a thunk.
        +
        +
        Parameters:
        +
        a - A trampoline suspended in a thunk.
        +
        Returns:
        +
        A trampoline whose next step runs the given thunk.
        +
        +
        • +
      + + + +
        +
      • +

        suspend_

        +
        public static <A> F<P1<Trampoline<A>>,Trampoline<A>> suspend_()
        +
        +
        Returns:
        +
        The first-class version of suspend.
        +
        +
        • +
      + + + +
        +
      • +

        fold

        +
        protected abstract <R> R fold(F<fj.control.Trampoline.Normal<A>,R> n,
+                              F<fj.control.Trampoline.Codense<A>,R> gs)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public abstract <B> Trampoline<B> bind(F<A,Trampoline<B>> f)
        +
        Binds the given continuation to the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that constructs a trampoline from the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then continues with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Trampoline<B> map(F<A,B> f)
        +
        Maps the given function across the result of this trampoline.
        +
        +
        Parameters:
        +
        f - A function that gets applied to the result of this trampoline.
        +
        Returns:
        +
        A new trampoline that runs this trampoline, then applies the given function to the result.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Trampoline<A>,Trampoline<B>>> map_()
        +
        +
        Returns:
        +
        The first-class version of map.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        resume

        +
        public abstract Either<P1<Trampoline<A>>,A> resume()
        +
        Runs a single step of this computation.
        +
        +
        Returns:
        +
        The next step of this compuation.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public final A run()
        +
        Runs this computation all the way to the end, in constant stack.
        +
        +
        Returns:
        +
        The end result of this computation.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Trampoline<B> apply(Trampoline<F<A,B>> lf)
        +
        Performs function application within a Trampoline (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - A Trampoline resulting in the function to apply.
        +
        Returns:
        +
        A new Trampoline after applying the given function through this Trampoline.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Trampoline<C> bind(Trampoline<B> lb,
+                                      F<A,F<B,C>> f)
        +
        Binds the given function across the result of this Trampoline and the given Trampoline.
        +
        +
        Parameters:
        +
        lb - A given Trampoline to bind the given function with.
        +
        f - The function to combine the results of this Trampoline and the given Trampoline.
        +
        Returns:
        +
        A new Trampoline combining the results of the two trampolines with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Trampoline<A>,F<Trampoline<B>,Trampoline<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on Trampolines.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on Trampolines.
        +
        Returns:
        +
        The given function, promoted to operate on Trampolines.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Trampoline<C> zipWith(Trampoline<B> b,
+                                         F2<A,B,C> f)
        +
        Combines two trampolines so they run cooperatively. The results are combined with the given function.
        +
        +
        Parameters:
        +
        b - Another trampoline to combine with this trampoline.
        +
        f - A function to combine the results of the two trampolines.
        +
        Returns:
        +
        A new trampoline that runs this trampoline and the given trampoline simultaneously.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/db/Connector.html b/javadoc/5.0/functionaljava/fj/control/db/Connector.html new file mode 100644 index 0000000..8cf1e24 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/Connector.html @@ -0,0 +1,274 @@ + + + + + +Connector (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class Connector

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.Connector
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Connector
+extends java.lang.Object
    +
    A method of connecting to the database.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Connector() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract java.sql.Connectionconnect() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Connector

        +
        public Connector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        connect

        +
        public abstract java.sql.Connection connect()
+                                     throws java.sql.SQLException
        +
        +
        Throws:
        +
        java.sql.SQLException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/db/DB.html b/javadoc/5.0/functionaljava/fj/control/db/DB.html new file mode 100644 index 0000000..23be2bd --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/DB.html @@ -0,0 +1,458 @@ + + + + + +DB (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.control.db
+

Class DB<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DB<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class DB<A>
+extends java.lang.Object
    +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DB() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      F<java.sql.Connection,java.util.concurrent.Callable<A>>asFunction() +
      Returns the callable-valued function projection of this database action.
      +
      <B> DB<B>bind(F<A,DB<B>> f) +
      Binds the given action across the result of this database action.
      +
      static <A> DB<A>db(F<java.sql.Connection,A> f) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>db(Try1<java.sql.Connection,A,java.sql.SQLException> t) +
      Constructs a database action as a function from a database connection to a value.
      +
      static <A> DB<A>join(DB<DB<A>> a) +
      Removes one layer of monadic structure.
      +
      static <A,B> F<DB<A>,DB<B>>liftM(F<A,B> f) +
      Promotes any given function so that it transforms between values in the database.
      +
      <B> DB<B>map(F<A,B> f) +
      Map a function over the result of this action.
      +
      abstract Arun(java.sql.Connection c) +
      Executes the database action, given a database connection.
      +
      static <A> DB<A>unit(A a) +
      Constructs a database action that returns the given value completely intact.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DB

        +
        public DB()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public abstract A run(java.sql.Connection c)
+               throws java.sql.SQLException
        +
        Executes the database action, given a database connection.
        +
        +
        Parameters:
        +
        c - The connection against which to execute the action.
        +
        Returns:
        +
        The result of the action.
        +
        Throws:
        +
        java.sql.SQLException - if a database error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(F<java.sql.Connection,A> f)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        f - A function from a database connection to a value.
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        db

        +
        public static <A> DB<A> db(Try1<java.sql.Connection,A,java.sql.SQLException> t)
        +
        Constructs a database action as a function from a database connection to a value.
        +
        +
        Parameters:
        +
        t - A function from a database connection to a value allowed to throw + SQLException
        +
        Returns:
        +
        A database action representing the given function.
        +
        +
        • +
      + + + +
        +
      • +

        asFunction

        +
        public final F<java.sql.Connection,java.util.concurrent.Callable<A>> asFunction()
        +
        Returns the callable-valued function projection of this database action.
        +
        +
        Returns:
        +
        The callable-valued function which is isomorphic to this database action.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> DB<B> map(F<A,B> f)
        +
        Map a function over the result of this action.
        +
        +
        Parameters:
        +
        f - The function to map over the result.
        +
        Returns:
        +
        A new database action that applies the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        liftM

        +
        public static <A,B> F<DB<A>,DB<B>> liftM(F<A,B> f)
        +
        Promotes any given function so that it transforms between values in the database.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function equivalent to the given one, which operates on values in the database.
        +
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> DB<A> unit(A a)
        +
        Constructs a database action that returns the given value completely intact.
        +
        +
        Parameters:
        +
        a - A value to be wrapped in a database action.
        +
        Returns:
        +
        A new database action that returns the given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> DB<B> bind(F<A,DB<B>> f)
        +
        Binds the given action across the result of this database action.
        +
        +
        Parameters:
        +
        f - The function to bind across the result of this database action.
        +
        Returns:
        +
        A new database action equivalent to applying the given function to the result of this action.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> DB<A> join(DB<DB<A>> a)
        +
        Removes one layer of monadic structure.
        +
        +
        Parameters:
        +
        a - A database action that results in another.
        +
        Returns:
        +
        A new database action equivalent to the result of the given action.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/db/DbState.html b/javadoc/5.0/functionaljava/fj/control/db/DbState.html new file mode 100644 index 0000000..24b2db0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/DbState.html @@ -0,0 +1,357 @@ + + + + + +DbState (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.db
+

Class DbState

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.db.DbState
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DbState
+extends java.lang.Object
    +
    Performs database I/O, in order to read or write the database state.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ConnectordriverManager(java.lang.String url) +
      A simple connector (the default) that gets connections to the given database URL from the driver manager.
      +
      static DbStatereader(Connector pc) +
      Returns a new reader that reads the database via the given Connector.
      +
      static DbStatereader(java.lang.String url) +
      Creates a database state reader given a connection URL.
      +
      <A> Arun(DB<A> dba) +
      Runs the given database action as a single transaction.
      +
      static DbStatewriter(Connector pc) +
      Returns a new writer that writes the database via the given Connector.
      +
      static DbStatewriter(java.lang.String url) +
      Creates a database state writer given a connection URL.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        driverManager

        +
        public static Connector driverManager(java.lang.String url)
        +
        A simple connector (the default) that gets connections to the given database URL from the driver manager.
        +
        +
        Parameters:
        +
        url - The database URL to connect to.
        +
        Returns:
        +
        A connector that generates connections to the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(java.lang.String url)
        +
        Creates a database state reader given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state reader that reads the given database.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(java.lang.String url)
        +
        Creates a database state writer given a connection URL.
        +
        +
        Parameters:
        +
        url - The connection URL to the database.
        +
        Returns:
        +
        A database state writer that writes the given database.
        +
        +
        • +
      + + + +
        +
      • +

        reader

        +
        public static DbState reader(Connector pc)
        +
        Returns a new reader that reads the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new reader that reads the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        writer

        +
        public static DbState writer(Connector pc)
        +
        Returns a new writer that writes the database via the given Connector.
        +
        +
        Parameters:
        +
        pc - A connector with which to generate database connections.
        +
        Returns:
        +
        A new writer that writes the database via the given Connector.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public <A> A run(DB<A> dba)
+          throws java.sql.SQLException
        +
        Runs the given database action as a single transaction.
        +
        +
        Parameters:
        +
        dba - A database action to run.
        +
        Returns:
        +
        The result of running the action against the database.
        +
        Throws:
        +
        java.sql.SQLException - in case of a database error.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/db/package-frame.html b/javadoc/5.0/functionaljava/fj/control/db/package-frame.html new file mode 100644 index 0000000..09bef6d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/package-frame.html @@ -0,0 +1,21 @@ + + + + + +fj.control.db (core 5.0 API) + + + + +

fj.control.db

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/control/db/package-summary.html b/javadoc/5.0/functionaljava/fj/control/db/package-summary.html new file mode 100644 index 0000000..b207a9f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/package-summary.html @@ -0,0 +1,162 @@ + + + + + +fj.control.db (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.db

+
+
Abstractions for JDBC connections.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Connector +
    A method of connecting to the database.
    +
    DB<A> +
    The DB monad represents a database action, or a value within the context of a database connection.
    +
    DbState +
    Performs database I/O, in order to read or write the database state.
    +
    +
    • +
+ + + +

Package fj.control.db Description

+
Abstractions for JDBC connections.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/db/package-tree.html b/javadoc/5.0/functionaljava/fj/control/db/package-tree.html new file mode 100644 index 0000000..bb7cf63 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/db/package-tree.html @@ -0,0 +1,136 @@ + + + + + +fj.control.db Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.db

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/package-frame.html b/javadoc/5.0/functionaljava/fj/control/package-frame.html new file mode 100644 index 0000000..705942a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/package-frame.html @@ -0,0 +1,19 @@ + + + + + +fj.control (core 5.0 API) + + + + +

fj.control

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/control/package-summary.html b/javadoc/5.0/functionaljava/fj/control/package-summary.html new file mode 100644 index 0000000..ae59797 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/package-summary.html @@ -0,0 +1,150 @@ + + + + + +fj.control (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control

+
+
Functional control abstractions.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Trampoline<A> +
    A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
    +
    +
    • +
+ + + +

Package fj.control Description

+
Functional control abstractions.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/package-tree.html b/javadoc/5.0/functionaljava/fj/control/package-tree.html new file mode 100644 index 0000000..2278c00 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/package-tree.html @@ -0,0 +1,134 @@ + + + + + +fj.control Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/Actor.html b/javadoc/5.0/functionaljava/fj/control/parallel/Actor.html new file mode 100644 index 0000000..3c9f123 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/Actor.html @@ -0,0 +1,370 @@ + + + + + +Actor (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Actor<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Actor<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Actor<A>
+extends java.lang.Object
    +
    Light weight actors for Java. Concurrency is controlled by a parallel Strategy. + The Strategy serves as the Actor's execution engine, and as its mailbox. +

    + Given some effect, the Actor performs the effect on its messages using its Strategy, transforming them + into instances of fj.P1. The P1 represents a possibly running computation which is executing the effect. +

    + NOTE: A value of this type may generally process more than one message at a time, depending on its Strategy. + An actor is not thread-safe unless either its Effect imposes an order on incoming messages or its Strategy is + single-threaded. + + A queue actor which imposes an order on its messages is provided by the queueActor(fj.control.parallel.Strategy<fj.Unit>, fj.function.Effect1<T>) static method.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      P1<Unit>act(A a) +
      Pass a message to this actor, applying its side-effect to the message.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + Effect1<A> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      static <A> Actor<A>actor(Strategy<Unit> s, + F<A,P1<Unit>> e) +
      Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
      +
      <B> Actor<B>contramap(F<B,A> f) +
      Contravariant functor pattern.
      +
      Actor<Promise<A>>promise() +
      Transforms this actor to an actor on promises.
      +
      static <T> Actor<T>queueActor(Strategy<Unit> s, + Effect1<T> ea) +
      An Actor equipped with a queue and which is guaranteed to process one message at a time.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        queueActor

        +
        public static <T> Actor<T> queueActor(Strategy<Unit> s,
+                                      Effect1<T> ea)
        +
        An Actor equipped with a queue and which is guaranteed to process one message at a time. + With respect to an enqueueing actor or thread, this actor will process messages in the same order + as they are sent.
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 Effect1<A> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public static <A> Actor<A> actor(Strategy<Unit> s,
+                                 F<A,P1<Unit>> e)
        +
        Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        Parameters:
        +
        s - The parallelization strategy to use for the new Actor.
        +
        e - The function projection of a side-effect to apply to messages passed to the Actor.
        +
        Returns:
        +
        A new actor that uses the given parallelization strategy and has the given side-effect.
        +
        +
        • +
      + + + + + +
        +
      • +

        act

        +
        public P1<Unit> act(A a)
        +
        Pass a message to this actor, applying its side-effect to the message. The side-effect is applied in a concurrent + computation, resulting in a product referencing that computation.
        +
        +
        Parameters:
        +
        a - The message to send to this actor.
        +
        Returns:
        +
        A unit-product that represents the action running concurrently.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public <B> Actor<B> contramap(F<B,A> f)
        +
        Contravariant functor pattern. Creates a new actor whose message is transformed by the given function + before being passed to this actor.
        +
        +
        Parameters:
        +
        f - The function to use for the transformation
        +
        Returns:
        +
        A new actor which passes its messages through the given function, to this actor.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public Actor<Promise<A>> promise()
        +
        Transforms this actor to an actor on promises.
        +
        +
        Returns:
        +
        A new actor, equivalent to this actor, that acts on promises.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/Callables.html b/javadoc/5.0/functionaljava/fj/control/parallel/Callables.html new file mode 100644 index 0000000..f9d4080 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/Callables.html @@ -0,0 +1,730 @@ + + + + + +Callables (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Callables

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Callables
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Callables
+extends java.lang.Object
    +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> java.util.concurrent.Callable<B>apply(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<F<A,B>> cf) +
      Performs function application within a callable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>>arrow() +
      Provides a transformation from a function to a Callable-valued function that is equivalent to it.
      +
      static <A,B,C> java.util.concurrent.Callable<C>bind(java.util.concurrent.Callable<A> ca, + java.util.concurrent.Callable<B> cb, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given callables with a final join.
      +
      static <A,B> java.util.concurrent.Callable<B>bind(java.util.concurrent.Callable<A> a, + F<A,java.util.concurrent.Callable<B>> f) +
      Binds the given function to the value in a Callable with a final join.
      +
      static <A> F<A,java.util.concurrent.Callable<A>>callable() +
      Provides a transformation from a value to a Callable that completely preserves that value.
      +
      static <A> java.util.concurrent.Callable<A>callable(A a) +
      Returns a callable that completely preserves the argument.
      +
      static <A> java.util.concurrent.Callable<A>callable(java.lang.Exception e) +
      Returns a callable that throws the given exception.
      +
      static <A,B> F<A,java.util.concurrent.Callable<B>>callable(F<A,B> f) +
      Wraps a given function's return value in a Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>>either() +
      Returns a transformation from a Callable to an Either.
      +
      static <A> P1<Either<java.lang.Exception,A>>either(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into either an exception or the value in the Callable.
      +
      static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>>fmap(F<A,B> f) +
      Lifts any function to a function on Callables.
      +
      static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>>fromEither() +
      Returns a transformation from an Either to a Callable.
      +
      static <A> java.util.concurrent.Callable<A>fromEither(F0<Either<java.lang.Exception,A>> e) +
      Turns a given Either value into the equivalent Callable.
      +
      static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>>fromOption() +
      Returns a transformation from an optional value to a Callable
      +
      static <A> java.util.concurrent.Callable<A>fromOption(F0<Option<A>> o) +
      Turns an optional value into a Callable.
      +
      static <A> java.util.concurrent.Callable<A>join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a) +
      Joins a Callable of a Callable with a bind operation.
      +
      static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on callables.
      +
      static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>>normalise() +
      A first-class version of the normalise function.
      +
      static <A> java.util.concurrent.Callable<A>normalise(java.util.concurrent.Callable<A> a) +
      Normalises the given Callable by calling it and wrapping the result in a new Callable.
      +
      static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>>option() +
      Returns a transformation from a Callable to an optional value.
      +
      static <A> P1<Option<A>>option(java.util.concurrent.Callable<A> a) +
      Turns the given Callable into an optional value.
      +
      static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>>sequence_() +
      A first-class version of the sequence method.
      +
      static <A> java.util.concurrent.Callable<List<A>>sequence(List<java.util.concurrent.Callable<A>> as) +
      Turns a List of Callables into a single Callable of a List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(A a)
        +
        Returns a callable that completely preserves the argument. The unit function for Callables.
        +
        +
        Parameters:
        +
        a - A value to preserve in a Callable
        +
        Returns:
        +
        A Callable that yields the argument when called.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> java.util.concurrent.Callable<A> callable(java.lang.Exception e)
        +
        Returns a callable that throws the given exception. The unit function for Callables.
        +
        +
        Parameters:
        +
        e - The exception to throw when the Callable is called.
        +
        Returns:
        +
        A callable that always throws the given exception.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A> F<A,java.util.concurrent.Callable<A>> callable()
        +
        Provides a transformation from a value to a Callable that completely preserves that value.
        +
        +
        Returns:
        +
        A function from a value to a Callable that completely preserves that value.
        +
        +
        • +
      + + + +
        +
      • +

        callable

        +
        public static <A,B> F<A,java.util.concurrent.Callable<B>> callable(F<A,B> f)
        +
        Wraps a given function's return value in a Callable. + The Kleisli arrow for Callables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Callable.
        +
        Returns:
        +
        The equivalent function whose return value is wrapped in a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,java.util.concurrent.Callable<B>>> arrow()
        +
        Provides a transformation from a function to a Callable-valued function that is equivalent to it. + The first-class Kleisli arrow for Callables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Callable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> java.util.concurrent.Callable<B> bind(java.util.concurrent.Callable<A> a,
+                                                          F<A,java.util.concurrent.Callable<B>> f)
        +
        Binds the given function to the value in a Callable with a final join.
        +
        +
        Parameters:
        +
        a - A value in a Callable to which to apply a function.
        +
        f - A function to apply to the value in a Callable.
        +
        Returns:
        +
        The result of applying the function in the second argument to the value of the Callable in the first.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public static <A,B> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<B>> fmap(F<A,B> f)
        +
        Lifts any function to a function on Callables.
        +
        +
        Parameters:
        +
        f - A function to lift to a function on Callables.
        +
        Returns:
        +
        That function lifted to a function on Callables.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> java.util.concurrent.Callable<B> apply(java.util.concurrent.Callable<A> ca,
+                                                           java.util.concurrent.Callable<F<A,B>> cf)
        +
        Performs function application within a callable (applicative functor pattern).
        +
        +
        Parameters:
        +
        ca - The callable to which to apply a function.
        +
        cf - The callable function to apply.
        +
        Returns:
        +
        A new callable after applying the given callable function to the first argument.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> java.util.concurrent.Callable<C> bind(java.util.concurrent.Callable<A> ca,
+                                                            java.util.concurrent.Callable<B> cb,
+                                                            F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given callables with a final join.
        +
        +
        Parameters:
        +
        ca - A given callable to bind the given function with.
        +
        cb - A given callable to bind the given function with.
        +
        f - The function to apply to the values in the given callables.
        +
        Returns:
        +
        A new callable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> java.util.concurrent.Callable<A> join(java.util.concurrent.Callable<java.util.concurrent.Callable<A>> a)
        +
        Joins a Callable of a Callable with a bind operation.
        +
        +
        Parameters:
        +
        a - The Callable of a Callable to join.
        +
        Returns:
        +
        A new Callable that is the join of the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.util.concurrent.Callable<A>,F<java.util.concurrent.Callable<B>,java.util.concurrent.Callable<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on callables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over callables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> java.util.concurrent.Callable<List<A>> sequence(List<java.util.concurrent.Callable<A>> as)
        +
        Turns a List of Callables into a single Callable of a List.
        +
        +
        Parameters:
        +
        as - The list of callables to transform.
        +
        Returns:
        +
        A single callable for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A> F<List<java.util.concurrent.Callable<A>>,java.util.concurrent.Callable<List<A>>> sequence_()
        +
        A first-class version of the sequence method.
        +
        +
        Returns:
        +
        A function from a List of Callables to a single Callable of a List.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> P1<Option<A>> option(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into an optional value.
        +
        +
        Parameters:
        +
        a - The callable to convert to an optional value.
        +
        Returns:
        +
        An optional value that yields the value in the Callable, or None if the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Option<A>>> option()
        +
        Returns a transformation from a Callable to an optional value.
        +
        +
        Returns:
        +
        a function that turns a Callable into an optional value.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> P1<Either<java.lang.Exception,A>> either(java.util.concurrent.Callable<A> a)
        +
        Turns the given Callable into either an exception or the value in the Callable.
        +
        +
        Parameters:
        +
        a - The callable to convert to an Either value.
        +
        Returns:
        +
        Either the value in the given Callable, or the Exception with which the Callable fails.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <A> F<java.util.concurrent.Callable<A>,P1<Either<java.lang.Exception,A>>> either()
        +
        Returns a transformation from a Callable to an Either.
        +
        +
        Returns:
        +
        a function that turns a Callable into an Either.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> java.util.concurrent.Callable<A> fromEither(F0<Either<java.lang.Exception,A>> e)
        +
        Turns a given Either value into the equivalent Callable.
        +
        +
        Parameters:
        +
        e - Either an exception or a value to wrap in a Callable
        +
        Returns:
        +
        A Callable equivalent to the given Either value.
        +
        +
        • +
      + + + +
        +
      • +

        fromEither

        +
        public static <A> F<P1<Either<java.lang.Exception,A>>,java.util.concurrent.Callable<A>> fromEither()
        +
        Returns a transformation from an Either to a Callable.
        +
        +
        Returns:
        +
        a function that turns an Either into a Callable.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> java.util.concurrent.Callable<A> fromOption(F0<Option<A>> o)
        +
        Turns an optional value into a Callable.
        +
        +
        Parameters:
        +
        o - An optional value to turn into a Callable.
        +
        Returns:
        +
        A Callable that yields some value or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        fromOption

        +
        public static <A> F<P1<Option<A>>,java.util.concurrent.Callable<A>> fromOption()
        +
        Returns a transformation from an optional value to a Callable
        +
        +
        Returns:
        +
        A function that turns an optional value into a Callable that yields some value + or throws an exception in the case of no value.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> java.util.concurrent.Callable<A> normalise(java.util.concurrent.Callable<A> a)
        +
        Normalises the given Callable by calling it and wrapping the result in a new Callable. + If the given Callable throws an Exception, the resulting Callable will throw that same Exception.
        +
        +
        Parameters:
        +
        a - The callable to evaluate.
        +
        Returns:
        +
        A normalised callable that just returns the result of calling the given callable.
        +
        +
        • +
      + + + +
        +
      • +

        normalise

        +
        public static <A> F<java.util.concurrent.Callable<A>,java.util.concurrent.Callable<A>> normalise()
        +
        A first-class version of the normalise function.
        +
        +
        Returns:
        +
        A function that normalises the given Callable by calling it and wrapping the result in a new Callable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/ParModule.html b/javadoc/5.0/functionaljava/fj/control/parallel/ParModule.html new file mode 100644 index 0000000..ef3877b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/ParModule.html @@ -0,0 +1,1411 @@ + + + + + +ParModule (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class ParModule

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.ParModule
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class ParModule
+extends java.lang.Object
    +
    A module of higher-order concurrency features.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> F<Effect1<A>,Actor<A>>actor() +
      A first-class constructor of actors.
      +
      <A> Actor<A>actor(Effect1<A> e) +
      Creates a concurrent actor that is guaranteed to process only one message at a time.
      +
      <A> F<Effect1<A>,Actor<A>>effect() +
      A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
      +
      <A> Actor<A>effect(Effect1<A> e) +
      Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
      +
      <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>>mapList() +
      First-class function that maps a concurrent function over a List inside a promise.
      +
      <A,B> Promise<List<B>>mapM(List<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
      +
      <A,B> Promise<P1<B>>mapM(P1<A> a, + F<A,Promise<B>> f) +
      Maps a concurrent function over a Product-1 inside a Promise.
      +
      <A,B> Promise<Stream<B>>mapM(Stream<A> as, + F<A,Promise<B>> f) +
      Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
      +
      <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>>mapStream() +
      First-class function that maps a concurrent function over a Stream inside a promise.
      +
      <A,B> Promise<NonEmptyList<B>>parExtend(NonEmptyList<A> as, + F<NonEmptyList<A>,B> f) +
      Maps the given function across all sublists of the given NonEmptyList in parallel.
      +
      <A,B> Promise<Tree<B>>parExtend(Tree<A> ta, + F<Tree<A>,B> f) +
      Maps the given function across all subtrees of the given Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parExtend(TreeZipper<A> za, + F<TreeZipper<A>,B> f) +
      Maps the given function across all positions of the given TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parExtend(Zipper<A> za, + F<Zipper<A>,B> f) +
      Maps the given function across all positions of the given zipper in parallel.
      +
      <A,B> Promise<Array<B>>parFlatMap(Array<A> as, + F<A,Array<B>> f) +
      Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
      +
      <A,B> Promise<java.lang.Iterable<B>>parFlatMap(java.lang.Iterable<A> as, + F<A,java.lang.Iterable<B>> f) +
      Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
      +
      <A,B> Promise<List<B>>parFlatMap(List<A> as, + F<A,List<B>> f) +
      Binds a list-valued function across a list in parallel, concatenating the results into a new list.
      +
      <A,B> Promise<Stream<B>>parFlatMap(Stream<A> as, + F<A,Stream<B>> f) +
      Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(java.lang.Iterable<A> as, + F<A,B> map, + Monoid<B> reduce, + F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking) +
      Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce) +
      Maps with the given function across the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<B>parFoldMap(Stream<A> as, + F<A,B> map, + Monoid<B> reduce, + F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking) +
      Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
      +
      <A,B> Promise<Array<B>>parMap(Array<A> as, + F<A,B> f) +
      Maps across an Array in parallel.
      +
      <A,B> Promise<java.lang.Iterable<B>>parMap(java.lang.Iterable<A> as, + F<A,B> f) +
      Maps across an Iterable in parallel.
      +
      <A,B> Promise<List<B>>parMap(List<A> as, + F<A,B> f) +
      Maps across a list in parallel.
      +
      <A,B> Promise<NonEmptyList<B>>parMap(NonEmptyList<A> as, + F<A,B> f) +
      Maps across a nonempty list in parallel.
      +
      <A,B> Promise<Stream<B>>parMap(Stream<A> as, + F<A,B> f) +
      Maps across a Stream in parallel.
      +
      <A,B> Promise<Tree<B>>parMap(Tree<A> ta, + F<A,B> f) +
      Maps a function across a Tree in parallel.
      +
      <A,B> Promise<TreeZipper<B>>parMap(TreeZipper<A> za, + F<A,B> f) +
      Maps a function across a TreeZipper in parallel.
      +
      <A,B> Promise<Zipper<B>>parMap(Zipper<A> za, + F<A,B> f) +
      Maps a function across a Zipper in parallel.
      +
      <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>>parMapArray() +
      A first-class function that maps another function across an array in parallel.
      +
      <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>>parMapIterable() +
      A first-class function that maps another function across an iterable in parallel.
      +
      <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>>parMapList() +
      A first-class function that maps another function across a list in parallel.
      +
      <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>>parMapStream() +
      A first-class function that maps another function across a stream in parallel.
      +
      <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>>parMapTree() +
      A first-class function that maps across a Tree in parallel.
      +
      static ParModuleparModule(Strategy<Unit> u) +
      Constructor method for ParModule
      +
      <A,B,C> Promise<Array<C>>parZipWith(Array<A> as, + Array<B> bs, + F<A,F<B,C>> f) +
      Zips two arrays together with a given function, in parallel.
      +
      <A,B,C> Promise<java.lang.Iterable<C>>parZipWith(java.lang.Iterable<A> as, + java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips two iterables together with a given function, in parallel.
      +
      <A,B,C> Promise<List<C>>parZipWith(List<A> as, + List<B> bs, + F<A,F<B,C>> f) +
      Zips two lists together with a given function, in parallel.
      +
      <A,B,C> Promise<Stream<C>>parZipWith(Stream<A> as, + Stream<B> bs, + F<A,F<B,C>> f) +
      Zips two streams together with a given function, in parallel.
      +
      <A> F<P1<A>,Promise<A>>promise() +
      Returns a function that evaluates a given product concurrently and returns a Promise of the result.
      +
      <A,B> F<A,Promise<B>>promise(F<A,B> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A,B,C> F2<A,B,Promise<C>>promise(F2<A,B,C> f) +
      Promotes the given function to a concurrent function that returns a Promise.
      +
      <A> Promise<A>promise(P1<A> p) +
      Evaluates the given product concurrently and returns a Promise of the result.
      +
      <A,B> F<F<A,B>,F<A,Promise<B>>>promisePure() +
      Returns a function that promotes a given function to a concurrent function that returns a Promise.
      +
      <A> Promise<List<A>>sequence(List<Promise<A>> ps) +
      List iteration inside a Promise.
      +
      <A> Promise<P1<A>>sequence(P1<Promise<A>> p) +
      Traverses a product-1 inside a promise.
      +
      <A> Promise<Stream<A>>sequence(Stream<Promise<A>> ps) +
      Stream iteration inside a Promise.
      +
      <A> F<List<Promise<A>>,Promise<List<A>>>sequenceList() +
      A first-class function that traverses a list inside a promise.
      +
      <A> F<Stream<Promise<A>>,Promise<Stream<A>>>sequenceStream() +
      A first-class function that traverses a stream inside a promise.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        parModule

        +
        public static ParModule parModule(Strategy<Unit> u)
        +
        Constructor method for ParModule
        +
        +
        Parameters:
        +
        u - A parallel strategy for the module.
        +
        Returns:
        +
        A ParModule that uses the given strategy for parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> Promise<A> promise(P1<A> p)
        +
        Evaluates the given product concurrently and returns a Promise of the result.
        +
        +
        Parameters:
        +
        p - A product to evaluate concurrently.
        +
        Returns:
        +
        A Promise of the value of the given product, that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A> F<P1<A>,Promise<A>> promise()
        +
        Returns a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        Returns:
        +
        a function that evaluates a given product concurrently and returns a Promise of the result.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B> F<A,Promise<B>> promise(F<A,B> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        promisePure

        +
        public <A,B> F<F<A,B>,F<A,Promise<B>>> promisePure()
        +
        Returns a function that promotes a given function to a concurrent function that returns a Promise. + The pure Kleisli arrow of Promise.
        +
        +
        Returns:
        +
        A higher-order function that takes pure functions to promise-valued functions.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public <A,B,C> F2<A,B,Promise<C>> promise(F2<A,B,C> f)
        +
        Promotes the given function to a concurrent function that returns a Promise.
        +
        +
        Parameters:
        +
        f - A given function to promote to a concurrent function.
        +
        Returns:
        +
        A function that is applied concurrently when given an argument, yielding a Promise of the result + that can be claimed in the future.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> Actor<A> effect(Effect1<A> e)
        +
        Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that does not guarantee ordering of its messages.
        +
        +
        • +
      + + + +
        +
      • +

        effect

        +
        public <A> F<Effect1<A>,Actor<A>> effect()
        +
        A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages. + Such an actor is not thread-safe unless the given Effect is.
        +
        +
        Returns:
        +
        A function that takes an effect and returns a concurrent effect.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> Actor<A> actor(Effect1<A> e)
        +
        Creates a concurrent actor that is guaranteed to process only one message at a time.
        +
        +
        Parameters:
        +
        e - The effect that the actor should have on its messages.
        +
        Returns:
        +
        A concurrent actor that is guaranteed to process its messages in order.
        +
        +
        • +
      + + + +
        +
      • +

        actor

        +
        public <A> F<Effect1<A>,Actor<A>> actor()
        +
        A first-class constructor of actors.
        +
        +
        Returns:
        +
        A function that takes an effect and returns an actor that processes messages in some order.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<List<A>> sequence(List<Promise<A>> ps)
        +
        List iteration inside a Promise. Traverses a List of Promises yielding a Promise of a List.
        +
        +
        Parameters:
        +
        ps - A list of promises to sequence.
        +
        Returns:
        +
        A promise of the List of values promised by the list of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public <A> F<List<Promise<A>>,Promise<List<A>>> sequenceList()
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a list inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<Stream<A>> sequence(Stream<Promise<A>> ps)
        +
        Stream iteration inside a Promise. Traverses a Stream of Promises yielding a Promise of a Stream.
        +
        +
        Parameters:
        +
        ps - A Stream of promises to sequence.
        +
        Returns:
        +
        A promise of the Stream of values promised by the Stream of promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public <A> F<Stream<Promise<A>>,Promise<Stream<A>>> sequenceStream()
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        Returns:
        +
        A first-class function that traverses a stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Promise<P1<A>> sequence(P1<Promise<A>> p)
        +
        Traverses a product-1 inside a promise.
        +
        +
        Parameters:
        +
        p - A product-1 of a promised value.
        +
        Returns:
        +
        A promise of a product of the value promised by the argument.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<List<B>> mapM(List<A> as,
+                                   F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
        +
        +
        Parameters:
        +
        as - A list to map across.
        +
        f - A promise-valued function to map across the list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapList

        +
        public <A,B> F<F<A,Promise<B>>,F<List<A>,Promise<List<B>>>> mapList()
        +
        First-class function that maps a concurrent function over a List inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a List inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<Stream<B>> mapM(Stream<A> as,
+                                     F<A,Promise<B>> f)
        +
        Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
        +
        +
        Parameters:
        +
        as - A Stream to map across.
        +
        f - A promise-valued function to map across the Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        mapStream

        +
        public <A,B> F<F<A,Promise<B>>,F<Stream<A>,Promise<Stream<B>>>> mapStream()
        +
        First-class function that maps a concurrent function over a Stream inside a promise.
        +
        +
        Returns:
        +
        a function that maps a concurrent function over a Stream inside a promise.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public <A,B> Promise<P1<B>> mapM(P1<A> a,
+                                 F<A,Promise<B>> f)
        +
        Maps a concurrent function over a Product-1 inside a Promise.
        +
        +
        Parameters:
        +
        a - A product-1 across which to map.
        +
        f - A concurrent function to map over the product inside a promise.
        +
        Returns:
        +
        A promised product of the result of mapping the given function over the given product.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<List<B>> parMap(List<A> as,
+                                     F<A,B> f)
        +
        Maps across a list in parallel.
        +
        +
        Parameters:
        +
        as - A list to map across in parallel.
        +
        f - A function to map across the given list.
        +
        Returns:
        +
        A Promise of a new list with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <A,B> F<F<A,B>,F<List<A>,Promise<List<B>>>> parMapList()
        +
        A first-class function that maps another function across a list in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a list in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<NonEmptyList<B>> parMap(NonEmptyList<A> as,
+                                             F<A,B> f)
        +
        Maps across a nonempty list in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to map across in parallel.
        +
        f - A function to map across the given NonEmptyList.
        +
        Returns:
        +
        A Promise of a new NonEmptyList with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Stream<B>> parMap(Stream<A> as,
+                                       F<A,B> f)
        +
        Maps across a Stream in parallel.
        +
        +
        Parameters:
        +
        as - A Stream to map across in parallel.
        +
        f - A function to map across the given Stream.
        +
        Returns:
        +
        A Promise of a new Stream with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapStream

        +
        public <A,B> F<F<A,B>,F<Stream<A>,Promise<Stream<B>>>> parMapStream()
        +
        A first-class function that maps another function across a stream in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across a stream in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parMap(java.lang.Iterable<A> as,
+                                                   F<A,B> f)
        +
        Maps across an Iterable in parallel.
        +
        +
        Parameters:
        +
        as - An Iterable to map across in parallel.
        +
        f - A function to map across the given Iterable.
        +
        Returns:
        +
        A Promise of a new Iterable with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapIterable

        +
        public <A,B> F<F<A,B>,F<java.lang.Iterable<A>,Promise<java.lang.Iterable<B>>>> parMapIterable()
        +
        A first-class function that maps another function across an iterable in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an iterable in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Array<B>> parMap(Array<A> as,
+                                      F<A,B> f)
        +
        Maps across an Array in parallel.
        +
        +
        Parameters:
        +
        as - An array to map across in parallel.
        +
        f - A function to map across the given Array.
        +
        Returns:
        +
        A Promise of a new Array with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <A,B> F<F<A,B>,F<Array<A>,Promise<Array<B>>>> parMapArray()
        +
        A first-class function that maps another function across an array in parallel.
        +
        +
        Returns:
        +
        A function that maps another function across an array in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Zipper<B>> parMap(Zipper<A> za,
+                                       F<A,B> f)
        +
        Maps a function across a Zipper in parallel.
        +
        +
        Parameters:
        +
        za - A Zipper to map across in parallel.
        +
        f - A function to map across the given Zipper.
        +
        Returns:
        +
        A promise of a new Zipper with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<Tree<B>> parMap(Tree<A> ta,
+                                     F<A,B> f)
        +
        Maps a function across a Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A Tree to map across in parallel.
        +
        f - A function to map across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree with the given function applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        parMapTree

        +
        public <A,B> F<F<A,B>,F<Tree<A>,Promise<Tree<B>>>> parMapTree()
        +
        A first-class function that maps across a Tree in parallel.
        +
        +
        Returns:
        +
        A function that maps a given function across a Tree in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <A,B> Promise<TreeZipper<B>> parMap(TreeZipper<A> za,
+                                           F<A,B> f)
        +
        Maps a function across a TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to map across in parallel.
        +
        f - A function to map across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper with the given function applied to each element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<List<B>> parFlatMap(List<A> as,
+                                         F<A,List<B>> f)
        +
        Binds a list-valued function across a list in parallel, concatenating the results into a new list.
        +
        +
        Parameters:
        +
        as - A list to bind across in parallel.
        +
        f - A function to bind across the given list in parallel.
        +
        Returns:
        +
        A promise of a new List with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Stream<B>> parFlatMap(Stream<A> as,
+                                           F<A,Stream<B>> f)
        +
        Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
        +
        +
        Parameters:
        +
        as - A Stream to bind across in parallel.
        +
        f - A function to bind across the given Stream in parallel.
        +
        Returns:
        +
        A promise of a new Stream with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<Array<B>> parFlatMap(Array<A> as,
+                                          F<A,Array<B>> f)
        +
        Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
        +
        +
        Parameters:
        +
        as - An Array to bind across in parallel.
        +
        f - A function to bind across the given Array in parallel.
        +
        Returns:
        +
        A promise of a new Array with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public <A,B> Promise<java.lang.Iterable<B>> parFlatMap(java.lang.Iterable<A> as,
+                                                       F<A,java.lang.Iterable<B>> f)
        +
        Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
        +
        +
        Parameters:
        +
        as - A Iterable to bind across in parallel.
        +
        f - A function to bind across the given Iterable in parallel.
        +
        Returns:
        +
        A promise of a new Iterable with the given function bound across its elements.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<List<C>> parZipWith(List<A> as,
+                                           List<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips two lists together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A list to zip with another in parallel.
        +
        bs - A list to zip with another in parallel.
        +
        f - A function with which to zip two lists in parallel.
        +
        Returns:
        +
        A Promise of a new list with the results of applying the given function across the two lists in lockstep.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Stream<C>> parZipWith(Stream<A> as,
+                                             Stream<B> bs,
+                                             F<A,F<B,C>> f)
        +
        Zips two streams together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - A stream to zip with another in parallel.
        +
        bs - A stream to zip with another in parallel.
        +
        f - A function with which to zip two streams in parallel.
        +
        Returns:
        +
        A Promise of a new stream with the results of applying the given function across the two streams, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<Array<C>> parZipWith(Array<A> as,
+                                            Array<B> bs,
+                                            F<A,F<B,C>> f)
        +
        Zips two arrays together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An array to zip with another in parallel.
        +
        bs - An array to zip with another in parallel.
        +
        f - A function with which to zip two arrays in parallel.
        +
        Returns:
        +
        A Promise of a new array with the results of applying the given function across the two arrays, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <A,B,C> Promise<java.lang.Iterable<C>> parZipWith(java.lang.Iterable<A> as,
+                                                         java.lang.Iterable<B> bs,
+                                                         F<A,F<B,C>> f)
        +
        Zips two iterables together with a given function, in parallel.
        +
        +
        Parameters:
        +
        as - An iterable to zip with another in parallel.
        +
        bs - An iterable to zip with another in parallel.
        +
        f - A function with which to zip two iterables in parallel.
        +
        Returns:
        +
        A Promise of a new iterable with the results of applying the given function across the two iterables, stepwise.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given stream in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - A stream to map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(Stream<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<Stream<A>,P2<Stream<A>,Stream<A>>> chunking)
        +
        Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid. The stream is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - A stream to chunk, then map over and reduce.
        +
        map - The function to map over the given stream.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the stream should be split into chunks. Should return the first chunk + and the rest of the stream.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce,
+                                   F<java.lang.Iterable<A>,P2<java.lang.Iterable<A>,java.lang.Iterable<A>>> chunking)
        +
        Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid. The Iterable is split into chunks according to the given chunking function, + the given map function is mapped over all chunks simultaneously, but over each chunk sequentially. + All chunks are summed concurrently and the sums are then summed sequentially.
        +
        +
        Parameters:
        +
        as - An Iterable to chunk, then map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The monoid with which to sum the results.
        +
        chunking - A function describing how the Iterable should be split into chunks. Should return the first chunk + and the rest of the Iterable.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parFoldMap

        +
        public <A,B> Promise<B> parFoldMap(java.lang.Iterable<A> as,
+                                   F<A,B> map,
+                                   Monoid<B> reduce)
        +
        Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
        +
        +
        Parameters:
        +
        as - An Iterable to map over and reduce.
        +
        map - The function to map over the given Iterable.
        +
        reduce - The Monoid with which to sum the results.
        +
        Returns:
        +
        A promise of a result of mapping and folding in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Zipper<B>> parExtend(Zipper<A> za,
+                                          F<Zipper<A>,B> f)
        +
        Maps the given function across all positions of the given zipper in parallel.
        +
        +
        Parameters:
        +
        za - A zipper to extend the given function across.
        +
        f - A function to extend across the given zipper.
        +
        Returns:
        +
        A promise of a new zipper of the results of applying the given function to all positions of the given + zipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<Tree<B>> parExtend(Tree<A> ta,
+                                        F<Tree<A>,B> f)
        +
        Maps the given function across all subtrees of the given Tree in parallel.
        +
        +
        Parameters:
        +
        ta - A tree to extend the given function across.
        +
        f - A function to extend across the given Tree.
        +
        Returns:
        +
        A promise of a new Tree of the results of applying the given function to all subtrees of the given Tree.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<TreeZipper<B>> parExtend(TreeZipper<A> za,
+                                              F<TreeZipper<A>,B> f)
        +
        Maps the given function across all positions of the given TreeZipper in parallel.
        +
        +
        Parameters:
        +
        za - A TreeZipper to extend the given function across.
        +
        f - A function to extend across the given TreeZipper.
        +
        Returns:
        +
        A promise of a new TreeZipper of the results of applying the given function to all positions of the + given TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        parExtend

        +
        public <A,B> Promise<NonEmptyList<B>> parExtend(NonEmptyList<A> as,
+                                                F<NonEmptyList<A>,B> f)
        +
        Maps the given function across all sublists of the given NonEmptyList in parallel.
        +
        +
        Parameters:
        +
        as - A NonEmptyList to extend the given function across.
        +
        f - A function to extend across the given NonEmptyList
        +
        Returns:
        +
        A promise of a new NonEmptyList of the results of applying the given function to all sublists of the + given NonEmptyList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/Promise.html b/javadoc/5.0/functionaljava/fj/control/parallel/Promise.html new file mode 100644 index 0000000..44d824f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/Promise.html @@ -0,0 +1,863 @@ + + + + + +Promise (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Promise<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Promise<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Promise<A>
+extends java.lang.Object
    +
    Represents a non-blocking future value. Products, functions, and actors, given to the methods on this class, + are executed concurrently, and the Promise serves as a handle on the result of the computation. Provides monadic + operations so that future computations can be combined +

    + Author: Runar

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Promise<B>apply(Promise<F<A,B>> pf) +
      Performs function application within a promise (applicative functor pattern).
      +
      <B> Promise<B>bind(F<A,Promise<B>> f) +
      Binds the given function over this promise, with a final join.
      +
      <B,C> Promise<C>bind(P1<Promise<B>> p, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      <B,C> Promise<C>bind(Promise<B> pb, + F<A,F<B,C>> f) +
      Binds the given function to this promise and the given promise, with a final join.
      +
      Aclaim() +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      Option<A>claim(long timeout, + java.util.concurrent.TimeUnit unit) +
      Waits if necessary for the computation to complete, and then retrieves its result.
      +
      <B> Promise<B>cobind(F<Promise<A>,B> f) +
      Binds the given function across a promise of this promise (Comonad pattern).
      +
      Promise<Promise<A>>cojoin() +
      Duplicates this promise to a promise of itself (Comonad pattern).
      +
      static <A,B> F<Promise<A>,Promise<B>>fmap_(F<A,B> f) +
      Promotes any function to a transformation between promises (covariant functor pattern).
      +
      <B> Promise<B>fmap(F<A,B> f) +
      Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
      +
      static <A,B> F<List<A>,Promise<B>>foldRight(Strategy<Unit> s, + F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across a list in constant stack space.
      +
      static <A,B> F<Stream<A>,Promise<B>>foldRightS(Strategy<Unit> s, + F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across a Stream in constant stack space.
      +
      booleanisFulfilled() +
      Returns true if this promise has been fulfilled.
      +
      static <A> Promise<A>join(Promise<Promise<A>> p) +
      Turns a promise of a promise into just a promise.
      +
      static <A> Promise<A>join(Strategy<Unit> s, + P1<Promise<A>> p) +
      Turns a product of a promise into just a promise.
      +
      static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on promises.
      +
      static <A> F<P1<A>,Promise<A>>promise(Strategy<Unit> s) +
      Provides a first-class unit function for promises.
      +
      static <A> Promise<java.util.concurrent.Callable<A>>promise(Strategy<Unit> s, + java.util.concurrent.Callable<A> a) +
      Provides a promise to call the given Callable in the future.
      +
      static <A,B> F<A,Promise<B>>promise(Strategy<Unit> s, + F<A,B> f) +
      Transforms any function so that it returns a promise of a value instead of an actual value.
      +
      static <A> Promise<A>promise(Strategy<Unit> s, + P1<A> a) +
      Promises to provide the value of the given 1-product, in the future.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequence(Strategy<Unit> s) +
      First-class version of the sequence function through a List.
      +
      static <A> Promise<List<A>>sequence(Strategy<Unit> s, + List<Promise<A>> as) +
      Turns a List of promises into a single promise of a List.
      +
      static <A> Promise<P1<A>>sequence(Strategy<Unit> s, + P1<Promise<A>> p) +
      Transforms a product of a promise to a promise of a product.
      +
      static <A> Promise<Stream<A>>sequence(Strategy<Unit> s, + Stream<Promise<A>> as) +
      Turns a Stream of promises into a single promise of a Stream.
      +
      static <A> F<List<Promise<A>>,Promise<List<A>>>sequenceS(Strategy<Unit> s) +
      First-class version of the sequence function through a Stream.
      +
      <B> Stream<B>sequenceW(Stream<F<Promise<A>,B>> fs) +
      Applies a stream of comonadic functions to this promise, returning a stream of values.
      +
      voidto(Actor<A> a) +
      Promises to send a value to the given actor in the future.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<A> promise(Strategy<Unit> s,
+                                     P1<A> a)
        +
        Promises to provide the value of the given 1-product, in the future. + Represents the unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The 1-product to evaluate concurrently.
        +
        Returns:
        +
        A promise representing the future result of evaluating the given 1-product.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> F<P1<A>,Promise<A>> promise(Strategy<Unit> s)
        +
        Provides a first-class unit function for promises.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil promises.
        +
        Returns:
        +
        A function that, given a 1-product, yields a promise of that product's value.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A> Promise<java.util.concurrent.Callable<A>> promise(Strategy<Unit> s,
+                                                                    java.util.concurrent.Callable<A> a)
        +
        Provides a promise to call the given Callable in the future.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        a - The Callable to evaluate concurrently.
        +
        Returns:
        +
        A promise of a new Callable that will return the result of calling the given Callable.
        +
        +
        • +
      + + + +
        +
      • +

        promise

        +
        public static <A,B> F<A,Promise<B>> promise(Strategy<Unit> s,
+                                            F<A,B> f)
        +
        Transforms any function so that it returns a promise of a value instead of an actual value. + Represents the Kleisli arrow for the Promise monad.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        f - The function to turn into a promise-valued function.
        +
        Returns:
        +
        The given function transformed into a function that returns a promise.
        +
        +
        • +
      + + + +
        +
      • +

        to

        +
        public void to(Actor<A> a)
        +
        Promises to send a value to the given actor in the future.
        +
        +
        Parameters:
        +
        a - An actor that will receive this Promise's value in the future.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Promise<B> fmap(F<A,B> f)
        +
        Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to apply to this promise's future value.
        +
        Returns:
        +
        A promise representing the future result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<Promise<A>,Promise<B>> fmap_(F<A,B> f)
        +
        Promotes any function to a transformation between promises (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - The function to promote to a transformation between promises.
        +
        Returns:
        +
        That function lifted to a function on Promises.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Promise<Promise<A>> p)
        +
        Turns a promise of a promise into just a promise. The join function for the Promise monad. + Promise to give it a Promise of an A, and it will promise you an A in return.
        +
        +
        Parameters:
        +
        p - A promise of a promise.
        +
        Returns:
        +
        The promised promise.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Promise<A> join(Strategy<Unit> s,
+                                  P1<Promise<A>> p)
        +
        Turns a product of a promise into just a promise. Does not block on the product by calling it, + but creates a new promise with a final join.
        +
        +
        Parameters:
        +
        s - The strategy with which to fulfil the promise.
        +
        p - A product-1 of a promise to turn into just a promise.
        +
        Returns:
        +
        The joined promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Promise<B> bind(F<A,Promise<B>> f)
        +
        Binds the given function over this promise, with a final join. + The bind function for the Promise monad.
        +
        +
        Parameters:
        +
        f - The function to bind over this promise.
        +
        Returns:
        +
        The result of applying the given function to this promised value.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Promise<B> apply(Promise<F<A,B>> pf)
        +
        Performs function application within a promise (applicative functor pattern).
        +
        +
        Parameters:
        +
        pf - The promised function to apply.
        +
        Returns:
        +
        A new promise after applying the given promised function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(Promise<B> pb,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        pb - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Promise<C> bind(P1<Promise<B>> p,
+                             F<A,F<B,C>> f)
        +
        Binds the given function to this promise and the given promise, with a final join.
        +
        +
        Parameters:
        +
        p - A promise with which to bind the given function.
        +
        f - The function to apply to the given promised values.
        +
        Returns:
        +
        A new promise after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Promise<A>,F<Promise<B>,Promise<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on promises.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over promises.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<List<A>> sequence(Strategy<Unit> s,
+                                            List<Promise<A>> as)
        +
        Turns a List of promises into a single promise of a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The list of promises to transform.
        +
        Returns:
        +
        A single promise for the given List.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequence(Strategy<Unit> s)
        +
        First-class version of the sequence function through a List.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given list of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a list.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<Stream<A>> sequence(Strategy<Unit> s,
+                                              Stream<Promise<A>> as)
        +
        Turns a Stream of promises into a single promise of a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence the promises.
        +
        as - The Stream of promises to transform.
        +
        Returns:
        +
        A single promise for the given Stream.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceS

        +
        public static <A> F<List<Promise<A>>,Promise<List<A>>> sequenceS(Strategy<Unit> s)
        +
        First-class version of the sequence function through a Stream.
        +
        +
        Parameters:
        +
        s - The strategy with which to sequence a given Stream of promises.
        +
        Returns:
        +
        A function that turns a list of promises into a single promise of a Stream..
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Promise<P1<A>> sequence(Strategy<Unit> s,
+                                          P1<Promise<A>> p)
        +
        Transforms a product of a promise to a promise of a product.
        +
        +
        Parameters:
        +
        s - The strategy with which to traverse the promise.
        +
        p - A product of a promise to traverse.
        +
        Returns:
        +
        A promised product.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<List<A>,Promise<B>> foldRight(Strategy<Unit> s,
+                                                    F<A,F<B,B>> f,
+                                                    B b)
        +
        Performs a right-fold reduction across a list in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the list.
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightS

        +
        public static <A,B> F<Stream<A>,Promise<B>> foldRightS(Strategy<Unit> s,
+                                                       F<A,F<P1<B>,B>> f,
+                                                       B b)
        +
        Performs a right-fold reduction across a Stream in constant stack space.
        +
        +
        Parameters:
        +
        s - The strategy with which to fold the Stream.
        +
        f - The function to apply on each element of the Stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public A claim()
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Returns:
        +
        The promised value.
        +
        +
        • +
      + + + +
        +
      • +

        claim

        +
        public Option<A> claim(long timeout,
+                       java.util.concurrent.TimeUnit unit)
        +
        Waits if necessary for the computation to complete, and then retrieves its result.
        +
        +
        Parameters:
        +
        timeout - the maximum time to wait
        +
        unit - the time unit of the timeout argument
        +
        Returns:
        +
        The promised value, or none if the timeout was reached.
        +
        +
        • +
      + + + +
        +
      • +

        isFulfilled

        +
        public boolean isFulfilled()
        +
        Returns true if this promise has been fulfilled.
        +
        +
        Returns:
        +
        true if this promise has been fulfilled.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Promise<B> cobind(F<Promise<A>,B> f)
        +
        Binds the given function across a promise of this promise (Comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to apply within a new promise of this promise.
        +
        Returns:
        +
        A new promise of the result of applying the given function to this promise.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Promise<Promise<A>> cojoin()
        +
        Duplicates this promise to a promise of itself (Comonad pattern).
        +
        +
        Returns:
        +
        a promise of this promise.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public <B> Stream<B> sequenceW(Stream<F<Promise<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this promise, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of functions to apply to this promise.
        +
        Returns:
        +
        A stream of the results of applying the given stream of functions to this promise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/Strategy.html b/javadoc/5.0/functionaljava/fj/control/parallel/Strategy.html new file mode 100644 index 0000000..298038f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/Strategy.html @@ -0,0 +1,1117 @@ + + + + + +Strategy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.control.parallel
+

Class Strategy<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.control.parallel.Strategy<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strategy<A>
+extends java.lang.Object
    +
    Functional-style parallel evaluation strategies. + A Strategy is a method of evaluating a product-1, yielding another product-1 from which the result of its evaluation + can be retrieved at a later time. +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Strategy<java.util.concurrent.Callable<A>>callableStrategy(Strategy<java.util.concurrent.Callable<A>> s) +
      Provides a normalising strategy that fully evaluates its Callable argument.
      +
      static <A> Strategy<A>completionStrategy(java.util.concurrent.CompletionService<A> s) +
      Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
      +
      <B> F<B,P1<A>>concurry(F<B,A> f) +
      Promotes a function to a concurrent function.
      +
      <B,C> F<B,F<C,P1<A>>>concurry(F2<B,C,A> f) +
      Promotes a function of arity-2 to a concurrent function.
      +
      Strategy<A>contramap(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
      +
      static <A> Effect1<java.util.concurrent.Future<A>>discard() +
      Returns an Effect that waits for a given Future to obtain a value, discarding the value.
      +
      Strategy<A>errorStrategy(Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>errorStrategy(Strategy<A> s, + Effect1<java.lang.Error> e) +
      Provides an error-handling strategy.
      +
      static <A> Strategy<A>executorStrategy(java.util.concurrent.ExecutorService s) +
      Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
      +
      F<P1<A>,P1<A>>f() +
      Returns the functional representation of this Strategy, a function that evaluates a product-1.
      +
      static <A> Strategy<A>idStrategy() +
      Provides a strategy that performs no evaluation of its argument.
      +
      Strategy<A>map(F<P1<A>,P1<A>> f) +
      Maps the given transformation across this strategy's domain (Invariant Functor pattern).
      +
      static <A> List<P1<A>>mergeAll(List<java.util.concurrent.Future<A>> xs) +
      Waits for every Future in a list to obtain a value, and collects those values in a list.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<A>>obtain() +
      Returns a function which returns a product-1 which waits for the given Future to obtain a value.
      +
      static <A> P1<A>obtain(java.util.concurrent.Future<A> t) +
      Provides a product-1 that waits for the given future to obtain a value.
      +
      P1<A>par(P1<A> a) +
      Apply the strategy to the given product-1.
      +
      static <A,B> P1<Array<B>>parFlatMap(Strategy<Array<B>> s, + F<A,Array<B>> f, + Array<A> as) +
      Binds the given function in parallel across the given array, using the given strategy, with a final join.
      +
      static <A,B> P1<List<B>>parFlatMap(Strategy<List<B>> s, + F<A,List<B>> f, + List<A> as) +
      Binds the given function in parallel across the given list, using the given strategy, with a final join.
      +
      P1<List<A>>parList(List<P1<A>> ps) +
      Evaluates a list of product-1s in parallel.
      +
      static <A> P1<List<A>>parListChunk(Strategy<List<A>> s, + int chunkLength, + List<P1<A>> as) +
      Sequentially evaluates chunks (sub-sequences) of a list in parallel.
      +
      <B> P1<Array<A>>parMap(F<B,A> f, + Array<B> bs) +
      Maps the given function over the given array in parallel using this strategy.
      +
      <B> P1<List<A>>parMap(F<B,A> f, + List<B> bs) +
      Maps the given function over the given list in parallel using this strategy.
      +
      <B> Array<A>parMap1(F<B,A> f, + Array<B> bs) +
      A strict version of parMap over arrays.
      +
      <B> List<A>parMap1(F<B,A> f, + List<B> bs) +
      A strict version of parMap over lists.
      +
      <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>>parMapArray() +
      First-class version of parMap on arrays.
      +
      <B> F<Array<B>,P1<Array<A>>>parMapArray(F<B,A> f) +
      Promotes a function to a parallel function on arrays using this strategy.
      +
      <B> F<F<B,A>,F<Array<B>,Array<A>>>parMapArray1() +
      First-class version of parMap1 on arrays (parallel array functor).
      +
      <B> F<F<B,A>,F<List<B>,P1<List<A>>>>parMapList() +
      First-class version of parMap on lists.
      +
      <B> F<List<B>,P1<List<A>>>parMapList(F<B,A> f) +
      Promotes a function to a parallel function on lists using this strategy.
      +
      <B> F<F<B,A>,F<List<B>,List<A>>>parMapList1() +
      First-class version of parMap1 on lists (parallel list functor).
      +
      <B,C> F2<Array<B>,Array<C>,P1<Array<A>>>parZipArrayWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
      +
      <B,C> F2<List<B>,List<C>,P1<List<A>>>parZipListWith(F2<B,C,A> f) +
      Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
      +
      <B,C> P1<Array<A>>parZipWith(F2<B,C,A> f, + Array<B> bs, + Array<C> cs) +
      Zips together two arrays in parallel using a given function, with this strategy.
      +
      <B,C> P1<List<A>>parZipWith(F2<B,C,A> f, + List<B> bs, + List<C> cs) +
      Zips together two lists in parallel using a given function, with this strategy.
      +
      static <A> Strategy<A>seqStrategy() +
      Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
      +
      static <A> Strategy<A>simpleThreadStrategy() +
      Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
      +
      static <A> Strategy<A>strategy(F<P1<A>,P1<A>> f) +
      Constructs a strategy from the given evaluation function.
      +
      <B> Strategy<B>xmap(F<P1<A>,P1<B>> f, + F<P1<B>,P1<A>> g) +
      Maps the given bijective transformation across this strategy (Exponential Functor pattern).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        f

        +
        public F<P1<A>,P1<A>> f()
        +
        Returns the functional representation of this Strategy, a function that evaluates a product-1.
        +
        +
        Returns:
        +
        The function representing this strategy, which evaluates a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        strategy

        +
        public static <A> Strategy<A> strategy(F<P1<A>,P1<A>> f)
        +
        Constructs a strategy from the given evaluation function.
        +
        +
        Parameters:
        +
        f - The execution function for the strategy
        +
        Returns:
        +
        A strategy that uses the given function to evaluate product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        par

        +
        public P1<A> par(P1<A> a)
        +
        Apply the strategy to the given product-1.
        +
        +
        Parameters:
        +
        a - A P1 to evaluate according to this strategy.
        +
        Returns:
        +
        A P1 that yields the value from calling the given product-1.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B> F<B,P1<A>> concurry(F<B,A> f)
        +
        Promotes a function to a concurrent function.
        +
        +
        Parameters:
        +
        f - A function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a Future value.
        +
        +
        • +
      + + + +
        +
      • +

        concurry

        +
        public <B,C> F<B,F<C,P1<A>>> concurry(F2<B,C,A> f)
        +
        Promotes a function of arity-2 to a concurrent function.
        +
        +
        Parameters:
        +
        f - The function to promote to a concurrent function.
        +
        Returns:
        +
        A function that executes concurrently when called, yielding a product-1 that returns the value.
        +
        +
        • +
      + + + +
        +
      • +

        mergeAll

        +
        public static <A> List<P1<A>> mergeAll(List<java.util.concurrent.Future<A>> xs)
        +
        Waits for every Future in a list to obtain a value, and collects those values in a list.
        +
        +
        Parameters:
        +
        xs - The list of Futures from which to get values.
        +
        Returns:
        +
        A list of values extracted from the Futures in the argument list.
        +
        +
        • +
      + + + +
        +
      • +

        parList

        +
        public P1<List<A>> parList(List<P1<A>> ps)
        +
        Evaluates a list of product-1s in parallel.
        +
        +
        Parameters:
        +
        ps - A list to evaluate in parallel.
        +
        Returns:
        +
        A list of the values of the product-1s in the argument.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<List<A>> parMap(F<B,A> f,
+                              List<B> bs)
        +
        Maps the given function over the given list in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap

        +
        public <B> P1<Array<A>> parMap(F<B,A> f,
+                               Array<B> bs)
        +
        Maps the given function over the given array in parallel using this strategy.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        A product-1 that returns the array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> List<A> parMap1(F<B,A> f,
+                           List<B> bs)
        +
        A strict version of parMap over lists. + Maps the given function over the given list in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given list in parallel.
        +
        bs - A list over which to map the given function in parallel.
        +
        Returns:
        +
        A list with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMap1

        +
        public <B> Array<A> parMap1(F<B,A> f,
+                            Array<B> bs)
        +
        A strict version of parMap over arrays. + Maps the given function over the given arrays in parallel using this strategy, + blocking the current thread until all values have been obtained.
        +
        +
        Parameters:
        +
        f - A function to map over the given array in parallel.
        +
        bs - An array over which to map the given function in parallel.
        +
        Returns:
        +
        An array with all of its elements transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<List<B>,P1<List<A>>> parMapList(F<B,A> f)
        +
        Promotes a function to a parallel function on lists using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on lists.
        +
        Returns:
        +
        The function transformed into a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList

        +
        public <B> F<F<B,A>,F<List<B>,P1<List<A>>>> parMapList()
        +
        First-class version of parMap on lists.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapList1

        +
        public <B> F<F<B,A>,F<List<B>,List<A>>> parMapList1()
        +
        First-class version of parMap1 on lists (parallel list functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on lists.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<Array<B>,P1<Array<A>>> parMapArray(F<B,A> f)
        +
        Promotes a function to a parallel function on arrays using this strategy.
        +
        +
        Parameters:
        +
        f - A function to transform into a parallel function on arrays.
        +
        Returns:
        +
        The function transformed into a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray

        +
        public <B> F<F<B,A>,F<Array<B>,P1<Array<A>>>> parMapArray()
        +
        First-class version of parMap on arrays.
        +
        +
        Returns:
        +
        A function that promotes another function to a parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parMapArray1

        +
        public <B> F<F<B,A>,F<Array<B>,Array<A>>> parMapArray1()
        +
        First-class version of parMap1 on arrays (parallel array functor).
        +
        +
        Returns:
        +
        A function that promotes another function to a blocking parallel function on arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<List<B>> parFlatMap(Strategy<List<B>> s,
+                                           F<A,List<B>> f,
+                                           List<A> as)
        +
        Binds the given function in parallel across the given list, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given list.
        +
        as - The list across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parFlatMap

        +
        public static <A,B> P1<Array<B>> parFlatMap(Strategy<Array<B>> s,
+                                            F<A,Array<B>> f,
+                                            Array<A> as)
        +
        Binds the given function in parallel across the given array, using the given strategy, with a final join.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        f - The function to bind across the given array.
        +
        as - The array across which to bind the given function.
        +
        Returns:
        +
        A P1 containing the result of the parallel map operation after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        parListChunk

        +
        public static <A> P1<List<A>> parListChunk(Strategy<List<A>> s,
+                                           int chunkLength,
+                                           List<P1<A>> as)
        +
        Sequentially evaluates chunks (sub-sequences) of a list in parallel. Splits the list into chunks, + evaluating the chunks simultaneously, but each chunk as a sequence.
        +
        +
        Parameters:
        +
        s - The strategy to use for parallelization.
        +
        chunkLength - The length of each sequence.
        +
        as - The list to evaluate in parallel chunks.
        +
        Returns:
        +
        A product-1 containing the list of results extracted from the given list of product-1s.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<List<A>> parZipWith(F2<B,C,A> f,
+                                    List<B> bs,
+                                    List<C> cs)
        +
        Zips together two lists in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the lists, position-wise, + passing elements from the first list to the first argument of the function, and elements from the second list + to the second argument of the function, yielding a list of the results. + If the lists are not of the same length, the remaining elements of the longer list are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A list to zip with the given function.
        +
        cs - A list to zip with the given function.
        +
        Returns:
        +
        The list of the results of calling the given function on corresponding elements of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        parZipWith

        +
        public <B,C> P1<Array<A>> parZipWith(F2<B,C,A> f,
+                                     Array<B> bs,
+                                     Array<C> cs)
        +
        Zips together two arrays in parallel using a given function, with this strategy. + Calls the given function once for each corresponding pair in the arrays, position-wise, + passing elements from the first array to the first argument of the function, and elements from the second array + to the second argument of the function, yielding a array of the results. + If the arrays are not of the same length, the remaining elements of the longer array are ignored.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        bs - A array to zip with the given function.
        +
        cs - A array to zip with the given function.
        +
        Returns:
        +
        The array of the results of calling the given function on corresponding elements of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        parZipListWith

        +
        public <B,C> F2<List<B>,List<C>,P1<List<A>>> parZipListWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two lists using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        parZipArrayWith

        +
        public <B,C> F2<Array<B>,Array<C>,P1<Array<A>>> parZipArrayWith(F2<B,C,A> f)
        +
        Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
        +
        +
        Parameters:
        +
        f - The function of arity-2 with which to zip.
        +
        Returns:
        +
        A transformation that zips two arrays using the argument function, in parallel.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<A>> obtain()
        +
        Returns a function which returns a product-1 which waits for the given Future to obtain a value.
        +
        +
        Returns:
        +
        A function which, given a Future, yields a product-1 that waits for it.
        +
        +
        • +
      + + + +
        +
      • +

        obtain

        +
        public static <A> P1<A> obtain(java.util.concurrent.Future<A> t)
        +
        Provides a product-1 that waits for the given future to obtain a value.
        +
        +
        Parameters:
        +
        t - A Future for which to wait.
        +
        Returns:
        +
        A product-1 that waits for the given future to obtain a value.
        +
        +
        • +
      + + + +
        +
      • +

        discard

        +
        public static <A> Effect1<java.util.concurrent.Future<A>> discard()
        +
        Returns an Effect that waits for a given Future to obtain a value, discarding the value.
        +
        +
        Returns:
        +
        An effect, which, given a Future, waits for it to obtain a value, discarding the value.
        +
        +
        • +
      + + + +
        +
      • +

        simpleThreadStrategy

        +
        public static <A> Strategy<A> simpleThreadStrategy()
        +
        Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        Returns:
        +
        a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
        +
        +
        • +
      + + + +
        +
      • +

        executorStrategy

        +
        public static <A> Strategy<A> executorStrategy(java.util.concurrent.ExecutorService s)
        +
        Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
        +
        +
        Parameters:
        +
        s - The ExecutorService to use for scheduling evaluations.
        +
        Returns:
        +
        A Strategy that uses the provided ExecutorService to control the method and degree + of parallelism.
        +
        +
        • +
      + + + +
        +
      • +

        completionStrategy

        +
        public static <A> Strategy<A> completionStrategy(java.util.concurrent.CompletionService<A> s)
        +
        Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
        +
        +
        Parameters:
        +
        s - The CompletionService to use for scheduling evaluations and detect their completion.
        +
        Returns:
        +
        A Strategy that uses the provided CompletionService to control the method and degree of parallelism, + and notifies the service of task completion.
        +
        +
        • +
      + + + +
        +
      • +

        seqStrategy

        +
        public static <A> Strategy<A> seqStrategy()
        +
        Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs sequential (non-concurrent) evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        idStrategy

        +
        public static <A> Strategy<A> idStrategy()
        +
        Provides a strategy that performs no evaluation of its argument.
        +
        +
        Returns:
        +
        A strategy that performs no evaluation of its argument.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Strategy<B> xmap(F<P1<A>,P1<B>> f,
+                            F<P1<B>,P1<A>> g)
        +
        Maps the given bijective transformation across this strategy (Exponential Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        g - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that maps to this strategy and back again.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public Strategy<A> map(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's domain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from this strategy's codomain to the resulting strategy's codomain.
        +
        Returns:
        +
        A new strategy that applies the given transformation after each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public Strategy<A> contramap(F<P1<A>,P1<A>> f)
        +
        Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
        +
        +
        Parameters:
        +
        f - A transformation from the resulting strategy's domain to this strategy's domain.
        +
        Returns:
        +
        A new strategy that applies the given transformation before each application of this strategy.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public Strategy<A> errorStrategy(Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by this strategy and applies + the given side-effect to them.
        +
        +
        Parameters:
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        errorStrategy

        +
        public static <A> Strategy<A> errorStrategy(Strategy<A> s,
+                                            Effect1<java.lang.Error> e)
        +
        Provides an error-handling strategy. Captures any uncaught runtime errors encountered by the given strategy + and applies the given side-effect to them.
        +
        +
        Parameters:
        +
        s - The strategy to equip with an error-handling effect.
        +
        e - The effect that should handle errors.
        +
        Returns:
        +
        A strategy that captures any runtime errors with a side-effect.
        +
        +
        • +
      + + + +
        +
      • +

        callableStrategy

        +
        public static <A> Strategy<java.util.concurrent.Callable<A>> callableStrategy(Strategy<java.util.concurrent.Callable<A>> s)
        +
        Provides a normalising strategy that fully evaluates its Callable argument.
        +
        +
        Parameters:
        +
        s - A non-normalising strategy to use for the evaluation.
        +
        Returns:
        +
        A new strategy that fully evaluates Callables, using the given strategy.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/package-frame.html b/javadoc/5.0/functionaljava/fj/control/parallel/package-frame.html new file mode 100644 index 0000000..ddda1b5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/package-frame.html @@ -0,0 +1,23 @@ + + + + + +fj.control.parallel (core 5.0 API) + + + + +

fj.control.parallel

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/package-summary.html b/javadoc/5.0/functionaljava/fj/control/parallel/package-summary.html new file mode 100644 index 0000000..d0b8ad5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/package-summary.html @@ -0,0 +1,174 @@ + + + + + +fj.control.parallel (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.control.parallel

+
+
Parallelization strategies.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Actor<A> +
    Light weight actors for Java.
    +
    Callables +
    Monadic functions and conversion methods for java.util.concurrent.Callable.
    +
    ParModule +
    A module of higher-order concurrency features.
    +
    Promise<A> +
    Represents a non-blocking future value.
    +
    Strategy<A> +
    Functional-style parallel evaluation strategies.
    +
    +
    • +
+ + + +

Package fj.control.parallel Description

+
Parallelization strategies.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/control/parallel/package-tree.html b/javadoc/5.0/functionaljava/fj/control/parallel/package-tree.html new file mode 100644 index 0000000..1d54589 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/control/parallel/package-tree.html @@ -0,0 +1,138 @@ + + + + + +fj.control.parallel Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.control.parallel

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/$.html b/javadoc/5.0/functionaljava/fj/data/$.html new file mode 100644 index 0000000..50845be --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/$.html @@ -0,0 +1,306 @@ + + + + + +$ (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class $<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.P1<B>
      • +
    • +
        +
      • fj.data.$<A,B>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    F0<B>, java.util.function.Supplier<B>
    +
    +
    +
    +
    public final class $<A,B>
+extends P1<B>
    +
    The constant arrow, for attaching a new name to an existing type. For every pair of types A and B, this type + is the identity morphism from B to B.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        __

        +
        public static <A,B> $<A,B> __(B b)
        +
        Returns a function that given an argument, returns a function that ignores its argument.
        +
        +
        Returns:
        +
        A function that given an argument, returns a function that ignores its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> $<A,B> constant(B b)
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public B _1()
        +
        Description copied from class: P1
        +
        Access the first element of the product.
        +
        +
        Specified by:
        +
        _1 in class P1<B>
        +
        Returns:
        +
        The first element of the product.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Array.ImmutableProjection.html b/javadoc/5.0/functionaljava/fj/data/Array.ImmutableProjection.html new file mode 100644 index 0000000..920912a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Array.ImmutableProjection.html @@ -0,0 +1,678 @@ + + + + + +Array.ImmutableProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array.ImmutableProjection<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array.ImmutableProjection<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Array<A>
    +
    +
    +
    +
    public static final class Array.ImmutableProjection<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Projects an array by providing only operations which do not mutate.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      intlength() +
      Returns the length of this array.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element + in Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Array.html b/javadoc/5.0/functionaljava/fj/data/Array.html new file mode 100644 index 0000000..36e4d4f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Array.html @@ -0,0 +1,1696 @@ + + + + + +Array (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Array<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Array<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Array<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an interface to arrays.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Array.ImmutableProjection<A> +
      Projects an array by providing only operations which do not mutate.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Array<A>append(Array<A> aas) +
      Appends the given array to this array.
      +
      <B> Array<B>apply(Array<F<A,B>> lf) +
      Performs function application within an array (applicative functor pattern).
      +
      java.lang.Object[]array() +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>array(A... as) +
      Constructs an array from the given elements.
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns a copy of the underlying primitive array.
      +
      static <A> Array<A>arrayArray(A... as) +
      Returns a copy of the underlying primitive array.
      +
      java.util.List<A>asJavaList() +
      Projects an unmodifiable list view of this array.
      +
      <B,C> Array<C>bind(Array<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B,C> Array<C>bind(Array<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this array and the given array with a final + join.
      +
      <B> Array<B>bind(F<A,Array<B>> f) +
      Binds the given function across each element of this array with a final join.
      +
      static <T> T[]copyOf(T[] a, + int len) 
      static <T,U> T[]copyOf(U[] a, + int len, + java.lang.Class<? extends T[]> newType) 
      static char[]copyOfRange(char[] a, + int from, + int to) 
      static <A> Array<A>empty() +
      Returns an empty array.
      +
      booleanequals(java.lang.Object o) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
      +
      Array<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this array.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this array.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this array.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this array.
      +
      Aget(int index) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      inthashCode() 
      Array.ImmutableProjection<A>immutable() 
      booleanisEmpty() +
      Returns true is this array is empty, false otherwise.
      +
      booleanisNotEmpty() +
      Returns false is this array is empty, true otherwise.
      +
      static <A> Array<A>iterableArray(java.lang.Iterable<A> i) +
      Takes the given iterable to an array.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this array.
      +
      static <A> Array<A>iteratorArray(java.util.Iterator<A> i) +
      Creates an Array from the iterator.
      +
      static <A> F<Array<Array<A>>,Array<A>>join() +
      A first-class version of join
      +
      static <A> Array<A>join(Array<Array<A>> o) +
      Joins the given array of arrays using a bind operation.
      +
      intlength() +
      Returns the length of this array.
      +
      static <A,B> F<F<A,B>,F<Array<A>,Array<B>>>map() +
      First-class map function for Arrays.
      +
      <B> Array<B>map(F<A,B> f) +
      Maps the given function across this array.
      +
      static Array<java.lang.Integer>range(int from, + int to) +
      Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Array<A>reverse() +
      Reverse this array in constant stack space.
      +
      <B> Array<B>scanLeft(F<B,F<A,B>> f, + B b) +
      Performs a fold left accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F<A,F<A,A>> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanLeft1(F2<A,A,A> f) +
      Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      <B> Array<B>scanRight(F2<A,B,B> f, + B b) +
      Performs a right-fold accummulating and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F<A,F<A,A>> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      Array<A>scanRight1(F2<A,A,A> f) +
      Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
      +
      <B> Array<B>sequence(Array<B> bs) +
      Performs a bind across each array element, but ignores the element value each time.
      +
      Unitset(int index, + A a) +
      Sets the element at the given index to the given value.
      +
      static <A> Array<A>single(A a) +
      Constructs a singleton array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this array.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
      +
      java.util.ArrayList<A>toJavaList() +
      Returns a java.util.ArrayList projection of this array.
      +
      List<A>toList() +
      Returns a list projection of this array.
      +
      Option<A>toOption() +
      Returns an option projection of this array; None if empty, or the first element in + Some.
      +
      Stream<A>toStream() +
      Returns a stream projection of this array.
      +
      java.lang.StringtoString() 
      static <A,B> P2<Array<A>,Array<B>>unzip(Array<P2<A,B>> xs) +
      Transforms an array of pairs into an array of first components and an array of second components.
      +
      static <A> F<A[],Array<A>>wrap() +
      First-class wrapper function for arrays.
      +
      <B> Array<P2<A,B>>zip(Array<B> bs) +
      Zips this array with the given array to produce an array of pairs.
      +
      Array<P2<A,java.lang.Integer>>zipIndex() +
      Zips this array with the index of its element as a pair.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F<A,F<B,C>> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      <B,C> Array<C>zipWith(Array<B> bs, + F2<A,B,C> f) +
      Zips this array with the given array using the given function to produce a new array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this array. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this array.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        index - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public Unit set(int index,
+                A a)
        +
        Sets the element at the given index to the given value.
        +
        +
        Parameters:
        +
        index - The index at which to set the given value.
        +
        a - The value to set at the given index.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this array.
        +
        +
        Returns:
        +
        The length of this array.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true is this array is empty, false otherwise.
        +
        +
        Returns:
        +
        true is this array is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Returns false is this array is empty, true otherwise.
        +
        +
        Returns:
        +
        false is this array is empty, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public A[] array(java.lang.Class<A[]> c)
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Parameters:
        +
        c - A class for the returned array.
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public java.lang.Object[] array()
        +
        Returns a copy of the underlying primitive array.
        +
        +
        Returns:
        +
        A copy of the underlying primitive array;
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns an option projection of this array; None if empty, or the first element in + Some.
        +
        +
        Returns:
        +
        An option projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this array is empty.
        +
        Returns:
        +
        An either projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this array.
        +
        +
        Returns:
        +
        A list projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream projection of this array.
        +
        +
        Returns:
        +
        A stream projection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Array<B> map(F<A,B> f)
        +
        Maps the given function across this array.
        +
        +
        Parameters:
        +
        f - The function to map across this array.
        +
        Returns:
        +
        A new array after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Array<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new array whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this array.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B b)
        +
        Performs a right-fold reduction across this array. This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this array. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the array.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F<B,F<A,B>> f,
+                             B b)
        +
        Performs a fold left accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanLeft

        +
        public <B> Array<B> scanLeft(F2<B,A,B> f,
+                             B b)
        +
        Performs a left-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (initial value/previous result and next array element)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanLeft1

        +
        public Array<A> scanLeft1(F2<A,A,A> f)
        +
        Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (next array element and first array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        scanRight

        +
        public <B> Array<B> scanRight(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold accummulating and returns an array of the intermediate results. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and initial value/previous result)
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        scanRight1

        +
        public Array<A> scanRight1(F2<A,A,A> f)
        +
        Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results. + It will fail for empty arrays. + This function runs in constant stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each argument pair (previous array element and last array element/previous result)
        +
        Returns:
        +
        The array containing all intermediate results of the right-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Array<B> bind(F<A,Array<B>> f)
        +
        Binds the given function across each element of this array with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Array<B> sequence(Array<B> bs)
        +
        Performs a bind across each array element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The array to apply in the final join.
        +
        Returns:
        +
        A new array after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F<A,F<B,C>> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Array<C> bind(Array<B> sb,
+                           F2<A,B,C> f)
        +
        Binds the given function across each element of this array and the given array with a final + join.
        +
        +
        Parameters:
        +
        sb - A given array to bind the given function with.
        +
        f - The function to apply to each element of this array and the given array.
        +
        Returns:
        +
        A new array after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Array<B> apply(Array<F<A,B>> lf)
        +
        Performs function application within an array (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The array of functions to apply.
        +
        Returns:
        +
        A new array after applying the given array of functions through this array.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Array<A> reverse()
        +
        Reverse this array in constant stack space.
        +
        +
        Returns:
        +
        A new array that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Array<A> append(Array<A> aas)
        +
        Appends the given array to this array.
        +
        +
        Parameters:
        +
        aas - The array to append to this one.
        +
        Returns:
        +
        A new array that has appended the given array.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Array<A> empty()
        +
        Returns an empty array.
        +
        +
        Returns:
        +
        An empty array.
        +
        +
        • +
      + + + + + +
        +
      • +

        array

        +
        @SafeVarargs
+public static <A> Array<A> array(A... as)
        +
        Constructs an array from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct the array with.
        +
        Returns:
        +
        A new array of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Array<A> single(A a)
        +
        Constructs a singleton array.
        +
        +
        Parameters:
        +
        a - The element to put in the array.
        +
        Returns:
        +
        An array with the given single element.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A> F<A[],Array<A>> wrap()
        +
        First-class wrapper function for arrays.
        +
        +
        Returns:
        +
        A function that wraps a given array.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Array<A>,Array<B>>> map()
        +
        First-class map function for Arrays.
        +
        +
        Returns:
        +
        A function that maps a given function across a given array.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Array<A> join(Array<Array<A>> o)
        +
        Joins the given array of arrays using a bind operation.
        +
        +
        Parameters:
        +
        o - The array of arrays to join.
        +
        Returns:
        +
        A new array that is the join of the given arrays.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Array<Array<A>>,Array<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a array of arrays using a bind operation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this array.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this array, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
        +
        +
        Parameters:
        +
        f - the predicate function to test on the elements of this array.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + array.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this array.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Array<java.lang.Integer> range(int from,
+                                             int to)
        +
        Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the array (inclusive).
        +
        to - The maximum value for the array (exclusive).
        +
        Returns:
        +
        An array of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F<A,F<B,C>> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Array<C> zipWith(Array<B> bs,
+                              F2<A,B,C> f)
        +
        Zips this array with the given array using the given function to produce a new array. If this + array and the given array have different lengths, then the longer array is normalised so this + function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        f - The function to zip this array and the given array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> Array<P2<A,B>> zip(Array<B> bs)
        +
        Zips this array with the given array to produce an array of pairs. If this array and the given + array have different lengths, then the longer array is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The array to zip this array with.
        +
        Returns:
        +
        A new array with a length the same as the shortest of this array and the given array.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public Array<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this array with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new array with the same length as this array.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this array.
        +
        +
        Returns:
        +
        An immutable collection of this array.
        +
        +
        • +
      + + + +
        +
      • +

        asJavaList

        +
        public java.util.List<A> asJavaList()
        +
        Projects an unmodifiable list view of this array.
        +
        +
        Returns:
        +
        An unmodifiable list view of this array.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.ArrayList<A> toJavaList()
        +
        Returns a java.util.ArrayList projection of this array.
        +
        • +
      + + + +
        +
      • +

        iterableArray

        +
        public static <A> Array<A> iterableArray(java.lang.Iterable<A> i)
        +
        Takes the given iterable to an array.
        +
        +
        Parameters:
        +
        i - The iterable to take to an array.
        +
        Returns:
        +
        An array from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorArray

        +
        public static <A> Array<A> iteratorArray(java.util.Iterator<A> i)
        +
        Creates an Array from the iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayArray

        +
        @SafeVarargs
+public static <A> Array<A> arrayArray(A... as)
        +
        Returns a copy of the underlying primitive array. + Equivalent to array(A...)
        +
        +
        Returns:
        +
        A copy of the underlying primitive array.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Array<A>,Array<B>> unzip(Array<P2<A,B>> xs)
        +
        Transforms an array of pairs into an array of first components and an array of second components.
        +
        +
        Parameters:
        +
        xs - The array of pairs to transform.
        +
        Returns:
        +
        An array of first components and an array of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T,U> T[] copyOf(U[] a,
+                               int len,
+                               java.lang.Class<? extends T[]> newType)
        +
        • +
      + + + + + +
        +
      • +

        copyOf

        +
        public static <T> T[] copyOf(T[] a,
+                             int len)
        +
        • +
      + + + +
        +
      • +

        copyOfRange

        +
        public static char[] copyOfRange(char[] a,
+                                 int from,
+                                 int to)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Collectors.html b/javadoc/5.0/functionaljava/fj/data/Collectors.html new file mode 100644 index 0000000..693ef59 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Collectors.html @@ -0,0 +1,260 @@ + + + + + +Collectors (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Collectors

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Collectors
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Collectors
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toList

        +
        public static <A> java.util.stream.Collector<A,List.Buffer<A>,List<A>> toList()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public static <A> java.util.stream.Collector<A,List.Buffer<A>,Array<A>> toArray()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static <A> java.util.stream.Collector<A,List.Buffer<A>,Stream<A>> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Conversions.html b/javadoc/5.0/functionaljava/fj/data/Conversions.html new file mode 100644 index 0000000..b4c0b27 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Conversions.html @@ -0,0 +1,1606 @@ + + + + + +Conversions (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Conversions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Conversions
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Conversions
+extends java.lang.Object
    +
    Functions that convert between data structure types.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        List_String

        +
        public static final F<List<java.lang.Character>,java.lang.String> List_String
        +
        A function that converts lists to strings.
        +
        • +
      + + + +
        +
      • +

        List_StringBuffer

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuffer> List_StringBuffer
        +
        A function that converts lists to string buffers.
        +
        • +
      + + + +
        +
      • +

        List_StringBuilder

        +
        public static final F<List<java.lang.Character>,java.lang.StringBuilder> List_StringBuilder
        +
        A function that converts lists to string builders.
        +
        • +
      + + + +
        +
      • +

        Array_String

        +
        public static final F<Array<java.lang.Character>,java.lang.String> Array_String
        +
        A function that converts arrays to strings.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuffer

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuffer> Array_StringBuffer
        +
        A function that converts arrays to string buffers.
        +
        • +
      + + + +
        +
      • +

        Array_StringBuilder

        +
        public static final F<Array<java.lang.Character>,java.lang.StringBuilder> Array_StringBuilder
        +
        A function that converts arrays to string builders.
        +
        • +
      + + + +
        +
      • +

        Stream_String

        +
        public static final F<Stream<java.lang.Character>,java.lang.String> Stream_String
        +
        A function that converts streams to strings.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuffer

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuffer> Stream_StringBuffer
        +
        A function that converts streams to string buffers.
        +
        • +
      + + + +
        +
      • +

        Stream_StringBuilder

        +
        public static final F<Stream<java.lang.Character>,java.lang.StringBuilder> Stream_StringBuilder
        +
        A function that converts streams to string builders.
        +
        • +
      + + + +
        +
      • +

        Option_String

        +
        public static final F<Option<java.lang.Character>,java.lang.String> Option_String
        +
        A function that converts options to strings.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuffer

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuffer> Option_StringBuffer
        +
        A function that converts options to string buffers.
        +
        • +
      + + + +
        +
      • +

        Option_StringBuilder

        +
        public static final F<Option<java.lang.Character>,java.lang.StringBuilder> Option_StringBuilder
        +
        A function that converts options to string builders.
        +
        • +
      + + + +
        +
      • +

        String_List

        +
        public static final F<java.lang.String,List<java.lang.Character>> String_List
        +
        A function that converts strings to lists.
        +
        • +
      + + + +
        +
      • +

        String_Array

        +
        public static final F<java.lang.String,Array<java.lang.Character>> String_Array
        +
        A function that converts strings to arrays.
        +
        • +
      + + + +
        +
      • +

        String_Option

        +
        public static final F<java.lang.String,Option<java.lang.Character>> String_Option
        +
        A function that converts strings to options.
        +
        • +
      + + + +
        +
      • +

        String_Stream

        +
        public static final F<java.lang.String,Stream<java.lang.Character>> String_Stream
        +
        A function that converts strings to streams.
        +
        • +
      + + + +
        +
      • +

        String_StringBuffer

        +
        public static final F<java.lang.String,java.lang.StringBuffer> String_StringBuffer
        +
        A function that converts strings to string buffers.
        +
        • +
      + + + +
        +
      • +

        String_StringBuilder

        +
        public static final F<java.lang.String,java.lang.StringBuilder> String_StringBuilder
        +
        A function that converts strings to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_List

        +
        public static final F<java.lang.StringBuffer,List<java.lang.Character>> StringBuffer_List
        +
        A function that converts string buffers to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Array

        +
        public static final F<java.lang.StringBuffer,Array<java.lang.Character>> StringBuffer_Array
        +
        A function that converts string buffers to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stream

        +
        public static final F<java.lang.StringBuffer,Stream<java.lang.Character>> StringBuffer_Stream
        +
        A function that converts string buffers to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Option

        +
        public static final F<java.lang.StringBuffer,Option<java.lang.Character>> StringBuffer_Option
        +
        A function that converts string buffers to options.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_String

        +
        public static final F<java.lang.StringBuffer,java.lang.String> StringBuffer_String
        +
        A function that converts string buffers to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_StringBuilder

        +
        public static final F<java.lang.StringBuffer,java.lang.StringBuilder> StringBuffer_StringBuilder
        +
        A function that converts string buffers to string builders.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_List

        +
        public static final F<java.lang.StringBuilder,List<java.lang.Character>> StringBuilder_List
        +
        A function that converts string builders to lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Array

        +
        public static final F<java.lang.StringBuilder,Array<java.lang.Character>> StringBuilder_Array
        +
        A function that converts string builders to arrays.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stream

        +
        public static final F<java.lang.StringBuilder,Stream<java.lang.Character>> StringBuilder_Stream
        +
        A function that converts string builders to streams.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Option

        +
        public static final F<java.lang.StringBuilder,Option<java.lang.Character>> StringBuilder_Option
        +
        A function that converts string builders to options.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_String

        +
        public static final F<java.lang.StringBuilder,java.lang.String> StringBuilder_String
        +
        A function that converts string builders to strings.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_StringBuffer

        +
        public static final F<java.lang.StringBuilder,java.lang.StringBuffer> StringBuilder_StringBuffer
        +
        A function that converts string builders to string buffers.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_Array

        +
        public static <A> F<List<A>,Array<A>> List_Array()
        +
        A function that converts lists to arrays.
        +
        +
        Returns:
        +
        A function that converts lists to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stream

        +
        public static <A> F<List<A>,Stream<A>> List_Stream()
        +
        A function that converts lists to streams.
        +
        +
        Returns:
        +
        A function that converts lists to streams.
        +
        +
        • +
      + + + +
        +
      • +

        List_Option

        +
        public static <A> F<List<A>,Option<A>> List_Option()
        +
        A function that converts lists to options.
        +
        +
        Returns:
        +
        A function that converts lists to options.
        +
        +
        • +
      + + + +
        +
      • +

        List_Either

        +
        public static <A,B> F<P1<A>,F<List<B>,Either<A,B>>> List_Either()
        +
        A function that converts lists to eithers.
        +
        +
        Returns:
        +
        A function that converts lists to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Array_List

        +
        public static <A> F<Array<A>,List<A>> Array_List()
        +
        A function that converts arrays to lists.
        +
        +
        Returns:
        +
        A function that converts arrays to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stream

        +
        public static <A> F<Array<A>,Stream<A>> Array_Stream()
        +
        A function that converts arrays to streams.
        +
        +
        Returns:
        +
        A function that converts arrays to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Option

        +
        public static <A> F<Array<A>,Option<A>> Array_Option()
        +
        A function that converts arrays to options.
        +
        +
        Returns:
        +
        A function that converts arrays to options.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Either

        +
        public static <A,B> F<P1<A>,F<Array<B>,Either<A,B>>> Array_Either()
        +
        A function that converts arrays to eithers.
        +
        +
        Returns:
        +
        A function that converts arrays to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_List

        +
        public static <A> F<Stream<A>,List<A>> Stream_List()
        +
        A function that converts streams to lists.
        +
        +
        Returns:
        +
        A function that converts streams to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Array

        +
        public static <A> F<Stream<A>,Array<A>> Stream_Array()
        +
        A function that converts streams to arrays.
        +
        +
        Returns:
        +
        A function that converts streams to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Option

        +
        public static <A> F<Stream<A>,Option<A>> Stream_Option()
        +
        A function that converts streams to options.
        +
        +
        Returns:
        +
        A function that converts streams to options.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Either

        +
        public static <A,B> F<P1<A>,F<Stream<B>,Either<A,B>>> Stream_Either()
        +
        A function that converts streams to eithers.
        +
        +
        Returns:
        +
        A function that converts streams to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Option_List

        +
        public static <A> F<Option<A>,List<A>> Option_List()
        +
        A function that converts options to lists.
        +
        +
        Returns:
        +
        A function that converts options to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Array

        +
        public static <A> F<Option<A>,Array<A>> Option_Array()
        +
        A function that converts options to arrays.
        +
        +
        Returns:
        +
        A function that converts options to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stream

        +
        public static <A> F<Option<A>,Stream<A>> Option_Stream()
        +
        A function that converts options to streams.
        +
        +
        Returns:
        +
        A function that converts options to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Either

        +
        public static <A,B> F<P1<A>,F<Option<B>,Either<A,B>>> Option_Either()
        +
        A function that converts options to eithers.
        +
        +
        Returns:
        +
        A function that converts options to eithers.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        Effect0_P1

        +
        public static P1<Unit> Effect0_P1(Effect0 e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<A,Unit> Effect1_F(Effect1<A> e)
        +
        • +
      + + + +
        +
      • +

        Effect1_F

        +
        public static <A> F<Effect1<A>,F<A,Unit>> Effect1_F()
        +
        • +
      + + + +
        +
      • +

        Effect_IO

        +
        public static IO<Unit> Effect_IO(Effect0 e)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        Either_ListA

        +
        public static <A,B> F<Either<A,B>,List<A>> Either_ListA()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ListB

        +
        public static <A,B> F<Either<A,B>,List<B>> Either_ListB()
        +
        A function that converts eithers to lists.
        +
        +
        Returns:
        +
        A function that converts eithers to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayA

        +
        public static <A,B> F<Either<A,B>,Array<A>> Either_ArrayA()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayB

        +
        public static <A,B> F<Either<A,B>,Array<B>> Either_ArrayB()
        +
        A function that converts eithers to arrays.
        +
        +
        Returns:
        +
        A function that converts eithers to arrays.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamA

        +
        public static <A,B> F<Either<A,B>,Stream<A>> Either_StreamA()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StreamB

        +
        public static <A,B> F<Either<A,B>,Stream<B>> Either_StreamB()
        +
        A function that converts eithers to streams.
        +
        +
        Returns:
        +
        A function that converts eithers to streams.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionA

        +
        public static <A,B> F<Either<A,B>,Option<A>> Either_OptionA()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_OptionB

        +
        public static <A,B> F<Either<A,B>,Option<B>> Either_OptionB()
        +
        A function that converts eithers to options.
        +
        +
        Returns:
        +
        A function that converts eithers to options.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.String> Either_StringA()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.String> Either_StringB()
        +
        A function that converts eithers to strings.
        +
        +
        Returns:
        +
        A function that converts eithers to strings.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuffer> Either_StringBufferA()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBufferB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuffer> Either_StringBufferB()
        +
        A function that converts eithers to string buffers.
        +
        +
        Returns:
        +
        A function that converts eithers to string buffers.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderA

        +
        public static <B> F<Either<java.lang.Character,B>,java.lang.StringBuilder> Either_StringBuilderA()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StringBuilderB

        +
        public static <A> F<Either<A,java.lang.Character>,java.lang.StringBuilder> Either_StringBuilderB()
        +
        A function that converts eithers to string builders.
        +
        +
        Returns:
        +
        A function that converts eithers to string builders.
        +
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> SafeIO<A> F_SafeIO(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        F_SafeIO

        +
        public static <A> F<F<Unit,A>,SafeIO<A>> F_SafeIO()
        +
        • +
      + + + +
        +
      • +

        String_Either

        +
        public static <A> F<P1<A>,F<java.lang.String,Either<A,java.lang.Character>>> String_Either()
        +
        A function that converts string to eithers.
        +
        +
        Returns:
        +
        A function that converts string to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuffer,Either<A,java.lang.Character>>> StringBuffer_Either()
        +
        A function that converts string buffers to eithers.
        +
        +
        Returns:
        +
        A function that converts string buffers to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Either

        +
        public static <A> F<P1<A>,F<java.lang.StringBuilder,Either<A,java.lang.Character>>> StringBuilder_Either()
        +
        A function that converts string builders to eithers.
        +
        +
        Returns:
        +
        A function that converts string builders to eithers.
        +
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> SafeIO<Validation<Z,A>> Try_SafeIO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_SafeIO

        +
        public static <A,B,Z extends java.lang.Exception> F<Try0<A,Z>,SafeIO<Validation<Z,A>>> Try_SafeIO()
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> IO<A> Try_IO(Try0<A,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_IO

        +
        public static <A,B,Z extends java.io.IOException> F<Try0<A,Z>,IO<A>> Try_IO()
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<A,Validation<Z,B>> Try_F(Try1<A,B,Z> t)
        +
        • +
      + + + +
        +
      • +

        Try_F

        +
        public static <A,B,Z extends java.io.IOException> F<Try1<A,B,Z>,F<A,Validation<Z,B>>> Try_F()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/DList.html b/javadoc/5.0/functionaljava/fj/data/DList.html new file mode 100644 index 0000000..5f29cb5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/DList.html @@ -0,0 +1,473 @@ + + + + + +DList (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class DList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.DList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class DList<A>
+extends java.lang.Object
    +
    Difference List. It converts left associative appends into right associative ones to improve performance.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      DList<A>append(DList<A> other) +
      Appends two DLists together to produce a new DList.
      +
      static <A> DList<A>arrayDList(A... as) +
      Creates a DList from an array
      +
      DList<A>cons(A a) +
      Prepends a single element on the DList to produce a new DList.
      +
      static <A> DList<A>dlist(F<List<A>,Trampoline<List<A>>> f) +
      Creates a DList from the function + + For alternatives functions to create a DList:
      +
      static <A> DList<A>iterableDList(java.lang.Iterable<A> it) +
      Creates a DList from an Iterable
      +
      static <A> DList<A>iteratorDList(java.util.Iterator<A> it) +
      Creates a DList from an Iterator
      +
      static <A> DList<A>listDList(List<A> a) +
      Creates a DList from a List
      +
      static <A> DList<A>nil() +
      A empty DList.
      +
      List<A>run() +
      Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
      +
      static <A> DList<A>single(A a) +
      Produces a DList with one element.
      +
      DList<A>snoc(A a) +
      Appends a single element on the end of the DList to produce a new DList.
      +
      java.util.List<A>toJavaList() +
      Converts the DList to a standard java.util.List.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        listDList

        +
        public static <A> DList<A> listDList(List<A> a)
        +
        Creates a DList from a List
        +
        • +
      + + + +
        +
      • +

        iterableDList

        +
        public static <A> DList<A> iterableDList(java.lang.Iterable<A> it)
        +
        Creates a DList from an Iterable
        +
        • +
      + + + +
        +
      • +

        iteratorDList

        +
        public static <A> DList<A> iteratorDList(java.util.Iterator<A> it)
        +
        Creates a DList from an Iterator
        +
        • +
      + + + + + +
        +
      • +

        arrayDList

        +
        @SafeVarargs
+public static <A> DList<A> arrayDList(A... as)
        +
        Creates a DList from an array
        +
        • +
      + + + +
        +
      • +

        run

        +
        public List<A> run()
        +
        Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List. + This is what converts the appending operation from left associative to right associative, + giving DList it's speed.
        +
        +
        Returns:
        +
        the final List
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the DList to a standard java.util.List.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> DList<A> nil()
        +
        A empty DList.
        +
        +
        Type Parameters:
        +
        A -
        +
        Returns:
        +
        a empty DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> DList<A> single(A a)
        +
        Produces a DList with one element.
        +
        +
        Type Parameters:
        +
        A -
        +
        Parameters:
        +
        a - the element in the DList.
        +
        Returns:
        +
        a DList with one element.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public DList<A> cons(A a)
        +
        Prepends a single element on the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public DList<A> snoc(A a)
        +
        Appends a single element on the end of the DList to produce a new DList.
        +
        +
        Parameters:
        +
        a - the element to append.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public DList<A> append(DList<A> other)
        +
        Appends two DLists together to produce a new DList.
        +
        +
        Parameters:
        +
        other - the other DList to append on the end of this one.
        +
        Returns:
        +
        the new DList.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either.LeftProjection.html b/javadoc/5.0/functionaljava/fj/data/Either.LeftProjection.html new file mode 100644 index 0000000..190ec33 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either.LeftProjection.html @@ -0,0 +1,817 @@ + + + + + +Either.LeftProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.LeftProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.LeftProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.LeftProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A left projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<X,B>apply(Either<F<A,X>,B> e) +
      Function application on this projection's value.
      +
      <X> Either<X,B>bind(F<A,Either<X,B>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<A,X>>filter(F<A,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<A,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<X,B>map(F<A,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Aon(F<B,A> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      AorValue(A a) +
      The value of this projection or the given argument.
      +
      AorValue(F0<A> a) +
      The value of this projection or the given argument.
      +
      <X> Either<X,B>sequence(Either<X,B> e) +
      Anonymous bind through this projection.
      +
      Array<A>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<A>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<A>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<A>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<C,B>>traverseIO(F<A,IO<C>> f) +
      Anonymous bind through this projection.
      +
      <C> List<Either<C,B>>traverseList(F<A,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<C,B>>traverseOption(F<A,Option<C>> f) 
      <C> P1<Either<C,B>>traverseP1(F<A,P1<C>> f) +
      Traverse this left with the given function and collect the output as a p1.
      +
      <C> Stream<Either<C,B>>traverseStream(F<A,Stream<C>> f) 
      Avalue() +
      The value of this projection or fails with a specialised error message.
      +
      AvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      AvalueE(java.lang.String err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public A valueE(java.lang.String err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public A orValue(F0<A> a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orValue

        +
        public A orValue(A a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public A on(F<B,A> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<A,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<A> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<X,B> map(F<A,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<X,B> bind(F<A,Either<X,B>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<X,B> sequence(Either<X,B> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<C,B>> traverseList(F<A,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<C,B>> traverseIO(F<A,IO<C>> f)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <C> P1<Either<C,B>> traverseP1(F<A,P1<C>> f)
        +
        Traverse this left with the given function and collect the output as a p1.
        +
        +
        Type Parameters:
        +
        C - the type of the p1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the p1
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<A,X>> filter(F<A,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<X,B> apply(Either<F<A,X>,B> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<A> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either.RightProjection.html b/javadoc/5.0/functionaljava/fj/data/Either.RightProjection.html new file mode 100644 index 0000000..573df28 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either.RightProjection.html @@ -0,0 +1,828 @@ + + + + + +Either.RightProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either.RightProjection<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either.RightProjection<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<B>
    +
    +
    +
    Enclosing class:
    +
    Either<A,B>
    +
    +
    +
    +
    public static final class Either.RightProjection<A,B>
+extends java.lang.Object
+implements java.lang.Iterable<B>
    +
    A right projection of an either value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X> Either<A,X>apply(Either<A,F<B,X>> e) +
      Function application on this projection's value.
      +
      <X> Either<A,X>bind(F<B,Either<A,X>> f) +
      Binds the given function across this projection's value if it has one.
      +
      Either<A,B>either() +
      The either value underlying this projection.
      +
      booleanexists(F<B,java.lang.Boolean> f) +
      Returns false if no value or returns the result of the application of the given + function to the value.
      +
      <X> Option<Either<X,B>>filter(F<B,java.lang.Boolean> f) +
      Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
      +
      booleanforall(F<B,java.lang.Boolean> f) +
      Returns true if no value or returns the result of the application of the given + function to the value.
      +
      Unitforeach(F<B,Unit> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      voidforeachDoEffect(Effect1<B> f) +
      Execute a side-effect on this projection's value if it has one.
      +
      java.util.Iterator<B>iterator() +
      Returns an iterator for this projection.
      +
      <X> Either<A,X>map(F<B,X> f) +
      Map the given function across this projection's value if it has one.
      +
      Bon(F<A,B> f) +
      The value of this projection or the result of the given function on the opposing projection's + value.
      +
      BorValue(B a) +
      The value of this projection or the given argument.
      +
      BorValue(F0<B> b) +
      The value of this projection or the given argument.
      +
      <X> Either<A,X>sequence(Either<A,X> e) +
      Anonymous bind through this projection.
      +
      Array<B>toArray() +
      Returns a single element array if this projection has a value, otherwise an empty array.
      +
      java.util.Collection<B>toCollection() +
      Projects an immutable collection of this projection.
      +
      List<B>toList() +
      Returns a single element list if this projection has a value, otherwise an empty list.
      +
      Option<B>toOption() +
      Returns this projection's value in Some if it exists, otherwise + None.
      +
      Stream<B>toStream() +
      Returns a single element stream if this projection has a value, otherwise an empty stream.
      +
      <C> IO<Either<A,C>>traverseIO(F<B,IO<C>> f) +
      Traverse with a function that has IO effect
      +
      <C> List<Either<A,C>>traverseList(F<B,List<C>> f) +
      Traverse with function that produces List (non-determinism).
      +
      <C> Option<Either<A,C>>traverseOption(F<B,Option<C>> f) +
      Traverse this right with the given function and collect the output as an option.
      +
      <C> P1<Either<A,C>>traverseP1(F<B,P1<C>> f) +
      Traverse this right with the given function and collect the output as a p1.
      +
      <C> Stream<Either<A,C>>traverseStream(F<B,Stream<C>> f) 
      Bvalue() +
      The value of this projection or fails with a specialised error message.
      +
      BvalueE(F0<java.lang.String> err) +
      Returns the value of this projection or fails with the given error message.
      +
      BvalueE(java.lang.String err) +
      Returns the value of this projection or fails with the given error message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<B> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<B>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public Either<A,B> either()
        +
        The either value underlying this projection.
        +
        +
        Returns:
        +
        The either value underlying this projection.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public B valueE(java.lang.String err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public B valueE(F0<java.lang.String> err)
        +
        Returns the value of this projection or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The value of this projection
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public B value()
        +
        The value of this projection or fails with a specialised error message.
        +
        +
        Returns:
        +
        The value of this projection.
        +
        +
        • +
      + + + + + +
        +
      • +

        orValue

        +
        public B orValue(B a)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        a - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        orValue

        +
        public B orValue(F0<B> b)
        +
        The value of this projection or the given argument.
        +
        +
        Parameters:
        +
        b - The value to return if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public B on(F<A,B> f)
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        Parameters:
        +
        f - The function to execute if this projection has no value.
        +
        Returns:
        +
        The value of this projection or the result of the given function on the opposing projection's + value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<B,Unit> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<B> f)
        +
        Execute a side-effect on this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <X> Either<A,X> map(F<B,X> f)
        +
        Map the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to map across this projection.
        +
        Returns:
        +
        A new either value after mapping.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <X> Either<A,X> bind(F<B,Either<A,X>> f)
        +
        Binds the given function across this projection's value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this projection.
        +
        Returns:
        +
        A new either value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <X> Either<A,X> sequence(Either<A,X> e)
        +
        Anonymous bind through this projection.
        +
        +
        Parameters:
        +
        e - The value to bind with.
        +
        Returns:
        +
        An either after binding through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <C> List<Either<A,C>> traverseList(F<B,List<C>> f)
        +
        Traverse with function that produces List (non-determinism).
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <C> IO<Either<A,C>> traverseIO(F<B,IO<C>> f)
        +
        Traverse with a function that has IO effect
        +
        +
        Parameters:
        +
        f - the function to traverse with
        +
        Returns:
        +
        An either after traversing through this projection.
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <C> P1<Either<A,C>> traverseP1(F<B,P1<C>> f)
        +
        Traverse this right with the given function and collect the output as a p1.
        +
        +
        Type Parameters:
        +
        C - the type of the p1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the p1
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public <C> Option<Either<A,C>> traverseOption(F<B,Option<C>> f)
        +
        Traverse this right with the given function and collect the output as an option.
        +
        +
        Type Parameters:
        +
        C - the type of the option value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the option
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <X> Option<Either<X,B>> filter(F<B,java.lang.Boolean> f)
        +
        Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <X> Either<A,X> apply(Either<A,F<B,X>> e)
        +
        Function application on this projection's value.
        +
        +
        Parameters:
        +
        e - The either of the function to apply on this projection's value.
        +
        Returns:
        +
        The result of function application within either.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<B,java.lang.Boolean> f)
        +
        Returns true if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        true if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<B,java.lang.Boolean> f)
        +
        Returns false if no value or returns the result of the application of the given + function to the value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this projection's value.
        +
        Returns:
        +
        false if no value or returns the result of the application of the given + function to the value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<B> toList()
        +
        Returns a single element list if this projection has a value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this projection has a value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<B> toOption()
        +
        Returns this projection's value in Some if it exists, otherwise + None.
        +
        +
        Returns:
        +
        This projection's value in Some if it exists, otherwise + None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<B> toArray()
        +
        Returns a single element array if this projection has a value, otherwise an empty array.
        +
        +
        Returns:
        +
        A single element array if this projection has a value, otherwise an empty array.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<B> toStream()
        +
        Returns a single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        Returns:
        +
        A single element stream if this projection has a value, otherwise an empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<B> toCollection()
        +
        Projects an immutable collection of this projection.
        +
        +
        Returns:
        +
        An immutable collection of this projection.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either.html b/javadoc/5.0/functionaljava/fj/data/Either.html new file mode 100644 index 0000000..097e08e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either.html @@ -0,0 +1,1010 @@ + + + + + +Either (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Either<A,B>
+extends java.lang.Object
    +
    The Either type represents a value of one of two possible types (a disjoint union). + The data constructors; Left and Right represent the two possible + values. The Either type is often used as an alternative to + scala.Option where Left represents failure (by convention) and + Right is akin to Some.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Either.LeftProjection<A,B> +
      A left projection of an either value.
      +
      static class Either.RightProjection<A,B> +
      A right projection of an either value.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <X,Y> Either<X,Y>bimap(F<A,X> left, + F<B,Y> right) +
      Map the given functions across the appropriate side.
      +
      static <A,B,X> F<Either<A,B>,X>either_(F<A,X> left, + F<B,X> right) +
      First class catamorphism for either.
      +
      abstract <X> Xeither(F<A,X> left, + F<B,X> right) +
      The catamorphism for either.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      static <A,B> Either<A,B>iif(boolean c, + F0<B> right, + F0<A> left) +
      If the condition satisfies, return the given B in right, otherwise, return the given A in left.
      +
      abstract booleanisLeft() +
      Returns true if this either is a left, false otherwise.
      +
      abstract booleanisRight() +
      Returns true if this either is a right, false otherwise.
      +
      static <A,B> Either<A,B>joinLeft(Either<Either<A,B>,B> e) +
      Joins an either through left.
      +
      static <A,B> Either<A,B>joinRight(Either<A,Either<A,B>> e) +
      Joins an either through right.
      +
      static <A,B> F<A,Either<A,B>>left_() +
      A function that constructs a left value of either.
      +
      Either.LeftProjection<A,B>left() +
      Projects this either as a left.
      +
      static <A,B> Either<A,B>left(A a) +
      Construct a left value of either.
      +
      static <A,B,X> F<F<A,X>,F<Either<A,B>,Either<X,B>>>leftMap_() +
      Return a function that maps a given function across this either's left projection.
      +
      <X> Either<X,B>leftMap(F<A,X> f) +
      Map the given function across this either's left projection.
      +
      static <A,B> List<A>lefts(List<Either<A,B>> es) +
      Returns all the left values in the given list.
      +
      static <A> Areduce(Either<A,A> e) +
      Takes an Either to its contained value within left or right.
      +
      static <A,B> F<B,Either<A,B>>right_() +
      A function that constructs a right value of either.
      +
      Either.RightProjection<A,B>right() +
      Projects this either as a right.
      +
      static <A,B> Either<A,B>right(B b) +
      Construct a right value of either.
      +
      static <A,B,X> F<F<B,X>,F<Either<A,B>,Either<A,X>>>rightMap_() +
      Return a function that maps a given function across this either's right projection.
      +
      <X> Either<A,X>rightMap(F<B,X> f) +
      Map the given function across this either's right.
      +
      static <A,B> List<B>rights(List<Either<A,B>> es) +
      Returns all the right values in the given list.
      +
      static <A,X> Either<List<A>,X>sequenceLeft(List<Either<A,X>> a) +
      Sequences through the left side of the either monad with a list of values.
      +
      static <B,X> Either<X,List<B>>sequenceRight(List<Either<X,B>> a) +
      Sequences through the right side of the either monad with a list of values.
      +
      Either<B,A>swap() +
      If this is a left, then return the left value in right, or vice versa.
      +
      java.lang.StringtoString() 
      <C> IO<Either<C,B>>traverseIOLeft(F<A,IO<C>> f) +
      Traversable instance of LeftProjection of Either for IO.
      +
      <C> IO<Either<A,C>>traverseIORight(F<B,IO<C>> f) +
      Traversable instance of RightProjection of Either for IO.
      +
      <C> List<Either<C,B>>traverseListLeft(F<A,List<C>> f) +
      Traversable instance of LeftProjection of Either for List.
      +
      <C> List<Either<A,C>>traverseListRight(F<B,List<C>> f) +
      Traversable instance of RightProjection of Either for List.
      +
      <C> Option<Either<C,B>>traverseOptionLeft(F<A,Option<C>> f) +
      Traversable instance of LeftProjection of Either for Option.
      +
      <C> Option<Either<A,C>>traverseOptionRight(F<B,Option<C>> f) +
      Traversable instance of RightProjection of Either for Option.
      +
      <C> Stream<Either<C,B>>traverseStreamLeft(F<A,Stream<C>> f) +
      Traversable instance of LeftProjection of Either for Stream.
      +
      <C> Stream<Either<A,C>>traverseStreamRight(F<B,Stream<C>> f) +
      Traversable instance of RightProjection of Either for Stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        left

        +
        public final Either.LeftProjection<A,B> left()
        +
        Projects this either as a left.
        +
        +
        Returns:
        +
        A left projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public final Either.RightProjection<A,B> right()
        +
        Projects this either as a right.
        +
        +
        Returns:
        +
        A right projection of this either.
        +
        +
        • +
      + + + +
        +
      • +

        isLeft

        +
        public abstract boolean isLeft()
        +
        Returns true if this either is a left, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a left, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isRight

        +
        public abstract boolean isRight()
        +
        Returns true if this either is a right, false otherwise.
        +
        +
        Returns:
        +
        true if this either is a right, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public abstract <X> X either(F<A,X> left,
+                             F<B,X> right)
        +
        The catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public final <X,Y> Either<X,Y> bimap(F<A,X> left,
+                                     F<B,Y> right)
        +
        Map the given functions across the appropriate side.
        +
        +
        Parameters:
        +
        left - The function to map if this is left.
        +
        right - The function to map if this is right.
        +
        Returns:
        +
        A new either value after mapping with the appropriate function applied.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        swap

        +
        public final Either<B,A> swap()
        +
        If this is a left, then return the left value in right, or vice versa.
        +
        +
        Returns:
        +
        The value of this either swapped to the opposing side.
        +
        +
        • +
      + + + + + +
        +
      • +

        left

        +
        public static <A,B> Either<A,B> left(A a)
        +
        Construct a left value of either.
        +
        +
        Parameters:
        +
        a - The value underlying the either.
        +
        Returns:
        +
        A left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A,B> F<A,Either<A,B>> left_()
        +
        A function that constructs a left value of either.
        +
        +
        Returns:
        +
        A function that constructs a left value of either.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A,B> F<B,Either<A,B>> right_()
        +
        A function that constructs a right value of either.
        +
        +
        Returns:
        +
        A function that constructs a right value of either.
        +
        +
        • +
      + + + + + +
        +
      • +

        right

        +
        public static <A,B> Either<A,B> right(B b)
        +
        Construct a right value of either.
        +
        +
        Parameters:
        +
        b - The value underlying the either.
        +
        Returns:
        +
        A right value of either.
        +
        +
        • +
      + + + +
        +
      • +

        either_

        +
        public static <A,B,X> F<Either<A,B>,X> either_(F<A,X> left,
+                                               F<B,X> right)
        +
        First class catamorphism for either. Folds over this either breaking into left or right.
        +
        +
        Parameters:
        +
        left - The function to call if this is left.
        +
        right - The function to call if this is right.
        +
        Returns:
        +
        The reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        leftMap

        +
        public final <X> Either<X,B> leftMap(F<A,X> f)
        +
        Map the given function across this either's left projection.
        +
        +
        Type Parameters:
        +
        X - the type of the function output
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        leftMap_

        +
        public static <A,B,X> F<F<A,X>,F<Either<A,B>,Either<X,B>>> leftMap_()
        +
        Return a function that maps a given function across this either's left projection.
        +
        +
        Type Parameters:
        +
        A - the type of the right value
        +
        B - the type of the left value
        +
        X - the type of the function output
        +
        Returns:
        +
        A function that maps another function across an either's left projection.
        +
        +
        • +
      + + + +
        +
      • +

        rightMap

        +
        public final <X> Either<A,X> rightMap(F<B,X> f)
        +
        Map the given function across this either's right.
        +
        +
        Type Parameters:
        +
        X - the type of the function output
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        rightMap_

        +
        public static <A,B,X> F<F<B,X>,F<Either<A,B>,Either<A,X>>> rightMap_()
        +
        Return a function that maps a given function across this either's right projection.
        +
        +
        Type Parameters:
        +
        A - the type of the right value
        +
        B - the type of the left value
        +
        X - the type of the function output
        +
        Returns:
        +
        A function that maps another function across an either's right projection.
        +
        +
        • +
      + + + +
        +
      • +

        joinLeft

        +
        public static <A,B> Either<A,B> joinLeft(Either<Either<A,B>,B> e)
        +
        Joins an either through left.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + +
        +
      • +

        joinRight

        +
        public static <A,B> Either<A,B> joinRight(Either<A,Either<A,B>> e)
        +
        Joins an either through right.
        +
        +
        Parameters:
        +
        e - The either of either to join.
        +
        Returns:
        +
        An either after joining.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        traverseListRight

        +
        public final <C> List<Either<A,C>> traverseListRight(F<B,List<C>> f)
        +
        Traversable instance of RightProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseListLeft

        +
        public final <C> List<Either<C,B>> traverseListLeft(F<A,List<C>> f)
        +
        Traversable instance of LeftProjection of Either for List.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIORight

        +
        public final <C> IO<Either<A,C>> traverseIORight(F<B,IO<C>> f)
        +
        Traversable instance of RightProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseIOLeft

        +
        public final <C> IO<Either<C,B>> traverseIOLeft(F<A,IO<C>> f)
        +
        Traversable instance of LeftProjection of Either for IO.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionRight

        +
        public final <C> Option<Either<A,C>> traverseOptionRight(F<B,Option<C>> f)
        +
        Traversable instance of RightProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseOptionLeft

        +
        public final <C> Option<Either<C,B>> traverseOptionLeft(F<A,Option<C>> f)
        +
        Traversable instance of LeftProjection of Either for Option.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamRight

        +
        public final <C> Stream<Either<A,C>> traverseStreamRight(F<B,Stream<C>> f)
        +
        Traversable instance of RightProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        traverseStreamLeft

        +
        public final <C> Stream<Either<C,B>> traverseStreamLeft(F<A,Stream<C>> f)
        +
        Traversable instance of LeftProjection of Either for Stream.
        +
        +
        Returns:
        +
        traversed value
        +
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public static <A> A reduce(Either<A,A> e)
        +
        Takes an Either to its contained value within left or right.
        +
        +
        Parameters:
        +
        e - The either to reduce.
        +
        Returns:
        +
        An Either to its contained value within left or right.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A,B> Either<A,B> iif(boolean c,
+                                    F0<B> right,
+                                    F0<A> left)
        +
        If the condition satisfies, return the given B in right, otherwise, return the given A in left.
        +
        +
        Parameters:
        +
        c - The condition to test.
        +
        right - The right value to use if the condition satisfies.
        +
        left - The left value to use if the condition does not satisfy.
        +
        Returns:
        +
        A constructed either based on the given condition.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public static <A,B> List<A> lefts(List<Either<A,B>> es)
        +
        Returns all the left values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible left values.
        +
        Returns:
        +
        All the left values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public static <A,B> List<B> rights(List<Either<A,B>> es)
        +
        Returns all the right values in the given list.
        +
        +
        Parameters:
        +
        es - The list of possible right values.
        +
        Returns:
        +
        All the right values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either3.LeftProjection.html b/javadoc/5.0/functionaljava/fj/data/Either3.LeftProjection.html new file mode 100644 index 0000000..847fe78 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either3.LeftProjection.html @@ -0,0 +1,526 @@ + + + + + +Either3.LeftProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either3.LeftProjection<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either3.LeftProjection<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Either3<A,B,C>
    +
    +
    +
    +
    public static final class Either3.LeftProjection<A,B,C>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either3.MiddleProjection.html b/javadoc/5.0/functionaljava/fj/data/Either3.MiddleProjection.html new file mode 100644 index 0000000..ae39787 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either3.MiddleProjection.html @@ -0,0 +1,526 @@ + + + + + +Either3.MiddleProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either3.MiddleProjection<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either3.MiddleProjection<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Either3<A,B,C>
    +
    +
    +
    +
    public static final class Either3.MiddleProjection<A,B,C>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either3.RightProjection.html b/javadoc/5.0/functionaljava/fj/data/Either3.RightProjection.html new file mode 100644 index 0000000..2fefe8f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either3.RightProjection.html @@ -0,0 +1,526 @@ + + + + + +Either3.RightProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either3.RightProjection<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either3.RightProjection<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Either3<A,B,C>
    +
    +
    +
    +
    public static final class Either3.RightProjection<A,B,C>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Either3.html b/javadoc/5.0/functionaljava/fj/data/Either3.html new file mode 100644 index 0000000..b11f8cf --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Either3.html @@ -0,0 +1,690 @@ + + + + + +Either3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Either3<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Either3<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Either3<A,B,C>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        leftMap

        +
        public final <X> Either3<X,B,C> leftMap(F<A,X> f)
        +
        • +
      + + + +
        +
      • +

        leftMap_

        +
        public final <X> F<F<A,X>,Either3<X,B,C>> leftMap_()
        +
        • +
      + + + +
        +
      • +

        middleMap

        +
        public final <X> Either3<A,X,C> middleMap(F<B,X> f)
        +
        • +
      + + + +
        +
      • +

        middleMap_

        +
        public final <X> F<F<B,X>,Either3<A,X,C>> middleMap_()
        +
        • +
      + + + +
        +
      • +

        rightMap

        +
        public final <X> Either3<A,B,X> rightMap(F<C,X> f)
        +
        • +
      + + + +
        +
      • +

        rightMap_

        +
        public final <X> F<F<C,X>,Either3<A,B,X>> rightMap_()
        +
        • +
      + + + + + +
        +
      • +

        left

        +
        public static <A,B,C> Either3<A,B,C> left(A a)
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A,B,C> F<A,Either3<A,B,C>> left_()
        +
        • +
      + + + + + +
        +
      • +

        middle

        +
        public static <A,B,C> Either3<A,B,C> middle(B b)
        +
        • +
      + + + + + +
        +
      • +

        right

        +
        public static <A,B,C> Either3<A,B,C> right(C c)
        +
        • +
      + + + +
        +
      • +

        isLeft

        +
        public boolean isLeft()
        +
        • +
      + + + +
        +
      • +

        isMiddle

        +
        public boolean isMiddle()
        +
        • +
      + + + +
        +
      • +

        isRight

        +
        public boolean isRight()
        +
        • +
      + + + +
        +
      • +

        map3

        +
        public <X,Y,Z> Either3<X,Y,Z> map3(F<A,X> fl,
+                                   F<B,Y> fm,
+                                   F<C,Z> fr)
        +
        • +
      + + + +
        +
      • +

        either

        +
        public abstract <D> D either(F<A,D> fa,
+                             F<B,D> fb,
+                             F<C,D> fc)
        +
        • +
      + + + +
        +
      • +

        either_

        +
        public static <A,B,C,D> F<Either3<A,B,C>,D> either_(F<A,D> fa,
+                                                    F<B,D> fb,
+                                                    F<C,D> fc)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        moveLeft

        +
        public Either3<B,C,A> moveLeft()
        +
        • +
      + + + +
        +
      • +

        moveRight

        +
        public Either3<C,A,B> moveRight()
        +
        • +
      + + + + + + + +
        +
      • +

        swapLefts

        +
        public Either3<B,A,C> swapLefts()
        +
        • +
      + + + +
        +
      • +

        swapRights

        +
        public Either3<A,C,B> swapRights()
        +
        • +
      + + + +
        +
      • +

        leftOption

        +
        public Option<A> leftOption()
        +
        • +
      + + + +
        +
      • +

        middleOption

        +
        public Option<B> middleOption()
        +
        • +
      + + + +
        +
      • +

        rightOption

        +
        public Option<C> rightOption()
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Enumerator.html b/javadoc/5.0/functionaljava/fj/data/Enumerator.html new file mode 100644 index 0000000..9dd3659 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Enumerator.html @@ -0,0 +1,881 @@ + + + + + +Enumerator (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Enumerator<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Enumerator<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Enumerator<A>
+extends java.lang.Object
    +
    Abstracts over a type that may have a successor and/or predecessor value. This implies ordering for that type. A user + may construct an enumerator with an optimised version for plus, otherwise a default is implemented using + the given successor/predecessor implementations. +

    + For any enumerator e, the following laws must satisfy: +

      +
    • forall a. e.successor(a).forall(\t -> e.predecessor(t).forall(\z -> z == a))
      • +
    • forall a. e.predecessor(a).forall(\t -> e.successor(t).forall(\z -> z == a))
      • +
    • e.max().forall(\t -> e.successor(t).isNone)
      • +
    • e.min().forall(\t -> e.predecessor(t).isNone)
      • +
    • forall a n. e.plus(a, 0) == Some(a)
      • +
    • forall a n | n > 0. e.plus(a, n) == e.plus(a, n - 1)
      • +
    • forall a n | n < 0. e.plus(a, n) == e.plus(a, n + 1)
      • +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        booleanEnumerator

        +
        public static final Enumerator<java.lang.Boolean> booleanEnumerator
        +
        An enumerator for boolean.
        +
        • +
      + + + +
        +
      • +

        byteEnumerator

        +
        public static final Enumerator<java.lang.Byte> byteEnumerator
        +
        An enumerator for byte.
        +
        • +
      + + + +
        +
      • +

        charEnumerator

        +
        public static final Enumerator<java.lang.Character> charEnumerator
        +
        An enumerator for char.
        +
        • +
      + + + +
        +
      • +

        doubleEnumerator

        +
        public static final Enumerator<java.lang.Double> doubleEnumerator
        +
        An enumerator for double.
        +
        • +
      + + + +
        +
      • +

        floatEnumerator

        +
        public static final Enumerator<java.lang.Float> floatEnumerator
        +
        An enumerator for float.
        +
        • +
      + + + +
        +
      • +

        intEnumerator

        +
        public static final Enumerator<java.lang.Integer> intEnumerator
        +
        An enumerator for int.
        +
        • +
      + + + +
        +
      • +

        bigintEnumerator

        +
        public static final Enumerator<java.math.BigInteger> bigintEnumerator
        +
        An enumerator for BigInteger.
        +
        • +
      + + + +
        +
      • +

        bigdecimalEnumerator

        +
        public static final Enumerator<java.math.BigDecimal> bigdecimalEnumerator
        +
        An enumerator for BigDecimal.
        +
        • +
      + + + +
        +
      • +

        longEnumerator

        +
        public static final Enumerator<java.lang.Long> longEnumerator
        +
        An enumerator for long.
        +
        • +
      + + + +
        +
      • +

        shortEnumerator

        +
        public static final Enumerator<java.lang.Short> shortEnumerator
        +
        An enumerator for short.
        +
        • +
      + + + +
        +
      • +

        orderingEnumerator

        +
        public static final Enumerator<Ordering> orderingEnumerator
        +
        An enumerator for Ordering.
        +
        • +
      + + + +
        +
      • +

        naturalEnumerator

        +
        public static final Enumerator<Natural> naturalEnumerator
        +
        An enumerator for Natural
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        successor

        +
        public F<A,Option<A>> successor()
        +
        Returns the potential successor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential successor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        successor

        +
        public Option<A> successor(A a)
        +
        Returns the potential successor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the successor of.
        +
        Returns:
        +
        The potential successor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        predecessor

        +
        public F<A,Option<A>> predecessor()
        +
        Returns the potential predecessor of a value for this enumerator in curried form.
        +
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator in curried form.
        +
        +
        • +
      + + + + + +
        +
      • +

        predecessor

        +
        public Option<A> predecessor(A a)
        +
        Returns the potential predecessor of a value for this enumerator.
        +
        +
        Parameters:
        +
        a - The value to return the predecessor of.
        +
        Returns:
        +
        The potential predecessor of a value for this enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<A> max()
        +
        Returns the maximum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The maximum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<A> min()
        +
        Returns the minimum value for this enumerator if there is one.
        +
        +
        Returns:
        +
        The minimum value for this enumerator if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,F<java.lang.Long,Option<A>>> plus()
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public F<java.lang.Long,Option<A>> plus(A a)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public F<A,Option<A>> plus(long l)
        +
        Returns a function that moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A function that moves a value along the enumerator a given number of times.
        +
        +
        • +
      + + + + + +
        +
      • +

        plus

        +
        public Option<A> plus(A a,
+                      long l)
        +
        Moves a value along the enumerator a given number of times.
        +
        +
        Parameters:
        +
        a - The value to begin moving along from.
        +
        l - The number of times to move along the enumerator.
        +
        Returns:
        +
        A potential value after having moved the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        order

        +
        public Ord<A> order()
        +
        Returns the ordering for the enumerator.
        +
        +
        Returns:
        +
        The ordering for the enumerator.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <B> Enumerator<B> xmap(F<A,B> f,
+                              F<B,A> g)
        +
        Invariant functor map over this enumerator.
        +
        +
        Parameters:
        +
        f - The covariant map.
        +
        g - The contra-variant map.
        +
        Returns:
        +
        An enumerator after the given functions are applied.
        +
        +
        • +
      + + + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream(A a)
        +
        Returns a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        Parameters:
        +
        a - A value at which to begin the stream.
        +
        Returns:
        +
        a stream of the values from this enumerator, starting at the given value, counting up.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream(Bounded<A> bounded)
        +
        Returns a stream of the values from this enumerator, + starting at the min of given Bounded, ending at the max, counting up.
        +
        +
        Parameters:
        +
        bounded - A value at which to begin the stream.
        +
        Returns:
        +
        a stream of the values from this enumerator, cut by bounded, counting up.
        +
        +
        • +
      + + + +
        +
      • +

        setMin

        +
        public Enumerator<A> setMin(Option<A> min)
        +
        Create a new enumerator with the given minimum value.
        +
        +
        Parameters:
        +
        min - A minimum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given minimum value.
        +
        +
        • +
      + + + +
        +
      • +

        setMax

        +
        public Enumerator<A> setMax(Option<A> max)
        +
        Create a new enumerator with the given maximum value.
        +
        +
        Parameters:
        +
        max - A maximum value.
        +
        Returns:
        +
        A new enumerator identical to this one, but with the given maximum value.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order,
+                                           F<A,F<java.lang.Long,Option<A>>> plus)
        +
        Construct an enumerator. `
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        plus - The function to move the enumeration a given number of times. This may be supplied for a performance + enhancement for certain types.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      + + + +
        +
      • +

        enumerator

        +
        public static <A> Enumerator<A> enumerator(F<A,Option<A>> successor,
+                                           F<A,Option<A>> predecessor,
+                                           Option<A> max,
+                                           Option<A> min,
+                                           Ord<A> order)
        +
        Construct an enumerator. The plus function is derived from the successor and + predecessor.
        +
        +
        Parameters:
        +
        successor - The successor function.
        +
        predecessor - The predecessor function.
        +
        max - The potential maximum value.
        +
        min - The potential minimum value.
        +
        order - The ordering for the type.
        +
        Returns:
        +
        An enumerator with the given values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Eval.html b/javadoc/5.0/functionaljava/fj/data/Eval.html new file mode 100644 index 0000000..e8d9c9a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Eval.html @@ -0,0 +1,449 @@ + + + + + +Eval (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Eval<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Eval<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public abstract class Eval<A>
+extends java.lang.Object
    +
    Eval is an abstraction over different models of evaluation. + The data constructors: +
      +
    • Now - the value is evaluated immediately.
      • +
    • Later - the value is evaluated only once when it's requested (lazy evaluation).
      • +
    • Always - the value is evaluated every time when it's requested.
      • +
    + + Both Later and Always are lazy computations, while Now is eager.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/HashMap.html b/javadoc/5.0/functionaljava/fj/data/HashMap.html new file mode 100644 index 0000000..77629c5 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/HashMap.html @@ -0,0 +1,1071 @@ + + + + + +HashMap (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<K>
    +
    +
    +
    +
    public final class HashMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<K>
    +
    A mutable hash map providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashMap(Equal<K> e, + Hash<K> h) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(Equal<K> e, + Hash<K> h, + int initialCapacity, + float loadFactor) +
      Construct a hash map with the given equality and hashing strategy.
      +
      HashMap(java.util.Map<K,V> map) 
      HashMap(java.util.Map<K,V> map, + Equal<K> e, + Hash<K> h) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <K,V> HashMap<K,V>arrayHashMap(Equal<K> equal, + Hash<K> hash, + P2<K,V>... entries) +
      Converts the array to a HashMap
      +
      static <K,V> HashMap<K,V>arrayHashMap(P2<K,V>... entries) +
      Converts the array to a HashMap
      +
      voidclear() +
      Clear all entries from this hash map.
      +
      booleancontains(K k) +
      Determines if the given key value exists in this hash map.
      +
      voiddelete(K k) +
      Deletes the entry in the hash map that corresponds to the given key.
      +
      booleaneq(K k1, + K k2) +
      Compare two key values for equality using the underlying equality strategy.
      +
      voidforeach(F<P2<K,V>,Unit> function) 
      voidforeachDoEffect(Effect1<P2<K,V>> effect) 
      static <K,V> HashMap<K,V>fromMap(Equal<K> eq, + Hash<K> h, + java.util.Map<K,V> map) 
      static <K,V> HashMap<K,V>fromMap(java.util.Map<K,V> map) 
      F<K,Option<V>>get() +
      A curried version of get(Object).
      +
      Option<V>get(K k) +
      Returns a potential value that the given key maps to.
      +
      Option<V>getDelete(K k) +
      Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
      +
      inthash(K k) +
      Compute the hash of the given key value using the underlying hashing strategy.
      +
      static <K,V> HashMap<K,V>hashMap() +
      Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
      +
      static <K,V> HashMap<K,V>hashMap(Equal<K> e, + Hash<K> h) +
      Construct a hash map.
      +
      booleanisEmpty() +
      Determines if this hash map has any entries.
      +
      static <K,V> HashMap<K,V>iterableHashMap(Equal<K> equal, + Hash<K> hash, + java.lang.Iterable<P2<K,V>> entries) +
      Converts the Iterable to a HashMap
      +
      static <K,V> HashMap<K,V>iterableHashMap(java.lang.Iterable<P2<K,V>> entries) +
      Converts the Iterable to a HashMap
      +
      java.util.Iterator<K>iterator() +
      Returns an iterator for this map's keys.
      +
      static <K,V> HashMap<K,V>iteratorHashMap(Equal<K> equal, + Hash<K> hash, + java.util.Iterator<P2<K,V>> entries) +
      Converts the Iterator to a HashMap
      +
      static <K,V> HashMap<K,V>iteratorHashMap(java.util.Iterator<P2<K,V>> entries) +
      Converts the Iterator to a HashMap
      +
      List<K>keys() +
      Returns all key entries in this hash map.
      +
      <A,B> HashMap<A,B>map(F<K,A> keyFunction, + F<V,B> valueFunction) 
      <A,B> HashMap<A,B>map(F<K,A> keyFunction, + F<V,B> valueFunction, + Equal<A> equal, + Hash<A> hash) 
      <A,B> HashMap<A,B>map(F<P2<K,V>,P2<A,B>> function) 
      <A,B> HashMap<A,B>map(F<P2<K,V>,P2<A,B>> function, + Equal<A> equal, + Hash<A> hash) 
      <A> HashMap<A,V>mapKeys(F<K,A> function) 
      <A> HashMap<A,V>mapKeys(F<K,A> keyFunction, + Equal<A> equal, + Hash<A> hash) 
      <B> HashMap<K,B>mapValues(F<V,B> function) 
      voidset(K k, + V v) +
      Inserts the given key and value association into the hash map.
      +
      intsize() +
      Returns the number of entries in this hash map.
      +
      Array<P2<K,V>>toArray() 
      java.util.Collection<P2<K,V>>toCollection() +
      Projects an immutable collection of this hash map.
      +
      List<P2<K,V>>toList() 
      java.util.Map<K,V>toMap() 
      Option<P2<K,V>>toOption() 
      Stream<P2<K,V>>toStream() 
      List<V>values() +
      Returns all values in this hash map.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map,
+               Equal<K> e,
+               Hash<K> h)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        HashMap

        +
        public HashMap(Equal<K> e,
+               Hash<K> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash map with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<K> iterator()
        +
        Returns an iterator for this map's keys. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<K>
        +
        Returns:
        +
        A iterator for this map's keys.
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap()
        +
        Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        Returns:
        +
        A new hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
        +
        +
        • +
      + + + +
        +
      • +

        hashMap

        +
        public static <K,V> HashMap<K,V> hashMap(Equal<K> e,
+                                         Hash<K> h)
        +
        Construct a hash map.
        +
        +
        Returns:
        +
        A new hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(K k1,
+                  K k2)
        +
        Compare two key values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        k1 - One key value to compare.
        +
        k2 - The other key value to compare.
        +
        Returns:
        +
        true if the two key values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(K k)
        +
        Compute the hash of the given key value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        k - The key value to computer the hash of.
        +
        Returns:
        +
        The hash of the given key value.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the hash map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all entries from this hash map.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this hash map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this hash map.
        +
        Returns:
        +
        true if this hash map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all key entries in this hash map.
        +
        +
        Returns:
        +
        All key entries in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this hash map.
        +
        +
        Returns:
        +
        All values in this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash map has any entries.
        +
        +
        Returns:
        +
        true if this hash map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash map.
        +
        +
        Returns:
        +
        The number of entries in this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(K k,
+                V v)
        +
        Inserts the given key and value association into the hash map.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public void delete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        +
        • +
      + + + + + +
        +
      • +

        getDelete

        +
        public Option<V> getDelete(K k)
        +
        Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
        +
        +
        Parameters:
        +
        k - The key to delete from this hash map.
        +
        Returns:
        +
        The value that was associated with the given key, if there was one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction,
+                              Equal<A> equal,
+                              Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<K,A> keyFunction,
+                              F<V,B> valueFunction)
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        public <A,B> HashMap<A,B> map(F<P2<K,V>,P2<A,B>> function)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> keyFunction,
+                                Equal<A> equal,
+                                Hash<A> hash)
        +
        • +
      + + + +
        +
      • +

        mapKeys

        +
        public <A> HashMap<A,V> mapKeys(F<K,A> function)
        +
        • +
      + + + +
        +
      • +

        mapValues

        +
        public <B> HashMap<K,B> mapValues(F<V,B> function)
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<P2<K,V>> effect)
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public void foreach(F<P2<K,V>,Unit> function)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<P2<K,V>> toCollection()
        +
        Projects an immutable collection of this hash map.
        +
        +
        Returns:
        +
        An immutable collection of this hash map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<P2<K,V>> toOption()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<P2<K,V>> toArray()
        +
        • +
      + + + +
        +
      • +

        toMap

        +
        public java.util.Map<K,V> toMap()
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        fromMap

        +
        public static <K,V> HashMap<K,V> fromMap(Equal<K> eq,
+                                         Hash<K> h,
+                                         java.util.Map<K,V> map)
        +
        • +
      + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        iterableHashMap

        +
        public static <K,V> HashMap<K,V> iterableHashMap(java.lang.Iterable<P2<K,V>> entries)
        +
        Converts the Iterable to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        arrayHashMap

        +
        @SafeVarargs
+public static <K,V> HashMap<K,V> arrayHashMap(Equal<K> equal,
+                                                            Hash<K> hash,
+                                                            P2<K,V>... entries)
        +
        Converts the array to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(Equal<K> equal,
+                                                 Hash<K> hash,
+                                                 java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      + + + +
        +
      • +

        iteratorHashMap

        +
        public static <K,V> HashMap<K,V> iteratorHashMap(java.util.Iterator<P2<K,V>> entries)
        +
        Converts the Iterator to a HashMap
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/HashSet.html b/javadoc/5.0/functionaljava/fj/data/HashSet.html new file mode 100644 index 0000000..bfcd674 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/HashSet.html @@ -0,0 +1,804 @@ + + + + + +HashSet (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class HashSet<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.HashSet<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class HashSet<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
    +
    +
    See Also:
    +
    HashMap
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HashSet(Equal<A> e, + Hash<A> h) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity) +
      Construct a hash set with the given equality and hashing strategy.
      +
      HashSet(Equal<A> e, + Hash<A> h, + int initialCapacity, + float loadFactor) +
      Construct a hash set with the given equality and hashing strategy.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> HashSet<A>arrayHashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>arrayHashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      voidclear() +
      Clear all elements from this hash set.
      +
      booleancontains(A a) +
      Determines if this hash set contains the given element.
      +
      booleandelete(A a) +
      Deletes the given element from this hash set.
      +
      static <A> HashSet<A>empty() +
      Creates an empty HashSet
      +
      static <A> HashSet<A>empty(Equal<A> e, + Hash<A> h) +
      Creates a new HashSet using the given Equal and Hash
      +
      booleaneq(A a1, + A a2) +
      Compare two values for equality using the underlying equality strategy.
      +
      static <A> HashSet<A>fromSet(java.util.Set<A> s) 
      inthash(A a) +
      Compute the hash of the given value using the underlying hashing strategy.
      +
      static <A> HashSet<A>hashSet(A... as) +
      Create a HashSet from the array.
      +
      static <A> HashSet<A>hashSet(Equal<A> e, + Hash<A> h, + A... as) +
      Create a HashSet from the array.
      +
      booleanisEmpty() +
      Determines if this hash set contains any elements.
      +
      static <A> HashSet<A>iterableHashSet(Equal<A> e, + Hash<A> h, + java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      static <A> HashSet<A>iterableHashSet(java.lang.Iterable<A> it) +
      Create a HashSet from the Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this hash set.
      +
      static <A> HashSet<A>iteratorHashSet(Equal<A> e, + Hash<A> h, + java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      static <A> HashSet<A>iteratorHashSet(java.util.Iterator<A> it) +
      Create a HashSet from the Iterator.
      +
      voidset(A a) +
      Insert the given element into this hash set.
      +
      intsize() +
      Returns the number of entries in this hash set.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this hash set.
      +
      java.util.List<A>toJavaList() 
      java.util.Set<A>toJavaSet() 
      List<A>toList() +
      Returns a list projection of this hash set.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        +
        • +
      + + + +
        +
      • +

        HashSet

        +
        public HashSet(Equal<A> e,
+               Hash<A> h,
+               int initialCapacity,
+               float loadFactor)
        +
        Construct a hash set with the given equality and hashing strategy.
        +
        +
        Parameters:
        +
        e - The equality strategy.
        +
        h - The hashing strategy.
        +
        initialCapacity - The initial capacity.
        +
        loadFactor - The load factor.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this hash set. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        eq

        +
        public boolean eq(A a1,
+                  A a2)
        +
        Compare two values for equality using the underlying equality strategy.
        +
        +
        Parameters:
        +
        a1 - One value to compare.
        +
        a2 - The other value to compare.
        +
        Returns:
        +
        true if the two values are equal, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        hash

        +
        public int hash(A a)
        +
        Compute the hash of the given value using the underlying hashing strategy.
        +
        +
        Parameters:
        +
        a - The value to computer the hash of.
        +
        Returns:
        +
        The hash of the given value.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty(Equal<A> e,
+                                   Hash<A> h)
        +
        Creates a new HashSet using the given Equal and Hash
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> HashSet<A> empty()
        +
        Creates an empty HashSet
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iterableHashSet

        +
        public static <A> HashSet<A> iterableHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.lang.Iterable<A> it)
        +
        Create a HashSet from the Iterable.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + +
        +
      • +

        iteratorHashSet

        +
        public static <A> HashSet<A> iteratorHashSet(Equal<A> e,
+                                             Hash<A> h,
+                                             java.util.Iterator<A> it)
        +
        Create a HashSet from the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        arrayHashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> arrayHashSet(Equal<A> e,
+                                                        Hash<A> h,
+                                                        A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        hashSet

        +
        @SafeVarargs
+public static <A> HashSet<A> hashSet(Equal<A> e,
+                                                   Hash<A> h,
+                                                   A... as)
        +
        Create a HashSet from the array.
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(A a)
        +
        Determines if this hash set contains the given element.
        +
        +
        Parameters:
        +
        a - The element to look for in this hash set.
        +
        Returns:
        +
        true if this hash set contains the given element, false otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public void set(A a)
        +
        Insert the given element into this hash set.
        +
        +
        Parameters:
        +
        a - The element to insert.
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        Clear all elements from this hash set.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this hash set contains any elements.
        +
        +
        Returns:
        +
        true if this hash set contains no elements, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this hash set.
        +
        +
        Returns:
        +
        The number of entries in this hash set.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public boolean delete(A a)
        +
        Deletes the given element from this hash set.
        +
        +
        Parameters:
        +
        a - The element to delete from this hash set.
        +
        Returns:
        +
        true if this hash set contained the given element prior to deletion, false + otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a list projection of this hash set.
        +
        +
        Returns:
        +
        A list projection of this hash set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public java.util.Set<A> toJavaSet()
        +
        • +
      + + + +
        +
      • +

        fromSet

        +
        public static <A> HashSet<A> fromSet(java.util.Set<A> s)
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this hash set.
        +
        +
        Returns:
        +
        An immutable collection of this hash set.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/IO.html b/javadoc/5.0/functionaljava/fj/data/IO.html new file mode 100644 index 0000000..c8a5134 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/IO.html @@ -0,0 +1,347 @@ + + + + + +IO (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface IO<A>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - the type of the result produced by the IO
    +
    +
    +
    All Superinterfaces:
    +
    Try0<A,java.io.IOException>
    +
    +
    +
    All Known Subinterfaces:
    +
    SafeIO<A>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface IO<A>
+extends Try0<A,java.io.IOException>
    +
    IO monad for processing files
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
+throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        default A f()
+     throws java.io.IOException
        +
        +
        Specified by:
        +
        f in interface Try0<A,java.io.IOException>
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        map

        +
        default <B> IO<B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        default <B> IO<B> bind(F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        append

        +
        default <B> IO<B> append(IO<B> iob)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/IOFunctions.html b/javadoc/5.0/functionaljava/fj/data/IOFunctions.html new file mode 100644 index 0000000..be46240 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/IOFunctions.html @@ -0,0 +1,1010 @@ + + + + + +IOFunctions (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class IOFunctions

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IOFunctions
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        closeReader

        +
        public static final F<java.io.Reader,IO<Unit>> closeReader
        +
        • +
      + + + +
        +
      • +

        ioUnit

        +
        public static final IO<Unit> ioUnit
        +
        • +
      + + + +
        +
      • +

        stdinBufferedReader

        +
        public static final java.io.BufferedReader stdinBufferedReader
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toTry

        +
        public static <A> Try0<A,java.io.IOException> toTry(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> P1<Validation<java.io.IOException,A>> p(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        fromF

        +
        public static <A> IO<A> fromF(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        fromTry

        +
        public static <A> IO<A> fromTry(Try0<A,? extends java.io.IOException> t)
        +
        • +
      + + + +
        +
      • +

        toSafe

        +
        public static <A> SafeIO<A> toSafe(IO<A> io)
        +
        Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        runSafe

        +
        public static <A> A runSafe(IO<A> io)
        +
        Run io, rethrowing any IOException wrapped in a RuntimeException
        +
        +
        Parameters:
        +
        io -
        +
        +
        • +
      + + + +
        +
      • +

        closeReader

        +
        public static IO<Unit> closeReader(java.io.Reader r)
        +
        • +
      + + + + + + + +
        +
      • +

        enumFileCharChunks

        +
        public static <A> IO<Iteratee.IterV<char[],A>> enumFileCharChunks(java.io.File f,
+                                                                  Option<java.nio.charset.Charset> encoding,
+                                                                  Iteratee.IterV<char[],A> i)
        +
        An IO monad that reads char chunks from the given file and passes them to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with char chunks read from the file
        +
        +
        • +
      + + + +
        +
      • +

        enumFileChars

        +
        public static <A> IO<Iteratee.IterV<java.lang.Character,A>> enumFileChars(java.io.File f,
+                                                                          Option<java.nio.charset.Charset> encoding,
+                                                                          Iteratee.IterV<java.lang.Character,A> i)
        +
        An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
        +
        +
        Parameters:
        +
        f - the file to read, must not be null
        +
        encoding - the encoding to use, Option.none() means platform default
        +
        i - the iteratee that is fed with chars read from the file
        +
        +
        • +
      + + + +
        +
      • +

        bufferedReader

        +
        public static IO<java.io.BufferedReader> bufferedReader(java.io.File f,
+                                                        Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        fileReader

        +
        public static IO<java.io.Reader> fileReader(java.io.File f,
+                                            Option<java.nio.charset.Charset> encoding)
        +
        • +
      + + + +
        +
      • +

        bracket

        +
        public static <A,B,C> IO<C> bracket(IO<A> init,
+                                    F<A,IO<B>> fin,
+                                    F<A,IO<C>> body)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <A> IO<A> unit(A a)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F0<A> p)
        +
        • +
      + + + +
        +
      • +

        lazy

        +
        public static <A> IO<A> lazy(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F<Unit,A> f)
        +
        • +
      + + + +
        +
      • +

        lazySafe

        +
        public static <A> SafeIO<A> lazySafe(F0<A> f)
        +
        • +
      + + + +
        +
      • +

        lineReader

        +
        public static <A> F<java.io.BufferedReader,F<Iteratee.IterV<java.lang.String,A>,IO<Iteratee.IterV<java.lang.String,A>>>> lineReader()
        +
        A function that feeds an iteratee with lines read from a BufferedReader.
        +
        • +
      + + + + + + + +
        +
      • +

        charChunkReader2

        +
        public static <A> F<java.io.Reader,F<Iteratee.IterV<java.lang.Character,A>,IO<Iteratee.IterV<java.lang.Character,A>>>> charChunkReader2()
        +
        A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size DEFAULT_BUFFER_SIZE).
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> IO<B> map(IO<A> io,
+                              F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        as

        +
        public static <A,B> IO<B> as(IO<A> io,
+                             B b)
        +
        • +
      + + + +
        +
      • +

        voided

        +
        public static <A> IO<Unit> voided(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> IO<B> bind(IO<A> io,
+                               F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        when

        +
        public static IO<Unit> when(java.lang.Boolean b,
+                            IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        unless

        +
        public static IO<Unit> unless(java.lang.Boolean b,
+                              IO<Unit> io)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<List<A>> sequence(List<IO<A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> IO<Stream<A>> sequence(Stream<IO<A>> stream)
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> IO<A> join(IO<IO<A>> io1)
        +
        • +
      + + + +
        +
      • +

        toSafeValidation

        +
        public static <A> SafeIO<Validation<java.io.IOException,A>> toSafeValidation(IO<A> io)
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B> IO<B> append(IO<A> io1,
+                                 IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        left

        +
        public static <A,B> IO<A> left(IO<A> io1,
+                               IO<B> io2)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <A,B> IO<B> flatMap(IO<A> io,
+                                  F<A,IO<B>> f)
        +
        • +
      + + + +
        +
      • +

        interactWhile

        +
        public static IO<Unit> interactWhile(F<java.lang.String,java.lang.Boolean> condition,
+                                     F<java.lang.String,java.lang.String> transform)
        +
        Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
        +
        +
        Parameters:
        +
        condition - Read lines until a line does not satisfy condition
        +
        transform - Function to change line value
        +
        +
        • +
      + + + +
        +
      • +

        sequenceWhileEager

        +
        public static <A> IO<Stream<A>> sequenceWhileEager(Stream<IO<A>> stream,
+                                                   F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        sequenceWhile

        +
        public static <A> IO<Stream<A>> sequenceWhile(Stream<IO<A>> stream,
+                                              F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public static <A,B> IO<B> apply(IO<A> io,
+                                IO<F<A,B>> iof)
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> IO<C> liftM2(IO<A> ioa,
+                                   IO<B> iob,
+                                   F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        replicateM

        +
        public static <A> IO<List<A>> replicateM(IO<A> ioa,
+                                         int n)
        +
        • +
      + + + +
        +
      • +

        readerState

        +
        public static <A> IO<State<java.io.BufferedReader,Validation<java.io.IOException,java.lang.String>>> readerState()
        +
        • +
      + + + +
        +
      • +

        stdinReadLine

        +
        public static IO<java.lang.String> stdinReadLine()
        +
        • +
      + + + +
        +
      • +

        stdoutPrintln

        +
        public static IO<Unit> stdoutPrintln(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        stdoutPrint

        +
        public static IO<Unit> stdoutPrint(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        getContents

        +
        public static IO<LazyString> getContents()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/IterableW.html b/javadoc/5.0/functionaljava/fj/data/IterableW.html new file mode 100644 index 0000000..fb47d81 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/IterableW.html @@ -0,0 +1,850 @@ + + + + + +IterableW (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class IterableW<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.IterableW<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class IterableW<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A wrapper for Iterable that equips it with some useful functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> IterableW<B>apply(java.lang.Iterable<F<A,B>> f) +
      Performs function application within an iterable (applicative functor pattern).
      +
      static <A,B> F<F<A,B>,F<A,IterableW<B>>>arrow() +
      Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
      +
      static <A,B,T extends java.lang.Iterable<B>>
      F<IterableW<A>,F<F<A,T>,IterableW<B>>>      		bind() +
      The first-class bind function over Iterable.
      +
      <B,T extends java.lang.Iterable<B>>
      IterableW<B>      		bind(F<A,T> f) +
      Binds the given function across the wrapped Iterable with a final join.
      +
      static <A,B,C> IterableW<C>bind(java.lang.Iterable<A> a, + java.lang.Iterable<B> b, + F<A,F<B,C>> f) +
      Binds the given function to the values in the given iterables with a final join.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      The catamorphism for Iterables, implemented as a left fold.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) +
      The catamorphism for Iterables, implemented as a right fold.
      +
      static <A> IterableW<A>iterable(A a) +
      Returns an Iterable that completely preserves the argument.
      +
      static <A,B> F<A,IterableW<B>>iterable(F<A,B> f) +
      Wraps a given function's return value in a Iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      F<java.lang.Iterable<T>,IterableW<A>>      		join() +
      Returns a function that joins an Iterable of Iterables into a single Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<A>      		join(java.lang.Iterable<T> as) +
      Joins an Iterable of Iterables into a single Iterable.
      +
      static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 to a function on iterables.
      +
      static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>>map() +
      Returns a function that promotes any function so that it operates on Iterables.
      +
      <B> IterableW<B>map(F<A,B> f) +
      Maps a given function across the wrapped Iterable.
      +
      static <A,T extends java.lang.Iterable<A>>
      IterableW<IterableW<A>>      		sequence(java.lang.Iterable<T> as) +
      Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
      +
      java.util.List<A>toStandardList() +
      Returns a java.util.List implementation for this iterable.
      +
      Option<Zipper<A>>toZipper() 
      static <A,T extends java.lang.Iterable<A>>
      F<T,IterableW<A>>      		wrap() +
      Provides a function that wraps the given iterable.
      +
      static <A> IterableW<A>wrap(java.lang.Iterable<A> a) +
      Wraps the given iterable.
      +
      <B> IterableW<B>zapp(java.lang.Iterable<F<A,B>> fs) +
      Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
      +
      <B> java.lang.Iterable<P2<A,B>>zip(java.lang.Iterable<B> bs) +
      Zips this iterable with the given iterable to produce a iterable of pairs.
      +
      java.lang.Iterable<P2<A,java.lang.Integer>>zipIndex() +
      Zips this iterable with the index of its element as a pair.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F<A,F<B,C>> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      <B,C> java.lang.Iterable<C>zipWith(java.lang.Iterable<B> bs, + F2<A,B,C> f) +
      Zips this iterable with the given iterable using the given function to produce a new iterable.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        wrap

        +
        public static <A> IterableW<A> wrap(java.lang.Iterable<A> a)
        +
        Wraps the given iterable.
        +
        +
        Parameters:
        +
        a - The iterable to wrap.
        +
        Returns:
        +
        An iterable equipped with some useful functions.
        +
        +
        • +
      + + + +
        +
      • +

        wrap

        +
        public static <A,T extends java.lang.Iterable<A>> F<T,IterableW<A>> wrap()
        +
        Provides a function that wraps the given iterable.
        +
        +
        Returns:
        +
        A function that returns the given iterable, wrapped.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterable

        +
        public static <A> IterableW<A> iterable(A a)
        +
        Returns an Iterable that completely preserves the argument. The unit function for Iterables.
        +
        +
        Parameters:
        +
        a - A value to preserve in an Iterable.
        +
        Returns:
        +
        An Iterable that yields the argument when iterated over.
        +
        +
        • +
      + + + +
        +
      • +

        iterable

        +
        public static <A,B> F<A,IterableW<B>> iterable(F<A,B> f)
        +
        Wraps a given function's return value in a Iterable. + The Kleisli arrow for Iterables.
        +
        +
        Parameters:
        +
        f - The function whose return value to wrap in a Iterable.
        +
        Returns:
        +
        The equivalent function whose return value is iterable.
        +
        +
        • +
      + + + +
        +
      • +

        arrow

        +
        public static <A,B> F<F<A,B>,F<A,IterableW<B>>> arrow()
        +
        Provides a transformation from a function to a Iterable-valued function that is equivalent to it. + The first-class Kleisli arrow for Iterables.
        +
        +
        Returns:
        +
        A transformation from a function to the equivalent Iterable-valued function.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,T extends java.lang.Iterable<B>> IterableW<B> bind(F<A,T> f)
        +
        Binds the given function across the wrapped Iterable with a final join.
        +
        +
        Parameters:
        +
        f - A function to bind across the Iterable.
        +
        Returns:
        +
        an iterable result of binding the given function over the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> IterableW<B> apply(java.lang.Iterable<F<A,B>> f)
        +
        Performs function application within an iterable (applicative functor pattern).
        +
        +
        Parameters:
        +
        f - The iterable function to apply.
        +
        Returns:
        +
        A new iterable after applying the given iterable function to the wrapped iterable.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,C> IterableW<C> bind(java.lang.Iterable<A> a,
+                                        java.lang.Iterable<B> b,
+                                        F<A,F<B,C>> f)
        +
        Binds the given function to the values in the given iterables with a final join.
        +
        +
        Parameters:
        +
        a - A given iterable to bind the given function with.
        +
        b - A given iterable to bind the given function with.
        +
        f - The function to apply to the values in the given iterables.
        +
        Returns:
        +
        A new iterable after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<java.lang.Iterable<A>,F<java.lang.Iterable<B>,IterableW<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 to a function on iterables.
        +
        +
        Parameters:
        +
        f - The function to promote.
        +
        Returns:
        +
        A function of arity-2 promoted to map over iterables.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<IterableW<A>> sequence(java.lang.Iterable<T> as)
        +
        Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable. + This implementation is strict and requires O(n) stack space.
        +
        +
        Parameters:
        +
        as - The iterable of iterables to transform.
        +
        Returns:
        +
        A iterable of iterables containing the results of the bind operations across all given iterables.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B,T extends java.lang.Iterable<B>> F<IterableW<A>,F<F<A,T>,IterableW<B>>> bind()
        +
        The first-class bind function over Iterable. + Returns a function that binds a given function across a given iterable.
        +
        +
        Returns:
        +
        a function that binds a given function across a given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> IterableW<A> join(java.lang.Iterable<T> as)
        +
        Joins an Iterable of Iterables into a single Iterable.
        +
        +
        Parameters:
        +
        as - An Iterable of Iterables to join.
        +
        Returns:
        +
        the joined Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A,T extends java.lang.Iterable<A>> F<java.lang.Iterable<T>,IterableW<A>> join()
        +
        Returns a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        Returns:
        +
        a function that joins an Iterable of Iterables into a single Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> IterableW<B> map(F<A,B> f)
        +
        Maps a given function across the wrapped Iterable.
        +
        +
        Parameters:
        +
        f - A function to map across the wrapped Iterable.
        +
        Returns:
        +
        An Iterable of the results of mapping the given function across the wrapped Iterable.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<IterableW<A>,IterableW<B>>> map()
        +
        Returns a function that promotes any function so that it operates on Iterables.
        +
        +
        Returns:
        +
        a function that promotes any function so that it operates on Iterables.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> f,
+                      B z)
        +
        The catamorphism for Iterables, implemented as a left fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied first (leftmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the iterable.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        The catamorphism for Iterables, implemented as a right fold.
        +
        +
        Parameters:
        +
        f - The function with which to fold the wrapped iterable.
        +
        z - The base case value of the destination type, applied last (rightmost) to the fold.
        +
        Returns:
        +
        The result of the catamorphism.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this iterable.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public <B> IterableW<B> zapp(java.lang.Iterable<F<A,B>> fs)
        +
        Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable. The iteration is normalised + so that it ends when one of the iterators is exhausted.
        +
        +
        Parameters:
        +
        fs - The iterable of functions to apply to this iterable.
        +
        Returns:
        +
        A new iterable with the results of applying the functions to this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F<A,F<B,C>> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> java.lang.Iterable<C> zipWith(java.lang.Iterable<B> bs,
+                                           F2<A,B,C> f)
        +
        Zips this iterable with the given iterable using the given function to produce a new iterable. If + this iterable and the given iterable have different lengths, then the longer iterable is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        f - The function to zip this iterable and the given iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> java.lang.Iterable<P2<A,B>> zip(java.lang.Iterable<B> bs)
        +
        Zips this iterable with the given iterable to produce a iterable of pairs. If this iterable and the + given iterable have different lengths, then the longer iterable is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The iterable to zip this iterable with.
        +
        Returns:
        +
        A new iterable with a length the same as the shortest of this iterable and the given + iterable.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public java.lang.Iterable<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this iterable with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new iterable with the same length as this iterable.
        +
        +
        • +
      + + + +
        +
      • +

        toStandardList

        +
        public java.util.List<A> toStandardList()
        +
        Returns a java.util.List implementation for this iterable. + The returned list cannot be modified.
        +
        +
        Returns:
        +
        An immutable implementation of java.util.List for this iterable.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Iteratee.Input.html b/javadoc/5.0/functionaljava/fj/data/Iteratee.Input.html new file mode 100644 index 0000000..8602f0c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Iteratee.Input.html @@ -0,0 +1,293 @@ + + + + + +Iteratee.Input (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.Input<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.Input<E>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.Input<E>
+extends java.lang.Object
    +
    The input to an iteratee.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public abstract <Z> Z apply(F0<Z> empty,
+                            F0<F<E,Z>> el,
+                            F0<Z> eof)
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <E> Iteratee.Input<E> empty()
        +
        Input that has no values available
        +
        • +
      + + + +
        +
      • +

        eof

        +
        public static <E> Iteratee.Input<E> eof()
        +
        Input that is exhausted
        +
        • +
      + + + + + +
        +
      • +

        el

        +
        public static <E> Iteratee.Input<E> el(E element)
        +
        Input that has a value available
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Iteratee.IterV.html b/javadoc/5.0/functionaljava/fj/data/Iteratee.IterV.html new file mode 100644 index 0000000..3f4a81a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Iteratee.IterV.html @@ -0,0 +1,388 @@ + + + + + +Iteratee.IterV (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee.IterV<E,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee.IterV<E,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Iteratee
    +
    +
    +
    +
    public abstract static class Iteratee.IterV<E,A>
+extends java.lang.Object
    +
    A pure iteratee computation which is either done or needs more input
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Iteratee.html b/javadoc/5.0/functionaljava/fj/data/Iteratee.html new file mode 100644 index 0000000..d153449 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Iteratee.html @@ -0,0 +1,221 @@ + + + + + +Iteratee (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Iteratee

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Iteratee
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Iteratee
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Iteratee.Input<E> +
      The input to an iteratee.
      +
      static class Iteratee.IterV<E,A> +
      A pure iteratee computation which is either done or needs more input
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Java.html b/javadoc/5.0/functionaljava/fj/data/Java.html new file mode 100644 index 0000000..978f54e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Java.html @@ -0,0 +1,3623 @@ + + + + + +Java (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Java

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java
+extends java.lang.Object
    +
    Functions that convert between types from the core Java API.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<Array<java.lang.Boolean>,java.util.BitSet>Array_BitSet +
      A function that converts arrays to bit sets.
      +
      static F<java.util.BitSet,List<java.lang.Boolean>>BitSet_List +
      A function that converts bit sets to lists.
      +
      static F<List<java.lang.Boolean>,java.util.BitSet>List_BitSet +
      A function that converts lists to bit sets.
      +
      static F<Option<java.lang.Boolean>,java.util.BitSet>Option_BitSet +
      A function that converts options to bit sets.
      +
      static F<Stream<java.lang.Boolean>,java.util.BitSet>Stream_BitSet +
      A function that converts streams to bit sets.
      +
      static F<java.lang.String,java.util.ArrayList<java.lang.Character>>String_ArrayList +
      A function that converts strings to array lists.
      +
      static F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>String_ConcurrentLinkedQueue +
      A function that converts strings to concurrent linked queues.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>String_CopyOnWriteArrayList +
      A function that converts strings to copy on write array lists.
      +
      static F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>String_CopyOnWriteArraySet +
      A function that converts strings to copy on write array sets.
      +
      static F<java.lang.String,java.util.HashSet<java.lang.Character>>String_HashSet +
      A function that converts strings to hash sets.
      +
      static F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>String_LinkedBlockingQueue +
      A function that converts strings to linked blocking queues.
      +
      static F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>>String_LinkedHashSet +
      A function that converts strings to linked hash sets.
      +
      static F<java.lang.String,java.util.LinkedList<java.lang.Character>>String_LinkedList +
      A function that converts strings to linked lists.
      +
      static F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>String_PriorityBlockingQueue +
      A function that converts strings to priority blocking queues.
      +
      static F<java.lang.String,java.util.PriorityQueue<java.lang.Character>>String_PriorityQueue +
      A function that converts strings to priority queues.
      +
      static F<java.lang.String,java.util.Stack<java.lang.Character>>String_Stack +
      A function that converts strings to stacks.
      +
      static F<java.lang.String,java.util.TreeSet<java.lang.Character>>String_TreeSet +
      A function that converts strings to tree sets.
      +
      static F<java.lang.String,java.util.Vector<java.lang.Character>>String_Vector +
      A function that converts strings to vectors.
      +
      static F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>>StringBuffer_ArrayList +
      A function that converts string buffers to array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuffer_ConcurrentLinkedQueue +
      A function that converts string buffers to concurrent linked queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuffer_CopyOnWriteArrayList +
      A function that converts string buffers to copy on write array lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuffer_CopyOnWriteArraySet +
      A function that converts string buffers to copy on write array sets.
      +
      static F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>>StringBuffer_HashSet +
      A function that converts string buffers to hash sets.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuffer_LinkedBlockingQueue +
      A function that converts string buffers to linked blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>>StringBuffer_LinkedHashSet +
      A function that converts string buffers to linked hash sets.
      +
      static F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>>StringBuffer_LinkedList +
      A function that converts string buffers to linked lists.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuffer_PriorityBlockingQueue +
      A function that converts string buffers to priority blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>>StringBuffer_PriorityQueue +
      A function that converts string buffers to priority queues.
      +
      static F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>>StringBuffer_Stack +
      A function that converts string buffers to stacks.
      +
      static F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>>StringBuffer_TreeSet +
      A function that converts string buffers to tree sets.
      +
      static F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>>StringBuffer_Vector +
      A function that converts string buffers to vectors.
      +
      static F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>>StringBuilder_ArrayList +
      A function that converts string builders to array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>>StringBuilder_ConcurrentLinkedQueue +
      A function that converts string builders to concurrent linked queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>>StringBuilder_CopyOnWriteArrayList +
      A function that converts string builders to copy on write array lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>>StringBuilder_CopyOnWriteArraySet +
      A function that converts string builders to copy on write array sets.
      +
      static F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>>StringBuilder_HashSet +
      A function that converts string builders to hash sets.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>>StringBuilder_LinkedBlockingQueue +
      A function that converts string builders to linked blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>>StringBuilder_LinkedHashSet +
      A function that converts string builders to linked hash sets.
      +
      static F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>>StringBuilder_LinkedList +
      A function that converts string builders to linked lists.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>>StringBuilder_PriorityBlockingQueue +
      A function that converts string builders to priority blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>>StringBuilder_PriorityQueue +
      A function that converts string builders to priority queues.
      +
      static F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>>StringBuilder_Stack +
      A function that converts string builders to stacks.
      +
      static F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>>StringBuilder_TreeSet +
      A function that converts string builders to tree sets.
      +
      static F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>>StringBuilder_Vector +
      A function that converts string builders to vectors.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>>Array_ArrayBlockingQueue(boolean fair) +
      A function that converts arrays to array blocking queues.
      +
      static <A> F<Array<A>,java.util.ArrayList<A>>Array_ArrayList() +
      A function that converts arrays to array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Array_ConcurrentLinkedQueue() +
      A function that converts arrays to concurrent linked queues.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Array_CopyOnWriteArrayList() +
      A function that converts arrays to copy on write array lists.
      +
      static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Array_CopyOnWriteArraySet() +
      A function that converts arrays to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Array<A>,java.util.concurrent.DelayQueue<A>>      		Array_DelayQueue() +
      A function that converts arrays to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Array<A>,java.util.EnumSet<A>>      		Array_EnumSet() +
      A function that converts arrays to enum sets.
      +
      static <A> F<Array<A>,java.util.HashSet<A>>Array_HashSet() +
      A function that converts arrays to hash sets.
      +
      static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>>Array_LinkedBlockingQueue() +
      A function that converts arrays to linked blocking queues.
      +
      static <A> F<Array<A>,java.util.LinkedHashSet<A>>Array_LinkedHashSet() +
      A function that converts arrays to linked hash sets.
      +
      static <A> F<Array<A>,java.util.LinkedList<A>>Array_LinkedList() +
      A function that converts arrays to linked lists.
      +
      static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>>Array_PriorityBlockingQueue() +
      A function that converts arrays to priority blocking queues.
      +
      static <A> F<Array<A>,java.util.PriorityQueue<A>>Array_PriorityQueue() +
      A function that converts arrays to priority queues.
      +
      static <A> F<Array<A>,java.util.Stack<A>>Array_Stack() +
      A function that converts arrays to stacks.
      +
      static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>>Array_SynchronousQueue(boolean fair) +
      A function that converts arrays to synchronous queues.
      +
      static <A> F<Array<A>,java.util.TreeSet<A>>Array_TreeSet() +
      A function that converts arrays to tree sets.
      +
      static <A> F<Array<A>,java.util.Vector<A>>Array_Vector() +
      A function that converts arrays to vectors.
      +
      static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>>ArrayBlockingQueue_List() +
      A function that converts array blocking queues to lists.
      +
      static <A> F<java.util.ArrayList<A>,List<A>>ArrayList_List() +
      A function that converts array lists to lists.
      +
      static <A> F<java.util.Collection<A>,List<A>>Collection_List() 
      static <A> List<A>Collection_List(java.util.Collection<A> c) 
      static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>>ConcurrentLinkedQueue_List() +
      A function that converts concurrent linked queues to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>>CopyOnWriteArrayList_List() +
      A function that converts copy on write array lists to lists.
      +
      static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>>CopyOnWriteArraySet_List() +
      A function that converts copy on write array sets to lists.
      +
      static <A extends java.util.concurrent.Delayed>
      F<java.util.concurrent.DelayQueue<A>,List<A>>      		DelayQueue_List() +
      A function that converts delay queues to lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>>Either_ArrayBlockingQueueA(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>>Either_ArrayBlockingQueueB(boolean fair) +
      A function that converts eithers to array blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<A>>Either_ArrayListA() +
      A function that converts eithers to array lists.
      +
      static <A,B> F<Either<A,B>,java.util.ArrayList<B>>Either_ArrayListB() +
      A function that converts eithers to array lists.
      +
      static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet>Either_BitSetA() +
      A function that converts eithers to bit sets.
      +
      static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet>Either_BitSetB() +
      A function that converts eithers to bit sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>>Either_ConcurrentLinkedQueueA() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>>Either_ConcurrentLinkedQueueB() +
      A function that converts eithers to concurrent linked queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>>Either_CopyOnWriteArrayListA() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>>Either_CopyOnWriteArrayListB() +
      A function that converts eithers to copy on write array lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>>Either_CopyOnWriteArraySetA() +
      A function that converts eithers to copy on write array sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>>Either_CopyOnWriteArraySetB() +
      A function that converts eithers to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed,B>
      F<Either<A,B>,java.util.concurrent.DelayQueue<A>>      		Either_DelayQueueA() +
      A function that converts eithers to delay queues.
      +
      static <A,B extends java.util.concurrent.Delayed>
      F<Either<A,B>,java.util.concurrent.DelayQueue<B>>      		Either_DelayQueueB() +
      A function that converts eithers to delay queues.
      +
      static <A extends java.lang.Enum<A>,B>
      F<Either<A,B>,java.util.EnumSet<A>>      		Either_EnumSetA() +
      A function that converts eithers to enum sets.
      +
      static <A,B extends java.lang.Enum<B>>
      F<Either<A,B>,java.util.EnumSet<B>>      		Either_EnumSetB() +
      A function that converts eithers to enum sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<A>>Either_HashSetA() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.HashSet<B>>Either_HashSetB() +
      A function that converts eithers to hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>>Either_LinkedBlockingQueueA() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>>Either_LinkedBlockingQueueB() +
      A function that converts eithers to linked blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>>Either_LinkedHashSetA() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>>Either_LinkedHashSetB() +
      A function that converts eithers to linked hash sets.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<A>>Either_LinkedListA() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.LinkedList<B>>Either_LinkedListB() +
      A function that converts eithers to linked lists.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>>Either_PriorityBlockingQueueA() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>>Either_PriorityBlockingQueueB() +
      A function that converts eithers to priority blocking queues.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<A>>Either_StackA() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.Stack<B>>Either_StackB() +
      A function that converts eithers to stacks.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>>Either_SynchronousQueueA(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>>Either_SynchronousQueueB(boolean fair) +
      A function that converts eithers to synchronous queues.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<A>>Either_TreeSetA() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.TreeSet<B>>Either_TreeSetB() +
      A function that converts eithers to tree sets.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<A>>Either_VectorA() +
      A function that converts eithers to vectors.
      +
      static <A,B> F<Either<A,B>,java.util.Vector<B>>Either_VectorB() +
      A function that converts eithers to vectors.
      +
      static <A extends java.lang.Enum<A>>
      F<java.util.EnumSet<A>,List<A>>      		EnumSet_List() +
      A function that converts enum sets to lists.
      +
      static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>>Future_P1() 
      static <A> F<java.util.HashSet<A>,List<A>>HashSet_List() +
      A function that converts hash sets to lists.
      +
      static <A> F<java.util.List<A>,List<A>>JavaList_List() 
      static <A> List<A>JavaList_List(java.util.List<A> list) 
      static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>>LinkedBlockingQueue_List() +
      A function that converts linked blocking queues to lists.
      +
      static <A> F<java.util.LinkedHashSet<A>,List<A>>LinkedHashSet_List() +
      A function that converts linked hash sets to lists.
      +
      static <A> F<java.util.LinkedList<A>,List<A>>LinkedList_List() +
      A function that converts linked lists to lists.
      +
      static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>>List_ArrayBlockingQueue(boolean fair) +
      A function that converts lists to array blocking queue.
      +
      static <A> F<List<A>,java.util.ArrayList<A>>List_ArrayList() +
      A function that converts lists to array lists.
      +
      static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>List_ConcurrentLinkedQueue() +
      A function that converts lists to concurrent linked queues.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>>List_CopyOnWriteArrayList() +
      A function that converts lists to copy on write array lists.
      +
      static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>>List_CopyOnWriteArraySet() +
      A function that converts lists to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<List<A>,java.util.concurrent.DelayQueue<A>>      		List_DelayQueue() +
      A function that converts lists to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<List<A>,java.util.EnumSet<A>>      		List_EnumSet() +
      A function that converts lists to array enum sets.
      +
      static <A> F<List<A>,java.util.HashSet<A>>List_HashSet() +
      A function that converts lists to hash sets.
      +
      static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>>List_LinkedBlockingQueue() +
      A function that converts lists to linked blocking queues.
      +
      static <A> F<List<A>,java.util.LinkedHashSet<A>>List_LinkedHashSet() +
      A function that converts lists to linked hash sets.
      +
      static <A> F<List<A>,java.util.LinkedList<A>>List_LinkedList() +
      A function that converts lists to linked lists.
      +
      static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>>List_PriorityBlockingQueue() +
      A function that converts lists to priority blocking queues.
      +
      static <A> F<List<A>,java.util.PriorityQueue<A>>List_PriorityQueue() +
      A function that converts lists to priority queues.
      +
      static <A> F<List<A>,java.util.Stack<A>>List_Stack() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>>List_SynchronousQueue(boolean fair) +
      A function that converts lists to synchronous queues.
      +
      static <A> F<List<A>,java.util.TreeSet<A>>List_TreeSet() +
      A function that converts lists to stacks.
      +
      static <A> F<List<A>,java.util.Vector<A>>List_Vector() +
      A function that converts lists to vectors.
      +
      static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>>Option_ArrayBlockingQueue(boolean fair) +
      A function that converts options to array blocking queues.
      +
      static <A> F<Option<A>,java.util.ArrayList<A>>Option_ArrayList() +
      A function that converts options to array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Option_ConcurrentLinkedQueue() +
      A function that converts options to concurrent linked queues.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Option_CopyOnWriteArrayList() +
      A function that converts options to copy on write array lists.
      +
      static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Option_CopyOnWriteArraySet() +
      A function that converts options to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Option<A>,java.util.concurrent.DelayQueue<A>>      		Option_DelayQueue() +
      A function that converts options to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Option<A>,java.util.EnumSet<A>>      		Option_EnumSet() +
      A function that converts options to enum sets.
      +
      static <A> F<Option<A>,java.util.HashSet<A>>Option_HashSet() +
      A function that converts options to hash sets.
      +
      static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>>Option_LinkedBlockingQueue() +
      A function that converts options to linked blocking queues.
      +
      static <A> F<Option<A>,java.util.LinkedHashSet<A>>Option_LinkedHashSet() +
      A function that converts options to linked hash sets.
      +
      static <A> F<Option<A>,java.util.LinkedList<A>>Option_LinkedList() +
      A function that converts options to linked lists.
      +
      static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>>Option_PriorityBlockingQueue() +
      A function that converts options to priority blocking queues.
      +
      static <A> F<Option<A>,java.util.PriorityQueue<A>>Option_PriorityQueue() +
      A function that converts options to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>>Option_PriorityQueueA() +
      A function that converts eithers to priority queues.
      +
      static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>>Option_PriorityQueueB() +
      A function that converts eithers to priority queues.
      +
      static <A> F<Option<A>,java.util.Stack<A>>Option_Stack() +
      A function that converts options to stacks.
      +
      static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>>Option_SynchronousQueue(boolean fair) +
      A function that converts options to synchronous queues.
      +
      static <A> F<Option<A>,java.util.TreeSet<A>>Option_TreeSet() +
      A function that converts options to tree sets.
      +
      static <A> F<Option<A>,java.util.Vector<A>>Option_Vector() +
      A function that converts options to vectors.
      +
      static <A> F<P1<A>,java.util.concurrent.Callable<A>>P1_Callable() 
      static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>>PriorityBlockingQueue_List() +
      A function that converts priority blocking queues to lists.
      +
      static <A> F<java.util.PriorityQueue<A>,List<A>>PriorityQueue_List() +
      A function that converts priority queues to lists.
      +
      static <A> F<java.util.Stack<A>,List<A>>Stack_List() +
      A function that converts stacks to lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>>Stream_ArrayBlockingQueue(boolean fair) +
      A function that converts streams to array blocking queues.
      +
      static <A> F<Stream<A>,java.util.ArrayList<A>>Stream_ArrayList() +
      A function that converts streams to array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>>Stream_ConcurrentLinkedQueue() +
      A function that converts streams to concurrent linked queues.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>>Stream_CopyOnWriteArrayList() +
      A function that converts streams to copy on write array lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>>Stream_CopyOnWriteArraySet() +
      A function that converts streams to copy on write array sets.
      +
      static <A extends java.util.concurrent.Delayed>
      F<Stream<A>,java.util.concurrent.DelayQueue<A>>      		Stream_DelayQueue() +
      A function that converts streams to delay queues.
      +
      static <A extends java.lang.Enum<A>>
      F<Stream<A>,java.util.EnumSet<A>>      		Stream_EnumSet() +
      A function that converts streams to enum sets.
      +
      static <A> F<Stream<A>,java.util.HashSet<A>>Stream_HashSet() +
      A function that converts streams to hash sets.
      +
      static <A> F<Stream<A>,java.lang.Iterable<A>>Stream_Iterable() +
      A function that converts streams to iterable.
      +
      static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>>Stream_LinkedBlockingQueue() +
      A function that converts streams to linked blocking queues.
      +
      static <A> F<Stream<A>,java.util.LinkedHashSet<A>>Stream_LinkedHashSet() +
      A function that converts streams to linked hash sets.
      +
      static <A> F<Stream<A>,java.util.LinkedList<A>>Stream_LinkedList() +
      A function that converts streams to linked lists.
      +
      static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>>Stream_PriorityBlockingQueue() +
      A function that converts streams to priority blocking queues.
      +
      static <A> F<Stream<A>,java.util.PriorityQueue<A>>Stream_PriorityQueue() +
      A function that converts streams to priority queues.
      +
      static <A> F<Stream<A>,java.util.Stack<A>>Stream_Stack() +
      A function that converts streams to stacks.
      +
      static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>>Stream_SynchronousQueue(boolean fair) +
      A function that converts streams to synchronous queues.
      +
      static <A> F<Stream<A>,java.util.TreeSet<A>>Stream_TreeSet() +
      A function that converts streams to tree sets.
      +
      static <A> F<Stream<A>,java.util.Vector<A>>Stream_Vector() +
      A function that converts streams to vectors.
      +
      static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>String_ArrayBlockingQueue(boolean fair) +
      A function that converts strings to array blocking queues.
      +
      static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>>String_SynchronousQueue(boolean fair) +
      A function that converts strings to synchronous queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuffer_ArrayBlockingQueue(boolean fair) +
      A function that converts string buffers to array blocking queues.
      +
      static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuffer_SynchronousQueue(boolean fair) +
      A function that converts string buffers to synchronous queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>>StringBuilder_ArrayBlockingQueue(boolean fair) +
      A function that converts string builders to array blocking queues.
      +
      static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>>StringBuilder_SynchronousQueue(boolean fair) +
      A function that converts string builders to synchronous queues.
      +
      static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>>SynchronousQueue_List() +
      A function that converts synchronous queues to lists.
      +
      static <A> F<java.util.TreeSet<A>,List<A>>TreeSet_List() +
      A function that converts tree sets to lists.
      +
      static <A> F<java.util.Vector<A>,List<A>>Vector_List() +
      A function that converts vectors to lists.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        List_BitSet

        +
        public static final F<List<java.lang.Boolean>,java.util.BitSet> List_BitSet
        +
        A function that converts lists to bit sets.
        +
        • +
      + + + +
        +
      • +

        Array_BitSet

        +
        public static final F<Array<java.lang.Boolean>,java.util.BitSet> Array_BitSet
        +
        A function that converts arrays to bit sets.
        +
        • +
      + + + +
        +
      • +

        Stream_BitSet

        +
        public static final F<Stream<java.lang.Boolean>,java.util.BitSet> Stream_BitSet
        +
        A function that converts streams to bit sets.
        +
        • +
      + + + +
        +
      • +

        Option_BitSet

        +
        public static final F<Option<java.lang.Boolean>,java.util.BitSet> Option_BitSet
        +
        A function that converts options to bit sets.
        +
        • +
      + + + +
        +
      • +

        String_ArrayList

        +
        public static final F<java.lang.String,java.util.ArrayList<java.lang.Character>> String_ArrayList
        +
        A function that converts strings to array lists.
        +
        • +
      + + + +
        +
      • +

        String_HashSet

        +
        public static final F<java.lang.String,java.util.HashSet<java.lang.Character>> String_HashSet
        +
        A function that converts strings to hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedHashSet

        +
        public static final F<java.lang.String,java.util.LinkedHashSet<java.lang.Character>> String_LinkedHashSet
        +
        A function that converts strings to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedList

        +
        public static final F<java.lang.String,java.util.LinkedList<java.lang.Character>> String_LinkedList
        +
        A function that converts strings to linked lists.
        +
        • +
      + + + +
        +
      • +

        String_PriorityQueue

        +
        public static final F<java.lang.String,java.util.PriorityQueue<java.lang.Character>> String_PriorityQueue
        +
        A function that converts strings to priority queues.
        +
        • +
      + + + +
        +
      • +

        String_Stack

        +
        public static final F<java.lang.String,java.util.Stack<java.lang.Character>> String_Stack
        +
        A function that converts strings to stacks.
        +
        • +
      + + + +
        +
      • +

        String_TreeSet

        +
        public static final F<java.lang.String,java.util.TreeSet<java.lang.Character>> String_TreeSet
        +
        A function that converts strings to tree sets.
        +
        • +
      + + + +
        +
      • +

        String_Vector

        +
        public static final F<java.lang.String,java.util.Vector<java.lang.Character>> String_Vector
        +
        A function that converts strings to vectors.
        +
        • +
      + + + +
        +
      • +

        String_ConcurrentLinkedQueue

        +
        public static final F<java.lang.String,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> String_ConcurrentLinkedQueue
        +
        A function that converts strings to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArrayList

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> String_CopyOnWriteArrayList
        +
        A function that converts strings to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        String_CopyOnWriteArraySet

        +
        public static final F<java.lang.String,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> String_CopyOnWriteArraySet
        +
        A function that converts strings to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        String_LinkedBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> String_LinkedBlockingQueue
        +
        A function that converts strings to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        String_PriorityBlockingQueue

        +
        public static final F<java.lang.String,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> String_PriorityBlockingQueue
        +
        A function that converts strings to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.ArrayList<java.lang.Character>> StringBuffer_ArrayList
        +
        A function that converts string buffers to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_HashSet

        +
        public static final F<java.lang.StringBuffer,java.util.HashSet<java.lang.Character>> StringBuffer_HashSet
        +
        A function that converts string buffers to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedHashSet

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedHashSet<java.lang.Character>> StringBuffer_LinkedHashSet
        +
        A function that converts string buffers to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedList

        +
        public static final F<java.lang.StringBuffer,java.util.LinkedList<java.lang.Character>> StringBuffer_LinkedList
        +
        A function that converts string buffers to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityQueue

        +
        public static final F<java.lang.StringBuffer,java.util.PriorityQueue<java.lang.Character>> StringBuffer_PriorityQueue
        +
        A function that converts string buffers to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Stack

        +
        public static final F<java.lang.StringBuffer,java.util.Stack<java.lang.Character>> StringBuffer_Stack
        +
        A function that converts string buffers to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_TreeSet

        +
        public static final F<java.lang.StringBuffer,java.util.TreeSet<java.lang.Character>> StringBuffer_TreeSet
        +
        A function that converts string buffers to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_Vector

        +
        public static final F<java.lang.StringBuffer,java.util.Vector<java.lang.Character>> StringBuffer_Vector
        +
        A function that converts string buffers to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuffer_ConcurrentLinkedQueue
        +
        A function that converts string buffers to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuffer_CopyOnWriteArrayList
        +
        A function that converts string buffers to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuffer_CopyOnWriteArraySet
        +
        A function that converts string buffers to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuffer_LinkedBlockingQueue
        +
        A function that converts string buffers to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuffer_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuffer,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuffer_PriorityBlockingQueue
        +
        A function that converts string buffers to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.ArrayList<java.lang.Character>> StringBuilder_ArrayList
        +
        A function that converts string builders to array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_HashSet

        +
        public static final F<java.lang.StringBuilder,java.util.HashSet<java.lang.Character>> StringBuilder_HashSet
        +
        A function that converts string builders to hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedHashSet

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedHashSet<java.lang.Character>> StringBuilder_LinkedHashSet
        +
        A function that converts string builders to linked hash sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedList

        +
        public static final F<java.lang.StringBuilder,java.util.LinkedList<java.lang.Character>> StringBuilder_LinkedList
        +
        A function that converts string builders to linked lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityQueue

        +
        public static final F<java.lang.StringBuilder,java.util.PriorityQueue<java.lang.Character>> StringBuilder_PriorityQueue
        +
        A function that converts string builders to priority queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Stack

        +
        public static final F<java.lang.StringBuilder,java.util.Stack<java.lang.Character>> StringBuilder_Stack
        +
        A function that converts string builders to stacks.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_TreeSet

        +
        public static final F<java.lang.StringBuilder,java.util.TreeSet<java.lang.Character>> StringBuilder_TreeSet
        +
        A function that converts string builders to tree sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_Vector

        +
        public static final F<java.lang.StringBuilder,java.util.Vector<java.lang.Character>> StringBuilder_Vector
        +
        A function that converts string builders to vectors.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ConcurrentLinkedQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.ConcurrentLinkedQueue<java.lang.Character>> StringBuilder_ConcurrentLinkedQueue
        +
        A function that converts string builders to concurrent linked queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArrayList

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArrayList<java.lang.Character>> StringBuilder_CopyOnWriteArrayList
        +
        A function that converts string builders to copy on write array lists.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_CopyOnWriteArraySet

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.CopyOnWriteArraySet<java.lang.Character>> StringBuilder_CopyOnWriteArraySet
        +
        A function that converts string builders to copy on write array sets.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_LinkedBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.LinkedBlockingQueue<java.lang.Character>> StringBuilder_LinkedBlockingQueue
        +
        A function that converts string builders to linked blocking queues.
        +
        • +
      + + + +
        +
      • +

        StringBuilder_PriorityBlockingQueue

        +
        public static final F<java.lang.StringBuilder,java.util.concurrent.PriorityBlockingQueue<java.lang.Character>> StringBuilder_PriorityBlockingQueue
        +
        A function that converts string builders to priority blocking queues.
        +
        • +
      + + + +
        +
      • +

        BitSet_List

        +
        public static final F<java.util.BitSet,List<java.lang.Boolean>> BitSet_List
        +
        A function that converts bit sets to lists.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        List_ArrayList

        +
        public static <A> F<List<A>,java.util.ArrayList<A>> List_ArrayList()
        +
        A function that converts lists to array lists.
        +
        +
        Returns:
        +
        A function that converts lists to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<List<A>,java.util.EnumSet<A>> List_EnumSet()
        +
        A function that converts lists to array enum sets.
        +
        +
        Returns:
        +
        A function that converts lists to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_HashSet

        +
        public static <A> F<List<A>,java.util.HashSet<A>> List_HashSet()
        +
        A function that converts lists to hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedHashSet

        +
        public static <A> F<List<A>,java.util.LinkedHashSet<A>> List_LinkedHashSet()
        +
        A function that converts lists to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts lists to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedList

        +
        public static <A> F<List<A>,java.util.LinkedList<A>> List_LinkedList()
        +
        A function that converts lists to linked lists.
        +
        +
        Returns:
        +
        A function that converts lists to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityQueue

        +
        public static <A> F<List<A>,java.util.PriorityQueue<A>> List_PriorityQueue()
        +
        A function that converts lists to priority queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_Stack

        +
        public static <A> F<List<A>,java.util.Stack<A>> List_Stack()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_TreeSet

        +
        public static <A> F<List<A>,java.util.TreeSet<A>> List_TreeSet()
        +
        A function that converts lists to stacks.
        +
        +
        Returns:
        +
        A function that converts lists to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        List_Vector

        +
        public static <A> F<List<A>,java.util.Vector<A>> List_Vector()
        +
        A function that converts lists to vectors.
        +
        +
        Returns:
        +
        A function that converts lists to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        List_ArrayBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ArrayBlockingQueue<A>> List_ArrayBlockingQueue(boolean fair)
        +
        A function that converts lists to array blocking queue.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts lists to array blocking queue.
        +
        +
        • +
      + + + +
        +
      • +

        List_ConcurrentLinkedQueue

        +
        public static <A> F<List<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> List_ConcurrentLinkedQueue()
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts lists to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArrayList

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArrayList<A>> List_CopyOnWriteArrayList()
        +
        A function that converts lists to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        List_CopyOnWriteArraySet

        +
        public static <A> F<List<A>,java.util.concurrent.CopyOnWriteArraySet<A>> List_CopyOnWriteArraySet()
        +
        A function that converts lists to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts lists to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        List_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<List<A>,java.util.concurrent.DelayQueue<A>> List_DelayQueue()
        +
        A function that converts lists to delay queues.
        +
        +
        Returns:
        +
        A function that converts lists to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_LinkedBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.LinkedBlockingQueue<A>> List_LinkedBlockingQueue()
        +
        A function that converts lists to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_PriorityBlockingQueue

        +
        public static <A> F<List<A>,java.util.concurrent.PriorityBlockingQueue<A>> List_PriorityBlockingQueue()
        +
        A function that converts lists to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts lists to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        List_SynchronousQueue

        +
        public static <A> F<List<A>,java.util.concurrent.SynchronousQueue<A>> List_SynchronousQueue(boolean fair)
        +
        A function that converts lists to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts lists to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayList

        +
        public static <A> F<Array<A>,java.util.ArrayList<A>> Array_ArrayList()
        +
        A function that converts arrays to array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Array<A>,java.util.EnumSet<A>> Array_EnumSet()
        +
        A function that converts arrays to enum sets.
        +
        +
        Returns:
        +
        A function that converts arrays to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_HashSet

        +
        public static <A> F<Array<A>,java.util.HashSet<A>> Array_HashSet()
        +
        A function that converts arrays to hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedHashSet

        +
        public static <A> F<Array<A>,java.util.LinkedHashSet<A>> Array_LinkedHashSet()
        +
        A function that converts arrays to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts arrays to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedList

        +
        public static <A> F<Array<A>,java.util.LinkedList<A>> Array_LinkedList()
        +
        A function that converts arrays to linked lists.
        +
        +
        Returns:
        +
        A function that converts arrays to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityQueue

        +
        public static <A> F<Array<A>,java.util.PriorityQueue<A>> Array_PriorityQueue()
        +
        A function that converts arrays to priority queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Stack

        +
        public static <A> F<Array<A>,java.util.Stack<A>> Array_Stack()
        +
        A function that converts arrays to stacks.
        +
        +
        Returns:
        +
        A function that converts arrays to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Array_TreeSet

        +
        public static <A> F<Array<A>,java.util.TreeSet<A>> Array_TreeSet()
        +
        A function that converts arrays to tree sets.
        +
        +
        Returns:
        +
        A function that converts arrays to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_Vector

        +
        public static <A> F<Array<A>,java.util.Vector<A>> Array_Vector()
        +
        A function that converts arrays to vectors.
        +
        +
        Returns:
        +
        A function that converts arrays to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ArrayBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ArrayBlockingQueue<A>> Array_ArrayBlockingQueue(boolean fair)
        +
        A function that converts arrays to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts arrays to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_ConcurrentLinkedQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Array_ConcurrentLinkedQueue()
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts arrays to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArrayList

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Array_CopyOnWriteArrayList()
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Array_CopyOnWriteArraySet

        +
        public static <A> F<Array<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Array_CopyOnWriteArraySet()
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts arrays to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Array_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Array<A>,java.util.concurrent.DelayQueue<A>> Array_DelayQueue()
        +
        A function that converts arrays to delay queues.
        +
        +
        Returns:
        +
        A function that converts arrays to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_LinkedBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.LinkedBlockingQueue<A>> Array_LinkedBlockingQueue()
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_PriorityBlockingQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.PriorityBlockingQueue<A>> Array_PriorityBlockingQueue()
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts arrays to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Array_SynchronousQueue

        +
        public static <A> F<Array<A>,java.util.concurrent.SynchronousQueue<A>> Array_SynchronousQueue(boolean fair)
        +
        A function that converts arrays to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts arrays to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Iterable

        +
        public static <A> F<Stream<A>,java.lang.Iterable<A>> Stream_Iterable()
        +
        A function that converts streams to iterable.
        +
        +
        Returns:
        +
        A function that converts streams to iterable.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayList

        +
        public static <A> F<Stream<A>,java.util.ArrayList<A>> Stream_ArrayList()
        +
        A function that converts streams to array lists.
        +
        +
        Returns:
        +
        A function that converts streams to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Stream<A>,java.util.EnumSet<A>> Stream_EnumSet()
        +
        A function that converts streams to enum sets.
        +
        +
        Returns:
        +
        A function that converts streams to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_HashSet

        +
        public static <A> F<Stream<A>,java.util.HashSet<A>> Stream_HashSet()
        +
        A function that converts streams to hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedHashSet

        +
        public static <A> F<Stream<A>,java.util.LinkedHashSet<A>> Stream_LinkedHashSet()
        +
        A function that converts streams to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts streams to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedList

        +
        public static <A> F<Stream<A>,java.util.LinkedList<A>> Stream_LinkedList()
        +
        A function that converts streams to linked lists.
        +
        +
        Returns:
        +
        A function that converts streams to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityQueue

        +
        public static <A> F<Stream<A>,java.util.PriorityQueue<A>> Stream_PriorityQueue()
        +
        A function that converts streams to priority queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Stack

        +
        public static <A> F<Stream<A>,java.util.Stack<A>> Stream_Stack()
        +
        A function that converts streams to stacks.
        +
        +
        Returns:
        +
        A function that converts streams to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_TreeSet

        +
        public static <A> F<Stream<A>,java.util.TreeSet<A>> Stream_TreeSet()
        +
        A function that converts streams to tree sets.
        +
        +
        Returns:
        +
        A function that converts streams to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_Vector

        +
        public static <A> F<Stream<A>,java.util.Vector<A>> Stream_Vector()
        +
        A function that converts streams to vectors.
        +
        +
        Returns:
        +
        A function that converts streams to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ArrayBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ArrayBlockingQueue<A>> Stream_ArrayBlockingQueue(boolean fair)
        +
        A function that converts streams to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts streams to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_ConcurrentLinkedQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Stream_ConcurrentLinkedQueue()
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts streams to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArrayList

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Stream_CopyOnWriteArrayList()
        +
        A function that converts streams to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_CopyOnWriteArraySet

        +
        public static <A> F<Stream<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Stream_CopyOnWriteArraySet()
        +
        A function that converts streams to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts streams to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Stream<A>,java.util.concurrent.DelayQueue<A>> Stream_DelayQueue()
        +
        A function that converts streams to delay queues.
        +
        +
        Returns:
        +
        A function that converts streams to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_LinkedBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.LinkedBlockingQueue<A>> Stream_LinkedBlockingQueue()
        +
        A function that converts streams to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_PriorityBlockingQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.PriorityBlockingQueue<A>> Stream_PriorityBlockingQueue()
        +
        A function that converts streams to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts streams to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Stream_SynchronousQueue

        +
        public static <A> F<Stream<A>,java.util.concurrent.SynchronousQueue<A>> Stream_SynchronousQueue(boolean fair)
        +
        A function that converts streams to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts streams to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayList

        +
        public static <A> F<Option<A>,java.util.ArrayList<A>> Option_ArrayList()
        +
        A function that converts options to array lists.
        +
        +
        Returns:
        +
        A function that converts options to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_EnumSet

        +
        public static <A extends java.lang.Enum<A>> F<Option<A>,java.util.EnumSet<A>> Option_EnumSet()
        +
        A function that converts options to enum sets.
        +
        +
        Returns:
        +
        A function that converts options to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_HashSet

        +
        public static <A> F<Option<A>,java.util.HashSet<A>> Option_HashSet()
        +
        A function that converts options to hash sets.
        +
        +
        Returns:
        +
        A function that converts options to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedHashSet

        +
        public static <A> F<Option<A>,java.util.LinkedHashSet<A>> Option_LinkedHashSet()
        +
        A function that converts options to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts options to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedList

        +
        public static <A> F<Option<A>,java.util.LinkedList<A>> Option_LinkedList()
        +
        A function that converts options to linked lists.
        +
        +
        Returns:
        +
        A function that converts options to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueue

        +
        public static <A> F<Option<A>,java.util.PriorityQueue<A>> Option_PriorityQueue()
        +
        A function that converts options to priority queues.
        +
        +
        Returns:
        +
        A function that converts options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Stack

        +
        public static <A> F<Option<A>,java.util.Stack<A>> Option_Stack()
        +
        A function that converts options to stacks.
        +
        +
        Returns:
        +
        A function that converts options to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Option_TreeSet

        +
        public static <A> F<Option<A>,java.util.TreeSet<A>> Option_TreeSet()
        +
        A function that converts options to tree sets.
        +
        +
        Returns:
        +
        A function that converts options to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_Vector

        +
        public static <A> F<Option<A>,java.util.Vector<A>> Option_Vector()
        +
        A function that converts options to vectors.
        +
        +
        Returns:
        +
        A function that converts options to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ArrayBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ArrayBlockingQueue<A>> Option_ArrayBlockingQueue(boolean fair)
        +
        A function that converts options to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts options to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_ConcurrentLinkedQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.ConcurrentLinkedQueue<A>> Option_ConcurrentLinkedQueue()
        +
        A function that converts options to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts options to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArrayList

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArrayList<A>> Option_CopyOnWriteArrayList()
        +
        A function that converts options to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_CopyOnWriteArraySet

        +
        public static <A> F<Option<A>,java.util.concurrent.CopyOnWriteArraySet<A>> Option_CopyOnWriteArraySet()
        +
        A function that converts options to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts options to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Option_DelayQueue

        +
        public static <A extends java.util.concurrent.Delayed> F<Option<A>,java.util.concurrent.DelayQueue<A>> Option_DelayQueue()
        +
        A function that converts options to delay queues.
        +
        +
        Returns:
        +
        A function that converts options to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_LinkedBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.LinkedBlockingQueue<A>> Option_LinkedBlockingQueue()
        +
        A function that converts options to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityBlockingQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.PriorityBlockingQueue<A>> Option_PriorityBlockingQueue()
        +
        A function that converts options to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts options to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_SynchronousQueue

        +
        public static <A> F<Option<A>,java.util.concurrent.SynchronousQueue<A>> Option_SynchronousQueue(boolean fair)
        +
        A function that converts options to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts options to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<A>> Either_ArrayListA()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.ArrayList<B>> Either_ArrayListB()
        +
        A function that converts eithers to array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetA

        +
        public static <B> F<Either<java.lang.Boolean,B>,java.util.BitSet> Either_BitSetA()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_BitSetB

        +
        public static <A> F<Either<A,java.lang.Boolean>,java.util.BitSet> Either_BitSetB()
        +
        A function that converts eithers to bit sets.
        +
        +
        Returns:
        +
        A function that converts eithers to bit sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetA

        +
        public static <A extends java.lang.Enum<A>,B> F<Either<A,B>,java.util.EnumSet<A>> Either_EnumSetA()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_EnumSetB

        +
        public static <A,B extends java.lang.Enum<B>> F<Either<A,B>,java.util.EnumSet<B>> Either_EnumSetB()
        +
        A function that converts eithers to enum sets.
        +
        +
        Returns:
        +
        A function that converts eithers to enum sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<A>> Either_HashSetA()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_HashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.HashSet<B>> Either_HashSetB()
        +
        A function that converts eithers to hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<A>> Either_LinkedHashSetA()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedHashSetB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedHashSet<B>> Either_LinkedHashSetB()
        +
        A function that converts eithers to linked hash sets.
        +
        +
        Returns:
        +
        A function that converts eithers to linked hash sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListA

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<A>> Either_LinkedListA()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<A>> Option_PriorityQueueA()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Option_PriorityQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.PriorityQueue<B>> Option_PriorityQueueB()
        +
        A function that converts eithers to priority queues.
        +
        +
        Returns:
        +
        A function that eithers options to priority queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedListB

        +
        public static <A,B> F<Either<A,B>,java.util.LinkedList<B>> Either_LinkedListB()
        +
        A function that converts eithers to linked lists.
        +
        +
        Returns:
        +
        A function that converts eithers to linked lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackA

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<A>> Either_StackA()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_StackB

        +
        public static <A,B> F<Either<A,B>,java.util.Stack<B>> Either_StackB()
        +
        A function that converts eithers to stacks.
        +
        +
        Returns:
        +
        A function that converts eithers to stacks.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetA

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<A>> Either_TreeSetA()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_TreeSetB

        +
        public static <A,B> F<Either<A,B>,java.util.TreeSet<B>> Either_TreeSetB()
        +
        A function that converts eithers to tree sets.
        +
        +
        Returns:
        +
        A function that converts eithers to tree sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorA

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<A>> Either_VectorA()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_VectorB

        +
        public static <A,B> F<Either<A,B>,java.util.Vector<B>> Either_VectorB()
        +
        A function that converts eithers to vectors.
        +
        +
        Returns:
        +
        A function that converts eithers to vectors.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<A>> Either_ArrayBlockingQueueA(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ArrayBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ArrayBlockingQueue<B>> Either_ArrayBlockingQueueB(boolean fair)
        +
        A function that converts eithers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts eithers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<A>> Either_ConcurrentLinkedQueueA()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_ConcurrentLinkedQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.ConcurrentLinkedQueue<B>> Either_ConcurrentLinkedQueueB()
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        Returns:
        +
        A function that converts eithers to concurrent linked queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<A>> Either_CopyOnWriteArrayListA()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArrayListB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArrayList<B>> Either_CopyOnWriteArrayListB()
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array lists.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<A>> Either_CopyOnWriteArraySetA()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_CopyOnWriteArraySetB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.CopyOnWriteArraySet<B>> Either_CopyOnWriteArraySetB()
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        Returns:
        +
        A function that converts eithers to copy on write array sets.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueA

        +
        public static <A extends java.util.concurrent.Delayed,B> F<Either<A,B>,java.util.concurrent.DelayQueue<A>> Either_DelayQueueA()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_DelayQueueB

        +
        public static <A,B extends java.util.concurrent.Delayed> F<Either<A,B>,java.util.concurrent.DelayQueue<B>> Either_DelayQueueB()
        +
        A function that converts eithers to delay queues.
        +
        +
        Returns:
        +
        A function that converts eithers to delay queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<A>> Either_LinkedBlockingQueueA()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_LinkedBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.LinkedBlockingQueue<B>> Either_LinkedBlockingQueueB()
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to linked blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<A>> Either_PriorityBlockingQueueA()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_PriorityBlockingQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.PriorityBlockingQueue<B>> Either_PriorityBlockingQueueB()
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        Returns:
        +
        A function that converts eithers to priority blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueA

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<A>> Either_SynchronousQueueA(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        Either_SynchronousQueueB

        +
        public static <A,B> F<Either<A,B>,java.util.concurrent.SynchronousQueue<B>> Either_SynchronousQueueB(boolean fair)
        +
        A function that converts eithers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts eithers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_ArrayBlockingQueue

        +
        public static F<java.lang.String,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> String_ArrayBlockingQueue(boolean fair)
        +
        A function that converts strings to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts strings to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        String_SynchronousQueue

        +
        public static F<java.lang.String,java.util.concurrent.SynchronousQueue<java.lang.Character>> String_SynchronousQueue(boolean fair)
        +
        A function that converts strings to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts strings to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuffer_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string buffers to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuffer_SynchronousQueue

        +
        public static F<java.lang.StringBuffer,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuffer_SynchronousQueue(boolean fair)
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string buffers to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_ArrayBlockingQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.ArrayBlockingQueue<java.lang.Character>> StringBuilder_ArrayBlockingQueue(boolean fair)
        +
        A function that converts string builders to array blocking queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the array blocking queue.
        +
        Returns:
        +
        A function that converts string builders to array blocking queues.
        +
        +
        • +
      + + + +
        +
      • +

        StringBuilder_SynchronousQueue

        +
        public static F<java.lang.StringBuilder,java.util.concurrent.SynchronousQueue<java.lang.Character>> StringBuilder_SynchronousQueue(boolean fair)
        +
        A function that converts string builders to synchronous queues.
        +
        +
        Parameters:
        +
        fair - The argument to pass to the constructor of the synchronous queue.
        +
        Returns:
        +
        A function that converts string builders to synchronous queues.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayList_List

        +
        public static <A> F<java.util.ArrayList<A>,List<A>> ArrayList_List()
        +
        A function that converts array lists to lists.
        +
        +
        Returns:
        +
        A function that converts array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> F<java.util.List<A>,List<A>> JavaList_List()
        +
        • +
      + + + +
        +
      • +

        JavaList_List

        +
        public static <A> List<A> JavaList_List(java.util.List<A> list)
        +
        • +
      + + + +
        +
      • +

        EnumSet_List

        +
        public static <A extends java.lang.Enum<A>> F<java.util.EnumSet<A>,List<A>> EnumSet_List()
        +
        A function that converts enum sets to lists.
        +
        +
        Returns:
        +
        A function that converts enum sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> List<A> Collection_List(java.util.Collection<A> c)
        +
        • +
      + + + +
        +
      • +

        Collection_List

        +
        public static <A> F<java.util.Collection<A>,List<A>> Collection_List()
        +
        • +
      + + + +
        +
      • +

        HashSet_List

        +
        public static <A> F<java.util.HashSet<A>,List<A>> HashSet_List()
        +
        A function that converts hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedHashSet_List

        +
        public static <A> F<java.util.LinkedHashSet<A>,List<A>> LinkedHashSet_List()
        +
        A function that converts linked hash sets to lists.
        +
        +
        Returns:
        +
        A function that converts linked hash sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedList_List

        +
        public static <A> F<java.util.LinkedList<A>,List<A>> LinkedList_List()
        +
        A function that converts linked lists to lists.
        +
        +
        Returns:
        +
        A function that converts linked lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityQueue_List

        +
        public static <A> F<java.util.PriorityQueue<A>,List<A>> PriorityQueue_List()
        +
        A function that converts priority queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Stack_List

        +
        public static <A> F<java.util.Stack<A>,List<A>> Stack_List()
        +
        A function that converts stacks to lists.
        +
        +
        Returns:
        +
        A function that converts stacks to lists.
        +
        +
        • +
      + + + +
        +
      • +

        TreeSet_List

        +
        public static <A> F<java.util.TreeSet<A>,List<A>> TreeSet_List()
        +
        A function that converts tree sets to lists.
        +
        +
        Returns:
        +
        A function that converts tree sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        Vector_List

        +
        public static <A> F<java.util.Vector<A>,List<A>> Vector_List()
        +
        A function that converts vectors to lists.
        +
        +
        Returns:
        +
        A function that converts vectors to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ArrayBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.ArrayBlockingQueue<A>,List<A>> ArrayBlockingQueue_List()
        +
        A function that converts array blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts array blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        ConcurrentLinkedQueue_List

        +
        public static <A> F<java.util.concurrent.ConcurrentLinkedQueue<A>,List<A>> ConcurrentLinkedQueue_List()
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        Returns:
        +
        A function that converts concurrent linked queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArrayList_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArrayList<A>,List<A>> CopyOnWriteArrayList_List()
        +
        A function that converts copy on write array lists to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array lists to lists.
        +
        +
        • +
      + + + +
        +
      • +

        CopyOnWriteArraySet_List

        +
        public static <A> F<java.util.concurrent.CopyOnWriteArraySet<A>,List<A>> CopyOnWriteArraySet_List()
        +
        A function that converts copy on write array sets to lists.
        +
        +
        Returns:
        +
        A function that converts copy on write array sets to lists.
        +
        +
        • +
      + + + +
        +
      • +

        DelayQueue_List

        +
        public static <A extends java.util.concurrent.Delayed> F<java.util.concurrent.DelayQueue<A>,List<A>> DelayQueue_List()
        +
        A function that converts delay queues to lists.
        +
        +
        Returns:
        +
        A function that converts delay queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        LinkedBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.LinkedBlockingQueue<A>,List<A>> LinkedBlockingQueue_List()
        +
        A function that converts linked blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts linked blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        PriorityBlockingQueue_List

        +
        public static <A> F<java.util.concurrent.PriorityBlockingQueue<A>,List<A>> PriorityBlockingQueue_List()
        +
        A function that converts priority blocking queues to lists.
        +
        +
        Returns:
        +
        A function that converts priority blocking queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        SynchronousQueue_List

        +
        public static <A> F<java.util.concurrent.SynchronousQueue<A>,List<A>> SynchronousQueue_List()
        +
        A function that converts synchronous queues to lists.
        +
        +
        Returns:
        +
        A function that converts synchronous queues to lists.
        +
        +
        • +
      + + + +
        +
      • +

        P1_Callable

        +
        public static <A> F<P1<A>,java.util.concurrent.Callable<A>> P1_Callable()
        +
        • +
      + + + +
        +
      • +

        Future_P1

        +
        public static <A> F<java.util.concurrent.Future<A>,P1<Either<java.lang.Exception,A>>> Future_P1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Java8.html b/javadoc/5.0/functionaljava/fj/data/Java8.html new file mode 100644 index 0000000..e445a2f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Java8.html @@ -0,0 +1,640 @@ + + + + + +Java8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Java8

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Java8
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Java8
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> P1<A> Supplier_P1(java.util.function.Supplier<A> s)
        +
        • +
      + + + +
        +
      • +

        Supplier_P1

        +
        public static <A> F<java.util.function.Supplier<A>,P1<A>> Supplier_P1()
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> java.util.function.Supplier<A> P1_Supplier(P1<A> p)
        +
        • +
      + + + +
        +
      • +

        P1_Supplier

        +
        public static <A> F<P1<A>,java.util.function.Supplier<A>> P1_Supplier()
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> F<A,B> Function_F(java.util.function.Function<A,B> f)
        +
        • +
      + + + +
        +
      • +

        Function_F

        +
        public static <A,B> F<java.util.function.Function<A,B>,F<A,B>> Function_F()
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> java.util.function.Function<A,B> F_Function(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        F_Function

        +
        public static <A,B> F<F<A,B>,java.util.function.Function<A,B>> F_Function()
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> F2<A,B,C> BiFunction_F2(java.util.function.BiFunction<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        BiFunction_F2

        +
        public static <A,B,C> F<java.util.function.BiFunction<A,B,C>,F2<A,B,C>> BiFunction_F2()
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> java.util.function.BiFunction<A,B,C> F2_BiFunction(F2<A,B,C> f)
        +
        • +
      + + + +
        +
      • +

        F2_BiFunction

        +
        public static <A,B,C> F<F2<A,B,C>,java.util.function.BiFunction<A,B,C>> F2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> java.util.function.Supplier<Validation<E,A>> TryCatch0_Supplier(Try0<A,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch0_Supplier

        +
        public static <A,E extends java.lang.Exception> F<Try0<A,E>,java.util.function.Supplier<Validation<E,A>>> TryCatch0_Supplier()
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> java.util.function.Function<A,Validation<E,B>> TryCatch1_Function(Try1<A,B,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch1_Function

        +
        public static <A,B,E extends java.lang.Exception> F<Try1<A,B,E>,java.util.function.Function<A,Validation<E,B>>> TryCatch1_Function()
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> java.util.function.BiFunction<A,B,Validation<E,C>> TryCatch2_BiFunction(Try2<A,B,C,E> t)
        +
        • +
      + + + +
        +
      • +

        TryCatch2_BiFunction

        +
        public static <A,B,C,E extends java.lang.Exception> F<Try2<A,B,C,E>,java.util.function.BiFunction<A,B,Validation<E,C>>> TryCatch2_BiFunction()
        +
        • +
      + + + +
        +
      • +

        List_JavaStream

        +
        public static <A> java.util.stream.Stream<A> List_JavaStream(List<A> list)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> Option<A> Optional_Option(java.util.Optional<A> o)
        +
        • +
      + + + +
        +
      • +

        Optional_Option

        +
        public static <A> F<java.util.Optional<A>,Option<A>> Optional_Option()
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> java.util.Optional<A> Option_Optional(Option<A> o)
        +
        Convert an Option to Optional. Will throw a NullPointerException if the Option is some(null).
        +
        • +
      + + + +
        +
      • +

        Option_Optional

        +
        public static <A> F<Option<A>,java.util.Optional<A>> Option_Optional()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> F<java.util.function.Consumer<A>,F<A,Unit>> Consumer_F()
        +
        • +
      + + + +
        +
      • +

        Consumer_F

        +
        public static <A> F<A,Unit> Consumer_F(java.util.function.Consumer<A> c)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Stream_JavaStream(Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        Iterable_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterable_JavaStream(java.lang.Iterable<A> it)
        +
        • +
      + + + +
        +
      • +

        Iterator_JavaStream

        +
        public static <A> java.util.stream.Stream<A> Iterator_JavaStream(java.util.Iterator<A> it)
        +
        • +
      + + + +
        +
      • +

        Stream_JavaStream

        +
        public static <A> F<Stream<A>,java.util.stream.Stream<A>> Stream_JavaStream()
        +
        • +
      + + + +
        +
      • +

        JavaStream_Stream

        +
        public static <A> Stream<A> JavaStream_Stream(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_List

        +
        public static <A> List<A> JavaStream_List(java.util.stream.Stream<A> s)
        +
        • +
      + + + +
        +
      • +

        JavaStream_Array

        +
        public static <A> Array<A> JavaStream_Array(java.util.stream.Stream<A> s)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/LazyString.html b/javadoc/5.0/functionaljava/fj/data/LazyString.html new file mode 100644 index 0000000..bfa7c01 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/LazyString.html @@ -0,0 +1,982 @@ + + + + + +LazyString (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class LazyString

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.LazyString
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.CharSequence
    +
    +
    +
    +
    public final class LazyString
+extends java.lang.Object
+implements java.lang.CharSequence
    +
    A lazy (non-evaluated) immutable character string.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static LazyStringempty +
      The empty string.
      +
      static F<Stream<java.lang.Character>,LazyString>fromStream +
      First-class conversion from character streams to lazy strings.
      +
      static F<LazyString,Stream<java.lang.Character>>toStream +
      First-class conversion from lazy strings to streams.
      +
      static F<LazyString,java.lang.String>toString +
      First-class conversion from lazy strings to String.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      LazyStringappend(LazyString cs) +
      Appends the given lazy string to the end of this lazy string.
      +
      LazyStringappend(java.lang.String s) +
      Appends the given String to the end of this lazy string.
      +
      LazyStringbind(F<java.lang.Character,LazyString> f) 
      charcharAt(int index) +
      Returns the caracter at the specified index.
      +
      booleancontains(LazyString cs) +
      Returns true if the given lazy string is a substring of this lazy string.
      +
      booleanendsWith(LazyString cs) +
      Returns true if the given lazy string is a suffix of this lazy string.
      +
      java.lang.Stringeval() 
      static LazyStringfromStream(Stream<java.lang.Character> s) +
      Constructs a lazy string from a stream of characters.
      +
      charhead() +
      Returns the first character of this string.
      +
      Option<java.lang.Integer>indexOf(char c) +
      Returns the first index of the given character in this lazy string, if present.
      +
      Option<java.lang.Integer>indexOf(LazyString cs) +
      Returns the first index of the given substring in this lazy string, if present.
      +
      booleanisEmpty() +
      Checks if this string is empty.
      +
      intlength() +
      The length of the lazy string.
      +
      static F<LazyString,Stream<LazyString>>lines_() 
      Stream<LazyString>lines() +
      Splits this lazy string into lines.
      +
      LazyStringmap(F<java.lang.Character,java.lang.Character> f) 
      booleanmatches(java.lang.String regex) +
      Regular expression pattern matching.
      +
      LazyStringreverse() +
      Returns the reverse of this string.
      +
      Stream<LazyString>split(char c) +
      Splits this lazy string by the given delimiter character.
      +
      Stream<LazyString>split(F<java.lang.Character,java.lang.Boolean> p) +
      Splits this lazy string by characters matching the given predicate.
      +
      static F<LazyString,F<LazyString,java.lang.Boolean>>startsWith() +
      First-class prefix check.
      +
      booleanstartsWith(LazyString cs) +
      Returns true if the given lazy string is a prefix of this lazy string.
      +
      static LazyStringstr(java.lang.String s) +
      Constructs a lazy string from a String.
      +
      java.lang.CharSequencesubSequence(int start, + int end) +
      Gets the specified subsequence of this lazy string.
      +
      LazyStringtail() +
      Returns all but the first character of this string.
      +
      Stream<java.lang.Character>toStream() +
      Gives a stream representation of this lazy string.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() +
      Returns the String representation of this lazy string.
      +
      java.lang.StringtoStringLazy() 
      static F<Stream<LazyString>,LazyString>unlines_() 
      static LazyStringunlines(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by newlines.
      +
      static LazyStringunwords(Stream<LazyString> str) +
      Joins the given stream of lazy strings into one, separated by spaces.
      +
      Stream<LazyString>words() +
      Splits this lazy string into words by spaces.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.CharSequence

        +chars, codePoints
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        empty

        +
        public static final LazyString empty
        +
        The empty string.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public static final F<LazyString,Stream<java.lang.Character>> toStream
        +
        First-class conversion from lazy strings to streams.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public static final F<LazyString,java.lang.String> toString
        +
        First-class conversion from lazy strings to String.
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static final F<Stream<java.lang.Character>,LazyString> fromStream
        +
        First-class conversion from character streams to lazy strings.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        str

        +
        public static LazyString str(java.lang.String s)
        +
        Constructs a lazy string from a String.
        +
        +
        Parameters:
        +
        s - A string from which to construct a lazy string.
        +
        Returns:
        +
        A lazy string with the characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static LazyString fromStream(Stream<java.lang.Character> s)
        +
        Constructs a lazy string from a stream of characters.
        +
        +
        Parameters:
        +
        s - A stream of characters.
        +
        Returns:
        +
        A lazy string with the characters from the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Character> toStream()
        +
        Gives a stream representation of this lazy string.
        +
        +
        Returns:
        +
        A stream representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of the lazy string. Note that this operation is O(n).
        +
        +
        Specified by:
        +
        length in interface java.lang.CharSequence
        +
        Returns:
        +
        The length of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        charAt

        +
        public char charAt(int index)
        +
        Returns the caracter at the specified index.
        +
        +
        Specified by:
        +
        charAt in interface java.lang.CharSequence
        +
        Parameters:
        +
        index - The index for the character to be returned.
        +
        Returns:
        +
        The character at the specified index.
        +
        +
        • +
      + + + +
        +
      • +

        subSequence

        +
        public java.lang.CharSequence subSequence(int start,
+                                          int end)
        +
        Gets the specified subsequence of this lazy string. + This operation does not fail for indexes that are out of bounds. If the start index is past the end + of this lazy string, then the resulting character sequence will be empty. If the end index is past the + end of this lazy string, then the resulting character sequence will be truncated.
        +
        +
        Specified by:
        +
        subSequence in interface java.lang.CharSequence
        +
        Parameters:
        +
        start - The character index of this lazy string at which to start the subsequence.
        +
        end - The character index of this lazy string at which to end the subsequence.
        +
        Returns:
        +
        A character sequence containing the specified character subsequence.
        +
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public java.lang.String toStringEager()
        +
        Returns the String representation of this lazy string.
        +
        +
        Returns:
        +
        The String representation of this lazy string.
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Specified by:
        +
        toString in interface java.lang.CharSequence
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eval

        +
        public java.lang.String eval()
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(LazyString cs)
        +
        Appends the given lazy string to the end of this lazy string.
        +
        +
        Parameters:
        +
        cs - A lazy string to append to this one.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public LazyString append(java.lang.String s)
        +
        Appends the given String to the end of this lazy string.
        +
        +
        Parameters:
        +
        s - A String to append to this lazy string.
        +
        Returns:
        +
        A new lazy string that is the concatenation of this lazy string and the given string.
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(LazyString cs)
        +
        Returns true if the given lazy string is a substring of this lazy string.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        True if the given string is a substring of this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        endsWith

        +
        public boolean endsWith(LazyString cs)
        +
        Returns true if the given lazy string is a suffix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the end of this lazy string.
        +
        Returns:
        +
        True if the given string is a suffix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public boolean startsWith(LazyString cs)
        +
        Returns true if the given lazy string is a prefix of this lazy string.
        +
        +
        Parameters:
        +
        cs - A string to find at the start of this lazy string.
        +
        Returns:
        +
        True if the given string is a prefix of this lazy string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public static F<LazyString,F<LazyString,java.lang.Boolean>> startsWith()
        +
        First-class prefix check.
        +
        +
        Returns:
        +
        A function that yields true if the first argument is a prefix of the second.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public char head()
        +
        Returns the first character of this string.
        +
        +
        Returns:
        +
        The first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public LazyString tail()
        +
        Returns all but the first character of this string.
        +
        +
        Returns:
        +
        All but the first character of this string, or error if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this string is empty.
        +
        +
        Returns:
        +
        True if there are no characters in this string, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public LazyString reverse()
        +
        Returns the reverse of this string.
        +
        +
        Returns:
        +
        the reverse of this string.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(char c)
        +
        Returns the first index of the given character in this lazy string, if present.
        +
        +
        Parameters:
        +
        c - A character to find in this lazy string.
        +
        Returns:
        +
        The first index of the given character in this lazy string, or None if the character is not present.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public Option<java.lang.Integer> indexOf(LazyString cs)
        +
        Returns the first index of the given substring in this lazy string, if present.
        +
        +
        Parameters:
        +
        cs - A substring to find in this lazy string.
        +
        Returns:
        +
        The first index of the given substring in this lazy string, or None if there is no such substring.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.lang.String regex)
        +
        Regular expression pattern matching.
        +
        +
        Parameters:
        +
        regex - A regular expression to match this lazy string.
        +
        Returns:
        +
        True if this string mathches the given regular expression, otherwise False.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(F<java.lang.Character,java.lang.Boolean> p)
        +
        Splits this lazy string by characters matching the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate that matches characters to be considered delimiters.
        +
        Returns:
        +
        A stream of the substrings in this lazy string, when separated by the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public LazyString map(F<java.lang.Character,java.lang.Character> f)
        +
        • +
      + + + + + + + +
        +
      • +

        split

        +
        public Stream<LazyString> split(char c)
        +
        Splits this lazy string by the given delimiter character.
        +
        +
        Parameters:
        +
        c - A delimiter character at which to split.
        +
        Returns:
        +
        A stream of substrings of this lazy string, when separated by the given delimiter.
        +
        +
        • +
      + + + +
        +
      • +

        words

        +
        public Stream<LazyString> words()
        +
        Splits this lazy string into words by spaces.
        +
        +
        Returns:
        +
        A stream of the words in this lazy string, when split by spaces.
        +
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public Stream<LazyString> lines()
        +
        Splits this lazy string into lines.
        +
        +
        Returns:
        +
        A stream of the lines in this lazy string, when split by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unlines

        +
        public static LazyString unlines(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by newlines.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by newlines.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings separated by newlines.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        unwords

        +
        public static LazyString unwords(Stream<LazyString> str)
        +
        Joins the given stream of lazy strings into one, separated by spaces.
        +
        +
        Parameters:
        +
        str - A stream of lazy strings to join by spaces.
        +
        Returns:
        +
        A new lazy string, consisting of the given strings with spaces in between.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/List.Buffer.html b/javadoc/5.0/functionaljava/fj/data/List.Buffer.html new file mode 100644 index 0000000..c8a464d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/List.Buffer.html @@ -0,0 +1,482 @@ + + + + + +List.Buffer (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class List.Buffer<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Buffer<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Buffer<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A mutable, singly linked list. This structure should be used very sparingly, in favour + of the immutable singly linked list structure.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Buffer() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      List.Buffer<A>append(List<A> as) +
      Appends the given list to this buffer.
      +
      static <A> List.Buffer<A>empty() +
      An empty buffer.
      +
      static <A> List.Buffer<A>fromList(List<A> as) +
      Constructs a buffer from the given list.
      +
      booleanisEmpty() +
      Returns true if this buffer is empty, false otherwise.
      +
      static <A> List.Buffer<A>iterableBuffer(java.lang.Iterable<A> i) +
      Takes the given iterable to a buffer.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this buffer.
      +
      List<A>prependToList(List<A> as) +
      Prepends the elements of this buffer to the given list.
      +
      List.Buffer<A>snoc(A a) +
      Appends (snoc) the given element to this buffer to produce a new buffer.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this buffer.
      +
      List<A>toList() +
      Returns an immutable list projection of this buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Buffer

        +
        public Buffer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this buffer. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this buffer.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public List.Buffer<A> snoc(A a)
        +
        Appends (snoc) the given element to this buffer to produce a new buffer.
        +
        +
        Parameters:
        +
        a - The element to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public List.Buffer<A> append(List<A> as)
        +
        Appends the given list to this buffer.
        +
        +
        Parameters:
        +
        as - The list to append to this buffer.
        +
        Returns:
        +
        This buffer.
        +
        +
        • +
      + + + +
        +
      • +

        prependToList

        +
        public List<A> prependToList(List<A> as)
        +
        Prepends the elements of this buffer to the given list.
        +
        +
        Parameters:
        +
        as - the list to which elements are prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true if this buffer is empty, false otherwise.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns an immutable list projection of this buffer. Modifications to the underlying buffer + will not be reflected in returned lists.
        +
        +
        Returns:
        +
        An immutable list projection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this buffer.
        +
        +
        Returns:
        +
        An immutable collection of this buffer.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> List.Buffer<A> empty()
        +
        An empty buffer.
        +
        +
        Returns:
        +
        An empty buffer.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> List.Buffer<A> fromList(List<A> as)
        +
        Constructs a buffer from the given list.
        +
        +
        Parameters:
        +
        as - The list to construct a buffer with.
        +
        Returns:
        +
        A buffer from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableBuffer

        +
        public static <A> List.Buffer<A> iterableBuffer(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a buffer.
        +
        +
        Parameters:
        +
        i - The iterable to take to a buffer.
        +
        Returns:
        +
        A buffer from the given iterable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/List.Optic.html b/javadoc/5.0/functionaljava/fj/data/List.Optic.html new file mode 100644 index 0000000..f554836 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/List.Optic.html @@ -0,0 +1,322 @@ + + + + + +List.Optic (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Optic
+extends java.lang.Object
    +
    Optic factory methods for a List
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        pTraversal

        +
        public static <A,B> PTraversal<List<A>,List<B>,A,B> pTraversal()
        +
        Polymorphic traversal
        +
        • +
      + + + +
        +
      • +

        traversal

        +
        public static <A> Traversal<List<A>,A> traversal()
        +
        Monomorphic traversal
        +
        • +
      + + + +
        +
      • +

        head

        +
        public static <A> Optional<List<A>,A> head()
        +
        Optional targeted on Cons head.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public static <A> Optional<List<A>,List<A>> tail()
        +
        Optional targeted on Cons tail.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Prism<List<A>,Unit> nil()
        +
        Nil prism
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> Prism<List<A>,P2<A,List<A>>> cons()
        +
        Cons prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/List.Unsafe.html b/javadoc/5.0/functionaljava/fj/data/List.Unsafe.html new file mode 100644 index 0000000..7e556f9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/List.Unsafe.html @@ -0,0 +1,238 @@ + + + + + +List.Unsafe (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List.Unsafe

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List.Unsafe
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    List<A>
    +
    +
    +
    +
    public static final class List.Unsafe
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Unsafe() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Unsafe

        +
        public Unsafe()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/List.html b/javadoc/5.0/functionaljava/fj/data/List.html new file mode 100644 index 0000000..215a97b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/List.html @@ -0,0 +1,4096 @@ + + + + + +List (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class List<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.List<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class List<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class List.Buffer<A> +
      A mutable, singly linked list.
      +
      static class List.Optic +
      Optic factory methods for a List
      +
      static class List.Unsafe 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanallEqual(Equal<A> eq) +
      Returns whether or not all elements in the list are equal according to the given equality test.
      +
      List<A>append(List<A> as) +
      Appends the given list to this list.
      +
      <B> List<B>apply(List<F<A,B>> lf) +
      Performs function application within a list (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this list.
      +
      static <A> List<A>arrayList(A... as) +
      Constructs a list from the given elements.
      +
      static F<List<java.lang.Character>,java.lang.String>asString() +
      A first-class asString.
      +
      static java.lang.StringasString(List<java.lang.Character> cs) +
      Returns a string from the given list of characters.
      +
      static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>>bind_() +
      Provides a first-class version of bind()
      +
      <B> List<B>bind(F<A,List<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      <B,C> List<C>bind(List<B> lb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C> List<C>bind(List<B> lb, + F2<A,B,C> f) +
      Binds the given function across each element of this list and the given list with a final + join.
      +
      <B,C,D> List<D>bind(List<B> lb, + List<C> lc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E> List<E>bind(List<B> lb, + List<C> lc, + List<D> ld, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$>
      List<F$>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G>
      List<G>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H>
      List<H>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      List<I>      		bind(List<B> lb, + List<C> lc, + List<D> ld, + List<E> le, + List<F$> lf, + List<G> lg, + List<H> lh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this list and the given lists with a final + join.
      +
      P2<List<A>,List<A>>breakk(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
      +
      static <A> F2<A,List<A>,List<A>>cons_() 
      static <A> F<List<A>,List<A>>cons_(A a) +
      Returns a function that prepends the given value to a list.
      +
      static <A> F<A,F<List<A>,List<A>>>cons() +
      Returns a function that prepends (cons) an element to a list to produce a new list.
      +
      List<A>cons(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      static <A> List<A>cons(A head, + List<A> tail) +
      Prepends the given head element to the given tail element to produce a new list.
      +
      static <A> F<A,List<A>>cons(List<A> tail) +
      Returns a function that prepends a value to the given list.
      +
      List<A>conss(A a) +
      Prepends (cons) the given element to this list to product a new list.
      +
      List<A>delete(A a, + Equal<A> e) +
      Removes the first element that equals the given object.
      +
      List<A>drop(int i) +
      Drops the given number of elements from the head of this list if they are available.
      +
      List<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
      +
      Option<java.lang.Integer>elementIndex(Equal<A> e, + A a) +
      Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
      +
      List<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>>foldLeft() +
      Provides a first-class version of foldLeft.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> BfoldRight(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list.
      +
      <B> Trampoline<B>foldRightC(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this list in O(1) stack space.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this list.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this list.
      +
      static <A> List<A>fromIterator(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static F<java.lang.String,List<java.lang.Character>>fromString() +
      A first-class fromString.
      +
      static List<java.lang.Character>fromString(java.lang.String s) +
      Returns a list of characters from the given string.
      +
      List<List<A>>group(Equal<A> e) +
      Groups elements according to the given equality implementation by longest + sequence of equal elements.
      +
      <B,C,D> TreeMap<B,D>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + D groupingIdentity, + F2<C,D,D> groupingAcc, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
      +
      <B,C> TreeMap<B,C>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Monoid<C> monoid, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B,C> TreeMap<B,List<C>>groupBy(F<A,B> keyFunction, + F<A,C> valueFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
      +
      <B> TreeMap<B,List<A>>groupBy(F<A,B> keyFunction, + Ord<B> keyOrd) +
      Groups the elements of this list by a given keyFunction into a TreeMap.
      +
      inthashCode() +
      Compute the hash code from this list as a function of the hash codes of its members.
      +
      static <A> F<List<A>,A>head_() +
      First-class head function.
      +
      abstract Ahead() +
      The first element of the linked list or fails for the empty list.
      +
      Option<A>headOption() +
      Returns the head of the list, if any.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      List<A>init() +
      Returns all but the last element of this list.
      +
      List<List<A>>inits() +
      Returns the list of initial segments of this list, shortest first.
      +
      List<A>insertBy(F<A,F<A,Ordering>> f, + A x) +
      Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
      +
      List<A>intercalate(List<List<A>> as) +
      Intersperses this list through the given list then joins the results.
      +
      List<A>intersperse(A a) +
      Intersperses the given argument between each element of this list.
      +
      static <A> F<List<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given list is empty.
      +
      booleanisEmpty() +
      Returns true if this list is empty, false otherwise.
      +
      static <A> F<List<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given list is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this list is empty, true otherwise.
      +
      booleanisPrefixOf(Equal<A> eq, + List<A> xs) 
      booleanisSingle() +
      True if and only if the list has one element.
      +
      booleanisSuffixOf(Equal<A> eq, + List<A> xs) 
      static <A> List<A>iterableList(java.lang.Iterable<A> i) +
      Takes the given iterable to a list.
      +
      static <A> List<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this list.
      +
      static <A> List<A>iteratorList(java.util.Iterator<A> it) +
      Constructs a list from the given Iterator.
      +
      static <A> F<List<List<A>>,List<A>>join() +
      A first-class version of join
      +
      static <A> List<A>join(List<List<A>> o) +
      Joins the given list of lists using a bind operation.
      +
      Alast() +
      Returns the last element of this list.
      +
      static <A> F<List<A>,java.lang.Integer>length_() +
      First-class length.
      +
      intlength() +
      The length of this list.
      +
      static <A,B,C> F<List<A>,F<List<B>,List<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes the given function of arity-2 to a function on lists.
      +
      static <A> List<A>list(A... as) +
      Constructs a list from the given elements.
      +
      static <A,B> F2<List<P2<A,B>>,A,Option<B>>lookup(Equal<A> e) +
      Returns a partially applied version of lookup(Equal, List, Object).
      +
      static <A,B> Option<B>lookup(Equal<A> e, + List<P2<A,B>> x, + A a) +
      Returns an associated value with the given key in the list of pairs.
      +
      static <A,B> F<F<A,B>,F<List<A>,List<B>>>map_() +
      Provides a first-class version of map()
      +
      <B> List<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B,C> F<B,List<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
      +
      <B> Option<List<B>>mapMOption(F<A,Option<B>> f) +
      Maps the given function across this list by binding through the Option monad.
      +
      <B> Trampoline<List<B>>mapMTrampoline(F<A,Trampoline<B>> f) +
      Maps the given function across this list by binding through the Trampoline monad.
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Option<A>maximumOption(Ord<A> o) +
      Returns the maximum element in this list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      Option<A>minimumOption(Ord<A> o) +
      Returns the minimum element in this list according to the given ordering.
      +
      List<A>minus(Equal<A> eq, + List<A> xs) +
      Returns a new list of all the items in this list that do not appear in the given list.
      +
      Amode(Ord<A> o) +
      Returns the most common element in this list.
      +
      static <A> List<A>nil() +
      Returns an empty list.
      +
      List<A>nub() +
      Removes duplicates according to object equality.
      +
      List<A>nub(Equal<A> eq) +
      Removes duplicates according to the given equality.
      +
      List<A>nub(Ord<A> o) +
      Removes duplicates according to the given ordering.
      +
      AorHead(F0<A> a) +
      Returns the head of this list if there is one or the given argument if this list is empty.
      +
      List<A>orTail(F0<List<A>> as) +
      Returns the tail of this list if there is one or the given argument if this list is empty.
      +
      P2<List<A>,List<A>>partition(F<A,java.lang.Boolean> f) +
      Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
      +
      List<List<A>>partition(int n) +
      Splits this list into lists of the given size.
      +
      static List<java.lang.Integer>range(int from, + int to) +
      Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      List<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> List<A>replicate(int n, + A a) +
      Returns a list of the given value replicated the given number of times.
      +
      List<A>reverse() +
      Reverse this list in constant stack space.
      +
      static <A,B> F<B,List<A>>sequence_(List<F<B,A>> fs) +
      Turn a list of functions into a function returning a list.
      +
      <B> List<B>sequence(List<B> bs) +
      Performs a bind across each list element, but ignores the element value each time.
      +
      static <L,B> Either<L,List<B>>sequenceEither(List<Either<L,B>> list) +
      Sequence the given list and collect the output on the right side of an either.
      +
      static <R,B> Either<List<B>,R>sequenceEitherLeft(List<Either<B,R>> list) +
      Sequence the given list and collect the output on the left side of an either.
      +
      static <L,B> Either<L,List<B>>sequenceEitherRight(List<Either<L,B>> list) +
      Sequence the given list and collect the output on the right side of an either.
      +
      static <C,B> F<C,List<B>>sequenceF(List<F<C,B>> list) +
      Sequence the given list and collect the output as a function.
      +
      static <B> IO<List<B>>sequenceIO(List<IO<B>> list) +
      Sequence the given list and collect the output as an IO.
      +
      static <B> List<List<B>>sequenceList(List<List<B>> list) +
      Sequence the given list and collect the output as an list.
      +
      static <B> Option<List<B>>sequenceOption(List<Option<B>> list) +
      Sequence the given list and collect the output as an list.
      +
      static <B> P1<List<B>>sequenceP1(List<P1<B>> list) +
      Sequence the given list and collect the output as a P1.
      +
      static <B> Seq<List<B>>sequenceSeq(List<Seq<B>> list) +
      Sequence the given list and collect the output as a seq.
      +
      static <B> Set<List<B>>sequenceSet(Ord<B> ord, + List<Set<B>> list) +
      Sequence the given list and collect the output as a set; use the given ord to order the set.
      +
      static <B> Stream<List<B>>sequenceStream(List<Stream<B>> list) +
      Sequence the given list and collect the output as a stream.
      +
      static <B> Trampoline<List<B>>sequenceTrampoline(List<Trampoline<B>> list) +
      Sequence the given list and collect the output as a trampoline.
      +
      static <E,B> Validation<E,List<B>>sequenceValidation(Semigroup<E> semigroup, + List<Validation<E,B>> list) +
      Sequence the given list and collect the output as a validation; use the given semigroup to reduce the errors.
      +
      static <A> List<A>single(A a) +
      Returns a list of one element containing the given value.
      +
      List<A>snoc(A a) +
      Appends (snoc) the given element to this list to produce a new list.
      +
      List<A>sort(Ord<A> o) +
      Sorts this list using the given order over elements using a merge sort algorithm.
      +
      P2<List<A>,List<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
      +
      P2<List<A>,List<A>>splitAt(int i) +
      Splits this list into two lists at the given index.
      +
      static <A> F<List<A>,List<A>>tail_() +
      First-class tail function.
      +
      abstract List<A>tail() +
      The list without the first element or fails for the empty list.
      +
      Option<List<A>>tailOption() +
      Reutrns the tail of the list, if any.
      +
      List<List<A>>tails() +
      Returns the list of final segments of this list, longest first.
      +
      static <A> F<java.lang.Integer,F<List<A>,List<A>>>take() +
      Provides a first-class version of take.
      +
      List<A>take(int i) +
      Takes the given number of elements from the head of this list if they are available.
      +
      List<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this list that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this list.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this list.
      +
      java.lang.Object[]toArrayObject() 
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this list.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
      +
      java.util.List<A>toJavaList() 
      Stream<A>toStream() +
      Returns a stream projection of this list.
      +
      java.lang.StringtoString() +
      Obtain a string representation of this list using the toString implementations of the members.
      +
      <B,E> Either<E,List<B>>traverseEither(F<A,Either<E,B>> f) +
      Traverse through the List with given function.
      +
      <R,B> Either<List<B>,R>traverseEitherLeft(F<A,Either<B,R>> f) +
      Traverse this list with the given function and collect the output on the left side of an either.
      +
      <L,B> Either<L,List<B>>traverseEitherRight(F<A,Either<L,B>> f) +
      Traverse this list with the given function and collect the output on the right side of an either.
      +
      <C,B> F<C,List<B>>traverseF(F<A,F<C,B>> f) +
      Traverse this list with the given function and collect the output as a function.
      +
      <B> IO<List<B>>traverseIO(F<A,IO<B>> f) +
      Traverse this list with the given function and collect the output as an IO.
      +
      <B> List<List<B>>traverseList(F<A,List<B>> f) +
      Traverse this list with the given function and collect the output as a list.
      +
      <B> Option<List<B>>traverseOption(F<A,Option<B>> f) +
      Traverses through the List with the given function
      +
      <B> P1<List<B>>traverseP1(F<A,P1<B>> f) +
      Traverse this list with the given function and collect the output as a p1.
      +
      <B> Promise<List<B>>traversePromise(F<A,Promise<B>> f) 
      <B> Seq<List<B>>traverseSeq(F<A,Seq<B>> f) +
      Traverse this list with the given function and collect the output as a seq.
      +
      <B> Set<List<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) +
      Traverse this list with the given function and collect the output as a set; use the given ord to order the set.
      +
      <B> Stream<List<B>>traverseStream(F<A,Stream<B>> f) +
      Traverse this list with the given function and collect the output as a stream.
      +
      <B> Trampoline<List<B>>traverseTrampoline(F<A,Trampoline<B>> f) +
      Traverse this list with the given function and collect the output as a trampoline.
      +
      <B> V2<List<B>>traverseV2(F<A,V2<B>> f) 
      <E,B> Validation<E,List<B>>traverseValidation(Semigroup<E> s, + F<A,Validation<E,B>> f) +
      Traverse this list with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
      +
      <B> Buncons(F2<A,List<A>,B> cons, + B nil) 
      static <A,B> List<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a list.
      +
      static <A,B> P2<List<A>,List<B>>unzip(List<P2<A,B>> xs) +
      Transforms a list of pairs into a list of first components and a list of second components.
      +
      static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>>zip() +
      The first-class version of the zip function.
      +
      <B> List<P2<A,B>>zip(List<B> bs) +
      Zips this list with the given list to produce a list of pairs.
      +
      List<P2<A,java.lang.Integer>>zipIndex() +
      Zips this list with the index of its element as a pair.
      +
      static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>>zipWith() +
      Provides a first-class version of zipWith
      +
      <B,C> List<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      <B,C> List<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this list with the given list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        Returns:
        +
        The first element of the linked list or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract List<A> tail()
        +
        The list without the first element or fails for the empty list.
        +
        +
        Returns:
        +
        The list without the first element or fails for the empty list.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this list is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this list is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this list is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this list is empty, true otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(F2<A,List<A>,B> cons,
+                          B nil)
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this list is empty.
        +
        Returns:
        +
        The head of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final List<A> orTail(F0<List<A>> as)
        +
        Returns the tail of this list if there is one or the given argument if this list is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this list is empty.
        +
        Returns:
        +
        The tail of this list if there is one or the given argument if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        Returns the head of the list, if any.
        +
        +
        Returns:
        +
        The optional head of the list.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this list is empty.
        +
        Returns:
        +
        An either projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this list.
        +
        +
        Returns:
        +
        A stream projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this list.
        +
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toArrayObject

        +
        public final java.lang.Object[] toArrayObject()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this list.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final List<A> cons(A a)
        +
        Prepends (cons) the given element to this list to product a new list.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + + + +
        +
      • +

        conss

        +
        public final List<A> conss(A a)
        +
        Prepends (cons) the given element to this list to product a new list. This method is added to prevent conflict with + overloads.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new list with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> List<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this list.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final List<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final List<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final List<A> delete(A a,
+                            Equal<A> e)
        +
        Removes the first element that equals the given object. + To remove all matches, use removeAll(e.eq(a))
        +
        +
        Parameters:
        +
        a - The element to remove
        +
        e - An Equals instance for the element's type.
        +
        Returns:
        +
        A new list whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final List<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this list that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this list until it finds an element that does not + hold, or the list is exhausted.
        +
        Returns:
        +
        The first elements of the head of this list that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final List<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this list.
        +
        Returns:
        +
        The list whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<List<A>,List<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        breakk

        +
        public final P2<List<A>,List<A>> breakk(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        Parameters:
        +
        p - A predicate for an element to not satisfy by a prefix of this list.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
        +
        +
        • +
      + + + +
        +
      • +

        group

        +
        public final List<List<A>> group(Equal<A> e)
        +
        Groups elements according to the given equality implementation by longest + sequence of equal elements.
        +
        +
        Parameters:
        +
        e - The equality implementation for the elements.
        +
        Returns:
        +
        A list of grouped elements.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> List<B> bind(F<A,List<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> List<C> bind(List<B> lb,
+                                F2<A,B,C> f)
        +
        Binds the given function across each element of this list and the given list with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<List<A>,F<List<B>,List<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes the given function of arity-2 to a function on lists.
        +
        +
        Parameters:
        +
        f - The function to promote to a function on lists.
        +
        Returns:
        +
        The given function, promoted to operate on lists.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> List<D> bind(List<B> lb,
+                                  List<C> lc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> List<E> bind(List<B> lb,
+                                    List<C> lc,
+                                    List<D> ld,
+                                    F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> List<F$> bind(List<B> lb,
+                                        List<C> lc,
+                                        List<D> ld,
+                                        List<E> le,
+                                        F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> List<G> bind(List<B> lb,
+                                         List<C> lc,
+                                         List<D> ld,
+                                         List<E> le,
+                                         List<F$> lf,
+                                         F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> List<H> bind(List<B> lb,
+                                           List<C> lc,
+                                           List<D> ld,
+                                           List<E> le,
+                                           List<F$> lf,
+                                           List<G> lg,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> List<I> bind(List<B> lb,
+                                             List<C> lc,
+                                             List<D> ld,
+                                             List<E> le,
+                                             List<F$> lf,
+                                             List<G> lg,
+                                             List<H> lh,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this list and the given lists with a final + join.
        +
        +
        Parameters:
        +
        lb - A given list to bind the given function with.
        +
        lc - A given list to bind the given function with.
        +
        ld - A given list to bind the given function with.
        +
        le - A given list to bind the given function with.
        +
        lf - A given list to bind the given function with.
        +
        lg - A given list to bind the given function with.
        +
        lh - A given list to bind the given function with.
        +
        f - The function to apply to each element of this list and the given lists.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> List<B> sequence(List<B> bs)
        +
        Performs a bind across each list element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The list to apply in the final join.
        +
        Returns:
        +
        A new list after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEither

        +
        public static final <L,B> Either<L,List<B>> sequenceEither(List<Either<L,B>> list)
        +
        Sequence the given list and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherLeft

        +
        public static final <R,B> Either<List<B>,R> sequenceEitherLeft(List<Either<B,R>> list)
        +
        Sequence the given list and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the right value
        +
        B - the type of the left value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherRight

        +
        public static final <L,B> Either<L,List<B>> sequenceEitherRight(List<Either<L,B>> list)
        +
        Sequence the given list and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceF

        +
        public static final <C,B> F<C,List<B>> sequenceF(List<F<C,B>> list)
        +
        Sequence the given list and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceIO

        +
        public static final <B> IO<List<B>> sequenceIO(List<IO<B>> list)
        +
        Sequence the given list and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static final <B> List<List<B>> sequenceList(List<List<B>> list)
        +
        Sequence the given list and collect the output as an list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceOption

        +
        public static final <B> Option<List<B>> sequenceOption(List<Option<B>> list)
        +
        Sequence the given list and collect the output as an list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceP1

        +
        public static final <B> P1<List<B>> sequenceP1(List<P1<B>> list)
        +
        Sequence the given list and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        B - the type of the P1 value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSeq

        +
        public static final <B> Seq<List<B>> sequenceSeq(List<Seq<B>> list)
        +
        Sequence the given list and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSet

        +
        public static final <B> Set<List<B>> sequenceSet(Ord<B> ord,
+                                                 List<Set<B>> list)
        +
        Sequence the given list and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        list - the given list
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public static final <B> Stream<List<B>> sequenceStream(List<Stream<B>> list)
        +
        Sequence the given list and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        list - the given list
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceTrampoline

        +
        public static final <B> Trampoline<List<B>> sequenceTrampoline(List<Trampoline<B>> list)
        +
        Sequence the given list and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        list - the given trampoline
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static final <E,B> Validation<E,List<B>> sequenceValidation(Semigroup<E> semigroup,
+                                                                   List<Validation<E,B>> list)
        +
        Sequence the given list and collect the output as a validation; use the given semigroup to reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        semigroup - the given semigroup
        +
        list - the given list
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <B,E> Either<E,List<B>> traverseEither(F<A,Either<E,B>> f)
        +
        Traverse through the List with given function.
        +
        +
        Parameters:
        +
        f - The function that produces Either value.
        +
        Returns:
        +
        error in left or f mapped list in right.
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherLeft

        +
        public final <R,B> Either<List<B>,R> traverseEitherLeft(F<A,Either<B,R>> f)
        +
        Traverse this list with the given function and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherRight

        +
        public final <L,B> Either<L,List<B>> traverseEitherRight(F<A,Either<L,B>> f)
        +
        Traverse this list with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public final <C,B> F<C,List<B>> traverseF(F<A,F<C,B>> f)
        +
        Traverse this list with the given function and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<List<B>> traverseIO(F<A,IO<B>> f)
        +
        Traverse this list with the given function and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<List<B>> traverseList(F<A,List<B>> f)
        +
        Traverse this list with the given function and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<List<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverses through the List with the given function
        +
        +
        Parameters:
        +
        f - The function that produces Option value
        +
        Returns:
        +
        none if applying f returns none to any element of the list or f mapped list in some .
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<List<B>> traverseP1(F<A,P1<B>> f)
        +
        Traverse this list with the given function and collect the output as a p1.
        +
        +
        Type Parameters:
        +
        B - the type of the p1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the p1
        +
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public final <B> Seq<List<B>> traverseSeq(F<A,Seq<B>> f)
        +
        Traverse this list with the given function and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public final <B> Set<List<B>> traverseSet(Ord<B> ord,
+                                          F<A,Set<B>> f)
        +
        Traverse this list with the given function and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        f - the given function
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<List<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traverse this list with the given function and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        traverseTrampoline

        +
        public final <B> Trampoline<List<B>> traverseTrampoline(F<A,Trampoline<B>> f)
        +
        Traverse this list with the given function and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the trampoline value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + + + + + +
        +
      • +

        traverseValidation

        +
        public final <E,B> Validation<E,List<B>> traverseValidation(Semigroup<E> s,
+                                                            F<A,Validation<E,B>> f)
        +
        Traverse this list with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        s - the given semigroup
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseV2

        +
        public final <B> V2<List<B>> traverseV2(F<A,V2<B>> f)
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> List<B> apply(List<F<A,B>> lf)
        +
        Performs function application within a list (applicative functor pattern).
        +
        +
        Parameters:
        +
        lf - The list of functions to apply.
        +
        Returns:
        +
        A new list after applying the given list of functions through this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final List<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append to this one.
        +
        Returns:
        +
        A new list that has appended the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<B,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this list.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRightC

        +
        public final <B> Trampoline<B> foldRightC(F2<A,B,B> f,
+                                          B b)
        +
        Performs a right-fold reduction across this list in O(1) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        A Trampoline containing the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the list.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final List<A> reverse()
        +
        Reverse this list in constant stack space.
        +
        +
        Returns:
        +
        A new list that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final List<A> take(int i)
        +
        Takes the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The maximum number of elements to take from this list.
        +
        Returns:
        +
        A new list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final List<A> drop(int i)
        +
        Drops the given number of elements from the head of this list if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this list.
        +
        Returns:
        +
        A list with a length the same, or less than, this list.
        +
        +
        • +
      + + + +
        +
      • +

        splitAt

        +
        public final P2<List<A>,List<A>> splitAt(int i)
        +
        Splits this list into two lists at the given index. If the index goes out of bounds, then it is + normalised so that this function never fails.
        +
        +
        Parameters:
        +
        i - The index at which to split this list in two parts.
        +
        Returns:
        +
        A pair of lists split at the given index of this list.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final List<List<A>> partition(int n)
        +
        Splits this list into lists of the given size. If the size of this list is not evenly divisible by + the given number, the last partition will contain the remainder.
        +
        +
        Parameters:
        +
        n - The size of the partitions into which to split this list.
        +
        Returns:
        +
        A list of sublists of this list, of at most the given size.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public final P2<List<A>,List<A>> partition(F<A,java.lang.Boolean> f)
        +
        Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not. The relative order of the elements in the returned tuple + is the same as the original list.
        +
        +
        Parameters:
        +
        f - Predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final List<List<A>> inits()
        +
        Returns the list of initial segments of this list, shortest first.
        +
        +
        Returns:
        +
        The list of initial segments of this list, shortest first.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final List<List<A>> tails()
        +
        Returns the list of final segments of this list, longest first.
        +
        +
        Returns:
        +
        The list of final segments of this list, longest first.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final List<A> sort(Ord<A> o)
        +
        Sorts this list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this list.
        +
        Returns:
        +
        A sorted list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> List<C> zipWith(List<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this list with the given list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        f - The function to zip this list and the given list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<List<A>,F<List<B>,F<F<A,F<B,C>>,List<C>>>> zipWith()
        +
        Provides a first-class version of zipWith
        +
        +
        Returns:
        +
        The first-class version of zipWith
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> List<P2<A,B>> zip(List<B> bs)
        +
        Zips this list with the given list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The list to zip this list with.
        +
        Returns:
        +
        A new list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public static <A,B> F<List<A>,F<List<B>,List<P2<A,B>>>> zip()
        +
        The first-class version of the zip function.
        +
        +
        Returns:
        +
        A function that zips the given lists to produce a list of pairs.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final List<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new list with the same length as this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final List<A> snoc(A a)
        +
        Appends (snoc) the given element to this list to produce a new list.
        +
        +
        Parameters:
        +
        a - The element to append to this list.
        +
        Returns:
        +
        A new list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on each element of this list.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this list, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this list.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + list.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this list.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final List<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this list.
        +
        Returns:
        +
        A list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        intercalate

        +
        public final List<A> intercalate(List<List<A>> as)
        +
        Intersperses this list through the given list then joins the results.
        +
        +
        Parameters:
        +
        as - The list to intersperse through.
        +
        Returns:
        +
        This list through the given list then joins the results.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub()
        +
        Removes duplicates according to object equality.
        +
        +
        Returns:
        +
        A list without duplicates according to object equality.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Equal<A> eq)
        +
        Removes duplicates according to the given equality. Warning: O(n^2).
        +
        +
        Parameters:
        +
        eq - Equality over the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        nub

        +
        public final List<A> nub(Ord<A> o)
        +
        Removes duplicates according to the given ordering. This function is O(n).
        +
        +
        Parameters:
        +
        o - An ordering for the elements.
        +
        Returns:
        +
        A list without duplicates.
        +
        +
        • +
      + + + +
        +
      • +

        head_

        +
        public static <A> F<List<A>,A> head_()
        +
        First-class head function.
        +
        +
        Returns:
        +
        A function that gets the head of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        tailOption

        +
        public final Option<List<A>> tailOption()
        +
        Reutrns the tail of the list, if any.
        +
        +
        Returns:
        +
        The optional tail of the list.
        +
        +
        • +
      + + + +
        +
      • +

        tail_

        +
        public static <A> F<List<A>,List<A>> tail_()
        +
        First-class tail function.
        +
        +
        Returns:
        +
        A function that gets the tail of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final List<A> minus(Equal<A> eq,
+                           List<A> xs)
        +
        Returns a new list of all the items in this list that do not appear in the given list.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the lists.
        +
        xs - a list to subtract from this list.
        +
        Returns:
        +
        a list of all the items in this list that do not appear in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,List<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapMOption

        +
        public final <B> Option<List<B>> mapMOption(F<A,Option<B>> f)
        +
        Maps the given function across this list by binding through the Option monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A possible list of values after binding through the Option monad.
        +
        +
        • +
      + + + +
        +
      • +

        mapMTrampoline

        +
        public final <B> Trampoline<List<B>> mapMTrampoline(F<A,Trampoline<B>> f)
        +
        Maps the given function across this list by binding through the Trampoline monad.
        +
        +
        Parameters:
        +
        f - The function to apply through the this list.
        +
        Returns:
        +
        A list of values in the Trampoline monad.
        +
        +
        • +
      + + + + + +
        +
      • +

        elementIndex

        +
        public final Option<java.lang.Integer> elementIndex(Equal<A> e,
+                                                    A a)
        +
        Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        Parameters:
        +
        e - An equality for this list's elements.
        +
        a - A query element.
        +
        Returns:
        +
        The index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Returns the last element of this list. Undefined for the empty list.
        +
        +
        Returns:
        +
        The last element of this list or throws an error if this list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public final List<A> init()
        +
        Returns all but the last element of this list. Undefiend for the empty list.
        +
        +
        Returns:
        +
        All but the last element of this list. Undefiend for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertBy

        +
        public final List<A> insertBy(F<A,F<A,Ordering>> f,
+                              A x)
        +
        Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
        +
        +
        Parameters:
        +
        f - An ordering function to compare elements.
        +
        x - The element to insert.
        +
        Returns:
        +
        A new list with the given element inserted before the first element that is greater than or equal to + it according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        mode

        +
        public final A mode(Ord<A> o)
        +
        Returns the most common element in this list.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The most common element in this list.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B> TreeMap<B,List<A>> groupBy(F<A,B> keyFunction,
+                                            Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,List<C>> groupBy(F<A,B> keyFunction,
+                                              F<A,C> valueFunction,
+                                              Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + +
        +
      • +

        groupBy

        +
        public final <B,C> TreeMap<B,C> groupBy(F<A,B> keyFunction,
+                                        F<A,C> valueFunction,
+                                        Monoid<C> monoid,
+                                        Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction. The ordering of the keys is determined by + the keyOrd parameter.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys for the map.
        +
        valueFunction - The function to apply on each matching value.
        +
        monoid - A monoid, which defines the accumulator for the values and the zero value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated list of matched and mapped elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        groupBy

        +
        public final <B,C,D> TreeMap<B,D> groupBy(F<A,B> keyFunction,
+                                          F<A,C> valueFunction,
+                                          D groupingIdentity,
+                                          F2<C,D,D> groupingAcc,
+                                          Ord<B> keyOrd)
        +
        Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
        +
        +
        Parameters:
        +
        keyFunction - The function to select the keys.
        +
        valueFunction - The function to apply on each element.
        +
        groupingIdentity - The identity, or start value, for the grouping.
        +
        groupingAcc - The accumulator to apply on each matching value.
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        A TreeMap containing the keys with the accumulated result of matched and mapped + elements.
        +
        +
        • +
      + + + +
        +
      • +

        allEqual

        +
        public final boolean allEqual(Equal<A> eq)
        +
        Returns whether or not all elements in the list are equal according to the given equality test.
        +
        +
        Parameters:
        +
        eq - The equality test.
        +
        Returns:
        +
        Whether or not all elements in the list are equal according to the given equality test.
        +
        +
        • +
      + + + +
        +
      • +

        isPrefixOf

        +
        public final boolean isPrefixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        isSuffixOf

        +
        public final boolean isSuffixOf(Equal<A> eq,
+                                List<A> xs)
        +
        • +
      + + + +
        +
      • +

        length_

        +
        public static <A> F<List<A>,java.lang.Integer> length_()
        +
        First-class length.
        +
        +
        Returns:
        +
        A function that gets the length of a given list.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximumOption

        +
        public final Option<A> maximumOption(Ord<A> o)
        +
        Returns the maximum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        minimumOption

        +
        public final Option<A> minimumOption(Ord<A> o)
        +
        Returns the minimum element in this list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of the list.
        +
        Returns:
        +
        The optional minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this list.
        +
        +
        Returns:
        +
        An immutable collection of this list.
        +
        +
        • +
      + + + + + +
        +
      • +

        list

        +
        @SafeVarargs
+public static <A> List<A> list(A... as)
        +
        Constructs a list from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to construct a list with.
        +
        Returns:
        +
        A list with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayList

        +
        @SafeVarargs
+public static <A> List<A> arrayList(A... as)
        +
        Constructs a list from the given elements.
        +
        • +
      + + + +
        +
      • +

        fromIterator

        +
        public static <A> List<A> fromIterator(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> List<A> nil()
        +
        Returns an empty list.
        +
        +
        Returns:
        +
        An empty list.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<List<A>,List<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a list to produce a new list.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a list to produce a new list.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F2<A,List<A>,List<A>> cons_()
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,List<A>> cons(List<A> tail)
        +
        Returns a function that prepends a value to the given list.
        +
        +
        Parameters:
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        A function that prepends a value to the given list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons_

        +
        public static <A> F<List<A>,List<A>> cons_(A a)
        +
        Returns a function that prepends the given value to a list.
        +
        +
        Parameters:
        +
        a - The value to prepend to a list.
        +
        Returns:
        +
        A function that prepends the given value to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> List<A> cons(A head,
+                               List<A> tail)
        +
        Prepends the given head element to the given tail element to produce a new list.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The list to prepend to.
        +
        Returns:
        +
        The list with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given list is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<List<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given list is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given list is not empty.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> List<A> join(List<List<A>> o)
        +
        Joins the given list of lists using a bind operation.
        +
        +
        Parameters:
        +
        o - The list of lists to join.
        +
        Returns:
        +
        A new list that is the join of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<List<List<A>>,List<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a list of lists using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> List<A> unfold(F<B,Option<P2<A,B>>> f,
+                                   B b)
        +
        Unfolds across the given function starting at the given value to produce a list.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new list that is a result of unfolding until the function does not produce a value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<List<A>,List<B>> unzip(List<P2<A,B>> xs)
        +
        Transforms a list of pairs into a list of first components and a list of second components.
        +
        +
        Parameters:
        +
        xs - The list of pairs to transform.sp
        +
        Returns:
        +
        A list of first components and a list of second components.
        +
        +
        • +
      + + + + + +
        +
      • +

        replicate

        +
        public static <A> List<A> replicate(int n,
+                                    A a)
        +
        Returns a list of the given value replicated the given number of times.
        +
        +
        Parameters:
        +
        n - The number of times to replicate the given value.
        +
        a - The value to replicate.
        +
        Returns:
        +
        A list of the given value replicated the given number of times.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static List<java.lang.Integer> range(int from,
+                                            int to)
        +
        Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the list (inclusive).
        +
        to - The maximum value for the list (exclusive).
        +
        Returns:
        +
        A list of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static List<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a list of characters from the given string. The inverse of this function is asString(List).
        +
        +
        Parameters:
        +
        s - The string to produce the list of characters from.
        +
        Returns:
        +
        A list of characters from the given string.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,List<java.lang.Character>> fromString()
        +
        A first-class fromString.
        +
        +
        Returns:
        +
        A first-class fromString.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(List<java.lang.Character> cs)
        +
        Returns a string from the given list of characters. The invers of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The list of characters to produce the string from.
        +
        Returns:
        +
        A string from the given list of characters.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static F<List<java.lang.Character>,java.lang.String> asString()
        +
        A first-class asString.
        +
        +
        Returns:
        +
        A first-class asString.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> List<A> single(A a)
        +
        Returns a list of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned list.
        +
        Returns:
        +
        A list of one element containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> List<A> iterateWhile(F<A,A> f,
+                                       F<A,java.lang.Boolean> p,
+                                       A a)
        +
        Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public static <A,B> Option<B> lookup(Equal<A> e,
+                                     List<P2<A,B>> x,
+                                     A a)
        +
        Returns an associated value with the given key in the list of pairs.
        +
        +
        Parameters:
        +
        e - The test for equality on keys.
        +
        x - The list of pairs to search.
        +
        a - The key value to find the associated value of.
        +
        Returns:
        +
        An associated value with the given key in the list of pairs.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,List<B>>,F<List<A>,List<B>>> bind_()
        +
        Provides a first-class version of bind()
        +
        +
        Returns:
        +
        The bind function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<List<A>,List<B>>> map_()
        +
        Provides a first-class version of map()
        +
        +
        Returns:
        +
        The map function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,List<A>> sequence_(List<F<B,A>> fs)
        +
        Turn a list of functions into a function returning a list.
        +
        +
        Parameters:
        +
        fs - The list of functions to sequence into a single function that returns a list.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given list to it + and returns a list of the results.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft

        +
        public static <A,B> F<F<B,F<A,B>>,F<B,F<List<A>,B>>> foldLeft()
        +
        Provides a first-class version of foldLeft.
        +
        +
        Returns:
        +
        The left fold function for lists.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public static <A> F<java.lang.Integer,F<List<A>,List<A>>> take()
        +
        Provides a first-class version of take.
        +
        +
        Returns:
        +
        First-class version of take.
        +
        +
        • +
      + + + +
        +
      • +

        iterableList

        +
        public static <A> List<A> iterableList(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a list.
        +
        +
        Parameters:
        +
        i - The iterable to take to a list.
        +
        Returns:
        +
        A list from the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorList

        +
        public static <A> List<A> iteratorList(java.util.Iterator<A> it)
        +
        Constructs a list from the given Iterator.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.listEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        Compute the hash code from this list as a function of the hash codes of its members. + Delegates to Hash.listHash, using the anyHash() rule, which uses the hash codes of the contents.
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        Returns:
        +
        the hash code for this list.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        Obtain a string representation of this list using the toString implementations of the members. Uses Show.listShow with F2 argument and may + not be very performant.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        a String representation of the list
        +
        +
        • +
      + + + +
        +
      • +

        isSingle

        +
        public final boolean isSingle()
        +
        True if and only if the list has one element. Runs in constant time.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Natural.html b/javadoc/5.0/functionaljava/fj/data/Natural.html new file mode 100644 index 0000000..4afd276 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Natural.html @@ -0,0 +1,929 @@ + + + + + +Natural (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Natural

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Number
      • +
    • +
        +
      • fj.data.Natural
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public final class Natural
+extends java.lang.Number
    +
    Represents a natural number (zero, one, two, etc.)
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fromBigInt

        +
        public static final F<java.math.BigInteger,Option<Natural>> fromBigInt
        +
        A function that returns the natural number equal to a given BigInteger
        +
        • +
      + + + +
        +
      • +

        ZERO

        +
        public static final Natural ZERO
        +
        The natural number zero
        +
        • +
      + + + +
        +
      • +

        ONE

        +
        public static final Natural ONE
        +
        The natural number one
        +
        • +
      + + + + + + + +
        +
      • +

        subtract

        +
        public static final F<Natural,F<Natural,Option<Natural>>> subtract
        +
        A function that subtracts its first argument from its second.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<Natural,F<Natural,Natural>> multiply
        +
        A function that multiplies a natural number by another.
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public static final F<Natural,F<Natural,Natural>> divide
        +
        A function that divides its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public static final F<Natural,F<Natural,Natural>> mod
        +
        A function that yields the remainder of division of its second argument by its first.
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public static final F<Natural,F<Natural,V2<Natural>>> divmod
        +
        A function that divides its second argument by its first, yielding both the quotient and the remainder.
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public static final F<Natural,java.math.BigInteger> bigIntegerValue
        +
        A function that returns the BigInteger value of a given Natural.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(java.math.BigInteger i)
        +
        Returns the natural number equal to the given BigInteger
        +
        +
        Parameters:
        +
        i - A given BigInteger
        +
        Returns:
        +
        An optional natural number, or none if the given BigInteger is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        natural

        +
        public static Option<Natural> natural(long i)
        +
        Returns the natural number equal to the given long
        +
        +
        Parameters:
        +
        i - A given long
        +
        Returns:
        +
        An optional natural number, or none if the given long is less than zero.
        +
        +
        • +
      + + + +
        +
      • +

        succ

        +
        public Natural succ()
        +
        Return the successor of this natural number
        +
        +
        Returns:
        +
        the successor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        succ_

        +
        public static F<Natural,Natural> succ_()
        +
        First-class successor function.
        +
        +
        Returns:
        +
        A function that returns the successor of a given natural number.
        +
        +
        • +
      + + + +
        +
      • +

        pred

        +
        public Option<Natural> pred()
        +
        Return the predecessor of this natural number
        +
        +
        Returns:
        +
        the predecessor of this natural number
        +
        +
        • +
      + + + +
        +
      • +

        pred_

        +
        public static F<Natural,Option<Natural>> pred_()
        +
        First-class predecessor function.
        +
        +
        Returns:
        +
        A function that returns the predecessor of a given natural number, or None if it's zero.
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public Natural add(Natural n)
        +
        Add two natural numbers together.
        +
        +
        Parameters:
        +
        n - A natural number to add to this one.
        +
        Returns:
        +
        the sum of the two natural numbers.
        +
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public Option<Natural> subtract(Natural n)
        +
        Subtract a natural number from another.
        +
        +
        Parameters:
        +
        n - A natural number to subtract from this one.
        +
        Returns:
        +
        The difference between the two numbers, if this number is larger than the given one. Otherwise none.
        +
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public Natural multiply(Natural n)
        +
        Multiply a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to multiply by this one.
        +
        Returns:
        +
        The product of the two numbers.
        +
        +
        • +
      + + + +
        +
      • +

        divide

        +
        public Natural divide(Natural n)
        +
        Divide a natural number by another.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient of this number and the highest number, less than or equal to the given number, + that divides this number.
        +
        +
        • +
      + + + +
        +
      • +

        mod

        +
        public Natural mod(Natural n)
        +
        Take the remainder of a natural number division.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The remainder of division of this number by the given number.
        +
        +
        • +
      + + + +
        +
      • +

        divmod

        +
        public V2<Natural> divmod(Natural n)
        +
        Divide a natural number by another yielding both the quotient and the remainder.
        +
        +
        Parameters:
        +
        n - A natural number to divide this one by.
        +
        Returns:
        +
        The quotient and the remainder, in that order.
        +
        +
        • +
      + + + +
        +
      • +

        bigIntegerValue

        +
        public java.math.BigInteger bigIntegerValue()
        +
        Return the BigInteger value of this natural number.
        +
        +
        Returns:
        +
        the BigInteger value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        Return the long value of this natural number.
        +
        +
        Specified by:
        +
        longValue in class java.lang.Number
        +
        Returns:
        +
        the long value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        floatValue

        +
        public float floatValue()
        +
        Return the float value of this natural number.
        +
        +
        Specified by:
        +
        floatValue in class java.lang.Number
        +
        Returns:
        +
        the float value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        doubleValue

        +
        public double doubleValue()
        +
        Return the double value of this natural number.
        +
        +
        Specified by:
        +
        doubleValue in class java.lang.Number
        +
        Returns:
        +
        the double value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        intValue

        +
        public int intValue()
        +
        Return the int value of this natural number.
        +
        +
        Specified by:
        +
        intValue in class java.lang.Number
        +
        Returns:
        +
        the int value of this natural number.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(Stream<Natural> ns)
        +
        Sums a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(Stream<Natural> ns)
        +
        Takes the product of a stream of natural numbers.
        +
        +
        Parameters:
        +
        ns - A stream of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the stream.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static Natural sum(List<Natural> ns)
        +
        Sums a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The sum of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static Natural product(List<Natural> ns)
        +
        Takes the product of a list of natural numbers.
        +
        +
        Parameters:
        +
        ns - A list of natural numbers.
        +
        Returns:
        +
        The product of all the natural numbers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object that)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/NonEmptyList.html b/javadoc/5.0/functionaljava/fj/data/NonEmptyList.html new file mode 100644 index 0000000..d26231c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/NonEmptyList.html @@ -0,0 +1,1040 @@ + + + + + +NonEmptyList (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class NonEmptyList<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.NonEmptyList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class NonEmptyList<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable, singly linked list with total head and tail.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      NonEmptyList<A>append(List<A> as) +
      Appends the given list to this list.
      +
      NonEmptyList<A>append(NonEmptyList<A> as) +
      Appends the given list to this list.
      +
      <B> NonEmptyList<B>bind(F<A,NonEmptyList<B>> f) +
      Binds the given function across each element of this list with a final join.
      +
      NonEmptyList<A>cons(A a) +
      Prepend the given value to this list.
      +
      booleanequals(java.lang.Object obj) +
      Perform an equality test on this list which delegates to the .equals() method of the member instances.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Performs a left-fold reduction across this list.
      +
      AfoldRight1(F<A,F<A,A>> f) +
      Performs a right-fold reduction across this list.
      +
      AfoldRight1(F2<A,A,A> f) +
      Performs a right-fold reduction across this list.
      +
      static <A> Option<NonEmptyList<A>>fromList(List<A> as) +
      Returns a potential non-empty list from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this linked list.
      +
      NonEmptyList<A>intersperse(A a) +
      Intersperses the given argument between each element of this non empty list.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this non-empty list.
      +
      static <A> NonEmptyList<A>join(NonEmptyList<NonEmptyList<A>> o) +
      Concatenate (join) a non empty list of non empty lists.
      +
      intlength() +
      The length of this list.
      +
      <B> NonEmptyList<B>map(F<A,B> f) +
      Maps the given function across this list.
      +
      <B> NonEmptyList<B>mapTails(F<NonEmptyList<A>,B> f) +
      Maps the given function across the tails of this list (comonad pattern).
      +
      Amaximum(Ord<A> o) +
      Returns the maximum element in this non empty list according to the given ordering.
      +
      Aminimum(Ord<A> o) +
      Returns the minimum element in this non empty list according to the given ordering.
      +
      static <A> F<A,NonEmptyList<A>>nel() +
      Returns a function that puts an element into a non-empty list.
      +
      static <A> NonEmptyList<A>nel(A head, + A... tail) +
      Constructs a non empty list from the given elements.
      +
      static <A> NonEmptyList<A>nel(A head, + List<A> tail) +
      Return a non-empty list with the given head and tail.
      +
      NonEmptyList<A>reverse() +
      Reverse this non empty list in constant stack space.
      +
      NonEmptyList<A>snoc(A a) +
      Appends (snoc) the given element to this non empty list to produce a new non empty list.
      +
      NonEmptyList<A>sort(Ord<A> o) +
      Sorts this non empty list using the given order over elements using a merge sort algorithm.
      +
      NonEmptyList<NonEmptyList<A>>sublists() +
      Returns a NonEmptyList of the sublists of this list.
      +
      List<A>tail() +
      This list without the first element.
      +
      NonEmptyList<NonEmptyList<A>>tails() +
      Returns a NonEmptyList of the tails of this list.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this non-empty list.
      +
      static <A> F<NonEmptyList<A>,List<A>>toList_() +
      Returns a function that takes a non-empty list to a list.
      +
      List<A>toList() +
      Returns a List projection of this list.
      +
      java.lang.StringtoString() 
      static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>>unzip(NonEmptyList<P2<A,B>> xs) +
      Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
      +
      <B> NonEmptyList<P2<A,B>>zip(NonEmptyList<B> bs) +
      Zips this non empty list with the given non empty list to produce a list of pairs.
      +
      NonEmptyList<P2<A,java.lang.Integer>>zipIndex() +
      Zips this non empty list with the index of its element as a pair.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F<A,F<B,C>> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      <B,C> NonEmptyList<C>zipWith(List<B> bs, + F2<A,B,C> f) +
      Zips this non empty list with the given non empty list using the given function to produce a new list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this non-empty list. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this linked list.
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public List<A> tail()
        +
        This list without the first element.
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public NonEmptyList<A> cons(A a)
        +
        Prepend the given value to this list.
        +
        +
        Parameters:
        +
        a - The value to prepend.
        +
        Returns:
        +
        A non-empty list with an extra element.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public NonEmptyList<A> snoc(A a)
        +
        Appends (snoc) the given element to this non empty list to produce a new non empty list. O(n).
        +
        +
        Parameters:
        +
        a - The element to append to this non empty list.
        +
        Returns:
        +
        A new non empty list with the given element appended.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        The length of this list.
        +
        +
        Returns:
        +
        The length of this list.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(List<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public NonEmptyList<A> append(NonEmptyList<A> as)
        +
        Appends the given list to this list.
        +
        +
        Parameters:
        +
        as - The list to append.
        +
        Returns:
        +
        A new list with the given list appended.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F<A,F<A,A>> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldRight1

        +
        public final A foldRight1(F2<A,A,A> f)
        +
        Performs a right-fold reduction across this list. This function uses O(length) stack space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Performs a left-fold reduction across this list. This function runs in constant space.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> NonEmptyList<B> map(F<A,B> f)
        +
        Maps the given function across this list.
        +
        +
        Parameters:
        +
        f - The function to map across this list.
        +
        Returns:
        +
        A new list after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> NonEmptyList<B> bind(F<A,NonEmptyList<B>> f)
        +
        Binds the given function across each element of this list with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this list.
        +
        Returns:
        +
        A new list after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sublists

        +
        public NonEmptyList<NonEmptyList<A>> sublists()
        +
        Returns a NonEmptyList of the sublists of this list.
        +
        +
        Returns:
        +
        a NonEmptyList of the sublists of this list.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public NonEmptyList<NonEmptyList<A>> tails()
        +
        Returns a NonEmptyList of the tails of this list. A list is considered a tail of itself for the purpose of this + function (Comonad pattern).
        +
        +
        Returns:
        +
        A NonEmptyList of the tails of this list.
        +
        +
        • +
      + + + +
        +
      • +

        mapTails

        +
        public <B> NonEmptyList<B> mapTails(F<NonEmptyList<A>,B> f)
        +
        Maps the given function across the tails of this list (comonad pattern).
        +
        +
        Parameters:
        +
        f - The function to map across the tails of this list.
        +
        Returns:
        +
        The results of applying the given function to the tails of this list, as a NonEmptyList.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public NonEmptyList<A> intersperse(A a)
        +
        Intersperses the given argument between each element of this non empty list.
        +
        +
        Parameters:
        +
        a - The separator to intersperse in this non empty list.
        +
        Returns:
        +
        A non empty list with the given separator interspersed.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public NonEmptyList<A> reverse()
        +
        Reverse this non empty list in constant stack space.
        +
        +
        Returns:
        +
        A new non empty list with the elements in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public NonEmptyList<A> sort(Ord<A> o)
        +
        Sorts this non empty list using the given order over elements using a merge sort algorithm.
        +
        +
        Parameters:
        +
        o - The order over the elements of this non empty list.
        +
        Returns:
        +
        A sorted non empty list according to the given order.
        +
        +
        • +
      + + + +
        +
      • +

        minimum

        +
        public final A minimum(Ord<A> o)
        +
        Returns the minimum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The minimum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        maximum

        +
        public final A maximum(Ord<A> o)
        +
        Returns the maximum element in this non empty list according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this non empty list.
        +
        Returns:
        +
        The maximum element in this list according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> NonEmptyList<P2<A,B>> zip(NonEmptyList<B> bs)
        +
        Zips this non empty list with the given non empty list to produce a list of pairs. If this list and the given list + have different lengths, then the longer list is normalised so this function never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public NonEmptyList<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this non empty list with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new non empty list with the same length as this list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> NonEmptyList<C> zipWith(List<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this non empty list with the given non empty list using the given function to produce a new list. If this list + and the given list have different lengths, then the longer list is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The non empty list to zip this non empty list with.
        +
        f - The function to zip this non empty list and the given non empty list with.
        +
        Returns:
        +
        A new non empty list with a length the same as the shortest of this list and the given list.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<NonEmptyList<A>,NonEmptyList<B>> unzip(NonEmptyList<P2<A,B>> xs)
        +
        Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
        +
        +
        Parameters:
        +
        xs - The non empty list of pairs to transform.
        +
        Returns:
        +
        A non empty list of first components and a non empty list of second components.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Returns a List projection of this list.
        +
        +
        Returns:
        +
        A List projection of this list.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this non-empty list.
        +
        +
        Returns:
        +
        An immutable collection of this non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toList_

        +
        public static <A> F<NonEmptyList<A>,List<A>> toList_()
        +
        Returns a function that takes a non-empty list to a list.
        +
        +
        Returns:
        +
        A function that takes a non-empty list to a list.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        public static <A> NonEmptyList<A> nel(A head,
+                                      List<A> tail)
        +
        Return a non-empty list with the given head and tail.
        +
        +
        Parameters:
        +
        head - The first element of the new list.
        +
        tail - The remaining elements of the new list.
        +
        Returns:
        +
        A non-empty list with the given head and tail.
        +
        +
        • +
      + + + + + +
        +
      • +

        nel

        +
        @SafeVarargs
+public static <A> NonEmptyList<A> nel(A head,
+                                                    A... tail)
        +
        Constructs a non empty list from the given elements.
        +
        +
        Parameters:
        +
        head - The first in the non-empty list.
        +
        tail - The elements to construct a list's tail with.
        +
        Returns:
        +
        A non-empty list with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        nel

        +
        public static <A> F<A,NonEmptyList<A>> nel()
        +
        Returns a function that puts an element into a non-empty list.
        +
        +
        Returns:
        +
        A function that puts an element into a non-empty list.
        +
        +
        • +
      + + + +
        +
      • +

        fromList

        +
        public static <A> Option<NonEmptyList<A>> fromList(List<A> as)
        +
        Returns a potential non-empty list from the given list. A non-value is returned if the given list is empty.
        +
        +
        Parameters:
        +
        as - The list to construct a potential non-empty list with.
        +
        Returns:
        +
        A potential non-empty list from the given list.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> NonEmptyList<A> join(NonEmptyList<NonEmptyList<A>> o)
        +
        Concatenate (join) a non empty list of non empty lists.
        +
        +
        Parameters:
        +
        o - The non empty list of non empty lists to join.
        +
        Returns:
        +
        A new non empty list that is the concatenation of the given lists.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Perform an equality test on this list which delegates to the .equals() method of the member instances. + This is implemented with Equal.nonEmptyListEqual using the anyEqual rule.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        +
        obj - the other object to check for equality against.
        +
        Returns:
        +
        true if this list is equal to the provided argument
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Option.Optic.html b/javadoc/5.0/functionaljava/fj/data/Option.Optic.html new file mode 100644 index 0000000..8e57424 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Option.Optic.html @@ -0,0 +1,273 @@ + + + + + +Option.Optic (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Option.Optic

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option.Optic
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Option<A>
    +
    +
    +
    +
    public static final class Option.Optic
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Prism<Option<A>,Unit>none() +
      None prism
      +
      static <A,B> PPrism<Option<A>,Option<B>,A,B>pSome() +
      Polymorphic Some prism
      +
      static <A> Prism<Option<A>,A>some() +
      Monomorphic Some prism
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        none

        +
        public static <A> Prism<Option<A>,Unit> none()
        +
        None prism
        +
        • +
      + + + +
        +
      • +

        pSome

        +
        public static <A,B> PPrism<Option<A>,Option<B>,A,B> pSome()
        +
        Polymorphic Some prism
        +
        • +
      + + + +
        +
      • +

        some

        +
        public static <A> Prism<Option<A>,A> some()
        +
        Monomorphic Some prism
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Option.html b/javadoc/5.0/functionaljava/fj/data/Option.html new file mode 100644 index 0000000..038580a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Option.html @@ -0,0 +1,2769 @@ + + + + + +Option (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Option<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Option<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Option<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    An optional value that may be none (no value) or some (a value). This type is a replacement for + the use of null with better type checks.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Option.Optic 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,Option<java.lang.Byte>>parseByte +
      A function that parses a string to a byte.
      +
      static F<java.lang.String,Option<java.lang.Double>>parseDouble +
      A function that parses a string to a double.
      +
      static F<java.lang.String,Option<java.lang.Float>>parseFloat +
      A function that parses a string to a float.
      +
      static F<java.lang.String,Option<java.lang.Integer>>parseInt +
      A function that parses a string to an integer.
      +
      static F<java.lang.String,Option<java.lang.Long>>parseLong +
      A function that parses a string to a long.
      +
      static F<java.lang.String,Option<java.lang.Short>>parseShort +
      A function that parses a string to a short.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> Option<B>apply(Option<F<A,B>> of) +
      Performs function application within an optional value (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this optional value.
      +
      static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>>bind() +
      First-class bind function.
      +
      <B> Option<B>bind(F<A,Option<B>> f) +
      Binds the given function across the element of this optional value with a final join.
      +
      <B,C> Option<C>bind(Option<B> ob, + F<A,F<B,C>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D> Option<D>bind(Option<B> ob, + Option<C> oc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E> Option<E>bind(Option<B> ob, + Option<C> oc, + Option<D> od, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$>
      Option<F$>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G>
      Option<G>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H>
      Option<H>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B,C,D,E,F$,G,H,I>
      Option<I>      		bind(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across the element of this optional value and the given optional value + with a final join.
      +
      <B> Option<P2<A,B>>bindProduct(Option<B> ob) 
      <B,C> Option<P3<A,B,C>>bindProduct(Option<B> ob, + Option<C> oc) 
      <B,C,D> Option<P4<A,B,C,D>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od) 
      <B,C,D,E> Option<P5<A,B,C,D,E>>bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe) 
      <B,C,D,E,F$>
      Option<P6<A,B,C,D,E,F$>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of) 
      <B,C,D,E,F$,G>
      Option<P7<A,B,C,D,E,F$,G>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og) 
      <B,C,D,E,F$,G,H>
      Option<P8<A,B,C,D,E,F$,G,H>>      		bindProduct(Option<B> ob, + Option<C> oc, + Option<D> od, + Option<E> oe, + Option<F$> of, + Option<G> og, + Option<H> oh) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
      +
      Option<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for the value of this optional value.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for the value of this optional value.
      +
      static <T> F<T,Option<T>>fromNull() +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <T> Option<T>fromNull(T t) +
      Turns an unsafe nullable value into a safe optional value.
      +
      static <A> F<Option<A>,A>fromSome() +
      Returns a function that takes an optional value to a value or errors if there is no value.
      +
      static F<java.lang.String,Option<java.lang.String>>fromString() +
      Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
      +
      static Option<java.lang.String>fromString(java.lang.String s) +
      Returns an optional non-empty string, or no value if the given string is empty.
      +
      inthashCode() 
      static <A> F2<F<A,java.lang.Boolean>,A,Option<A>>iif() +
      First-class version of the iif function.
      +
      static <A> Option<A>iif(boolean p, + A a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(boolean p, + F0<A> a) +
      Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
      +
      static <A> Option<A>iif(F<A,java.lang.Boolean> f, + A a) +
      Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
      +
      static <A> F<Option<A>,java.lang.Boolean>isNone_() +
      A first-class version of the isNone method.
      +
      booleanisNone() +
      Returns false if this optional value has a value, true otherwise.
      +
      static <A> F<Option<A>,java.lang.Boolean>isSome_() +
      A first-class version of the isSome method.
      +
      booleanisSome() +
      Returns true if this optional value has a value, false otherwise.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this optional value.
      +
      static <A> F<Option<Option<A>>,Option<A>>join() +
      First-class join function.
      +
      static <A> Option<A>join(Option<Option<A>> o) +
      Joins the given optional value of optional value using a bind operation.
      +
      intlength() +
      Returns the length of this optional value; 1 if there is a value, 0 otherwise.
      +
      static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>>liftM2(F<A,F<B,C>> f) +
      Promotes a function of arity-2 so that it operates over options.
      +
      <B,C> Option<C>liftM2(Option<B> ob, + F2<A,B,C> f) +
      Lift the function of arity-2 through options.
      +
      static <A,B> F<F<A,B>,F<Option<A>,Option<B>>>map() +
      A first-class map function.
      +
      <B> Option<B>map(F<A,B> f) +
      Maps the given function across this optional value.
      +
      static <T> F<T,Option<T>>none_() 
      static <T> Option<T>none() +
      Constructs an optional value that has no value.
      +
      static <A,B> F<Option<A>,B>option_(B none, + F<A,B> some) +
      First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
      +
      <B> Boption(B b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      <B> Boption(F0<B> b, + F<A,B> f) +
      Performs a reduction on this optional value using the given arguments.
      +
      Option<A>orElse(F0<Option<A>> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      Option<A>orElse(Option<A> o) +
      Returns this optional value if there is one, otherwise, returns the argument optional value.
      +
      AorSome(A a) +
      Returns the value of this optional value or the given argument.
      +
      AorSome(F0<A> a) +
      Returns the value of this optional value or the given argument.
      +
      static <A> Option<List<A>>sequence(List<Option<A>> a) +
      Sequence a list through the option monad.
      +
      <B> Option<B>sequence(Option<B> o) +
      Performs a bind across the optional value, but ignores the element value in the function.
      +
      static <E,A> Option<Validation<E,A>>sequence(Validation<E,Option<A>> a) +
      Sequence a validation through the option monad.
      +
      static <L,B> Either<L,Option<B>>sequenceEither(Option<Either<L,B>> option) +
      Sequence the given option and collect the output on the right side of an either.
      +
      static <R,B> Either<Option<B>,R>sequenceEitherLeft(Option<Either<B,R>> option) +
      Sequence the given option and collect the output on the left side of an either.
      +
      static <L,B> Either<L,Option<B>>sequenceEitherRight(Option<Either<L,B>> option) +
      Sequence the given option and collect the output on the right side of an either.
      +
      static <C,B> F<C,Option<B>>sequenceF(Option<F<C,B>> option) +
      Sequence the given option and collect the output as a function.
      +
      static <B> IO<Option<B>>sequenceIO(Option<IO<B>> option) +
      Sequence the given option and collect the output as an IO.
      +
      static <B> List<Option<B>>sequenceList(Option<List<B>> option) +
      Sequence the given option and collect the output as an list.
      +
      static <B> Option<Option<B>>sequenceOption(Option<Option<B>> option) +
      Sequence the given option and collect the output as an option.
      +
      static <B> P1<Option<B>>sequenceP1(Option<P1<B>> option) +
      Sequence the given option and collect the output as a P1.
      +
      static <B> Seq<Option<B>>sequenceSeq(Option<Seq<B>> option) +
      Sequence the given option and collect the output as a seq.
      +
      static <B> Set<Option<B>>sequenceSet(Ord<B> ord, + Option<Set<B>> option) +
      Sequence the given option and collect the output as a set; use the given ord to order the set.
      +
      static <B> Stream<Option<B>>sequenceStream(Option<Stream<B>> option) +
      Sequence the given option and collect the output as a stream.
      +
      static <B> Trampoline<Option<B>>sequenceTrampoline(Option<Trampoline<B>> option) +
      Sequence the given option and collect the output as a trampoline.
      +
      static <E,B> Validation<E,Option<B>>sequenceValidation(Option<Validation<E,B>> option) +
      Sequence the given option and collect the output as a validation.
      +
      static <T> F<T,Option<T>>some_() 
      abstract Asome() +
      Returns the value from this optional value, or fails if there is no value.
      +
      static <T> Option<T>some(T t) +
      Constructs an optional value that has a value of the given argument.
      +
      static <A> List<A>somes(List<Option<A>> as) +
      Returns all the values in the given list.
      +
      static <A> Stream<A>somes(Stream<Option<A>> as) +
      Returns all the values in the given stream.
      +
      Array<A>toArray() +
      Returns an array projection of this optional value.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns an array projection of this optional value.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this optional value.
      +
      static <A,X> F<Option<A>,F<X,Either<X,A>>>toEither() +
      A first-class version of the toEither method.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      <X> Either<X,A>toEither(X x) +
      Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
      +
      List<A>toList() +
      Returns a list projection of this optional value.
      +
      AtoNull() +
      Returns the value from this optional value, or if there is no value, returns null.
      +
      Stream<A>toStream() +
      Returns a stream projection of this optional value.
      +
      java.lang.StringtoString() 
      <X> Validation<X,A>toValidation(X x) 
      <L,B> Either<L,Option<B>>traverseEither(F<A,Either<L,B>> f) +
      Traverse this option with the given function and collect the output on the right side of an either.
      +
      <R,B> Either<Option<B>,R>traverseEitherLeft(F<A,Either<B,R>> f) +
      Traverse this option with the given function and collect the output on the left side of an either.
      +
      <L,B> Either<L,Option<B>>traverseEitherRight(F<A,Either<L,B>> f) +
      Traverse this option with the given function and collect the output on the right side of an either.
      +
      <C,B> F<C,Option<B>>traverseF(F<A,F<C,B>> f) +
      Traverse this option with the given function and collect the output as a function.
      +
      <B> IO<Option<B>>traverseIO(F<A,IO<B>> f) +
      Traverse this option with the given function and collect the output as an IO.
      +
      <B> List<Option<B>>traverseList(F<A,List<B>> f) +
      Traverse this option with the given function and collect the output as a list.
      +
      <B> Option<Option<B>>traverseOption(F<A,Option<B>> f) +
      Traverse this option with the given function and collect the output as an option.
      +
      <B> P1<Option<B>>traverseP1(F<A,P1<B>> f) +
      Traverse this option with the given function and collect the output as a P1.
      +
      <B> Seq<Option<B>>traverseSeq(F<A,Seq<B>> f) +
      Traverse this option with the given function and collect the output a seq.
      +
      <B> F2<Ord<B>,F<A,Set<B>>,Set<Option<B>>>traverseSet() 
      <B> Set<Option<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) +
      Traverse this option with the given function and collect the output as a set; use the given ord to order the set.
      +
      <B> Stream<Option<B>>traverseStream(F<A,Stream<B>> f) +
      Traverse this option with the given function and collect the output as a stream.
      +
      <B> Trampoline<Option<B>>traverseTrampoline(F<A,Trampoline<B>> f) +
      Traverse this option with the given function and collect the output as a trampoline.
      +
      <E,B> Validation<E,Option<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traverse this option with the given function and collect the output as a validation.
      +
      AvalueE(F0<java.lang.String> message) +
      Returns the value of this optional value or fails with the given message.
      +
      AvalueE(java.lang.String message) +
      Returns the value of this optional value or fails with the given message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Option<java.lang.Byte>> parseByte
        +
        A function that parses a string to a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Option<java.lang.Double>> parseDouble
        +
        A function that parses a string to a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Option<java.lang.Float>> parseFloat
        +
        A function that parses a string to a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Option<java.lang.Integer>> parseInt
        +
        A function that parses a string to an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Option<java.lang.Long>> parseLong
        +
        A function that parses a string to a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Option<java.lang.Short>> parseShort
        +
        A function that parses a string to a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this optional value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some

        +
        public abstract A some()
        +
        Returns the value from this optional value, or fails if there is no value.
        +
        +
        Returns:
        +
        The value from this optional value, or fails if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        isSome

        +
        public final boolean isSome()
        +
        Returns true if this optional value has a value, false otherwise.
        +
        +
        Returns:
        +
        true if this optional value has a value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNone

        +
        public final boolean isNone()
        +
        Returns false if this optional value has a value, true otherwise.
        +
        +
        Returns:
        +
        false if this optional value has a value, true otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSome_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isSome_()
        +
        A first-class version of the isSome method.
        +
        +
        Returns:
        +
        A function that returns true if a given optional value has a value, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isNone_

        +
        public static <A> F<Option<A>,java.lang.Boolean> isNone_()
        +
        A first-class version of the isNone method.
        +
        +
        Returns:
        +
        A function that returns false if a given optional value has a value, otherwise true.
        +
        +
        • +
      + + + + + +
        +
      • +

        option

        +
        public final <B> B option(B b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        option

        +
        public final <B> B option(F0<B> b,
+                          F<A,B> f)
        +
        Performs a reduction on this optional value using the given arguments.
        +
        +
        Parameters:
        +
        b - The value to return if this optional value has no value.
        +
        f - The function to apply to the value of this optional value.
        +
        Returns:
        +
        A reduction on this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        Returns the length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        Returns:
        +
        The length of this optional value; 1 if there is a value, 0 otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        orSome

        +
        public final A orSome(F0<A> a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSome

        +
        public final A orSome(A a)
        +
        Returns the value of this optional value or the given argument.
        +
        +
        Parameters:
        +
        a - The argument to return if this optiona value has no value.
        +
        Returns:
        +
        The value of this optional value or the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(F0<java.lang.String> message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        valueE

        +
        public final A valueE(java.lang.String message)
        +
        Returns the value of this optional value or fails with the given message.
        +
        +
        Parameters:
        +
        message - The message to fail with if this optional value has no value.
        +
        Returns:
        +
        The value of this optional value if there there is one.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Option<B> map(F<A,B> f)
        +
        Maps the given function across this optional value.
        +
        +
        Parameters:
        +
        f - The function to map across this optional value.
        +
        Returns:
        +
        A new optional value after the given function has been applied to its element.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> F<F<A,B>,F<Option<A>,Option<B>>> map()
        +
        A first-class map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for the value of this optional value.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Option<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new optional value whose value matches the given predicate if it has one.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Option<B> bind(F<A,Option<B>> f)
        +
        Binds the given function across the element of this optional value with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this optional value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Option<C> bind(Option<B> ob,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Option<D> bind(Option<B> ob,
+                                    Option<C> oc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Option<E> bind(Option<B> ob,
+                                      Option<C> oc,
+                                      Option<D> od,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Option<F$> bind(Option<B> ob,
+                                          Option<C> oc,
+                                          Option<D> od,
+                                          Option<E> oe,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Option<G> bind(Option<B> ob,
+                                           Option<C> oc,
+                                           Option<D> od,
+                                           Option<E> oe,
+                                           Option<F$> of,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Option<H> bind(Option<B> ob,
+                                             Option<C> oc,
+                                             Option<D> od,
+                                             Option<E> oe,
+                                             Option<F$> of,
+                                             Option<G> og,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Option<I> bind(Option<B> ob,
+                                               Option<C> oc,
+                                               Option<D> od,
+                                               Option<E> oe,
+                                               Option<F$> of,
+                                               Option<G> og,
+                                               Option<H> oh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across the element of this optional value and the given optional value + with a final join.
        +
        +
        Parameters:
        +
        ob - A given optional value to bind the given function with.
        +
        oc - A given optional value to bind the given function with.
        +
        od - A given optional value to bind the given function with.
        +
        oe - A given optional value to bind the given function with.
        +
        of - A given optional value to bind the given function with.
        +
        og - A given optional value to bind the given function with.
        +
        oh - A given optional value to bind the given function with.
        +
        f - The function to apply to the element of this optional value and the given optional + value.
        +
        Returns:
        +
        A new optional value after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bindProduct

        +
        public final <B> Option<P2<A,B>> bindProduct(Option<B> ob)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequence

        +
        public final <B> Option<B> sequence(Option<B> o)
        +
        Performs a bind across the optional value, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        o - The optional value to apply in the final join.
        +
        Returns:
        +
        A new optional value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEither

        +
        public static final <L,B> Either<L,Option<B>> sequenceEither(Option<Either<L,B>> option)
        +
        Sequence the given option and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherLeft

        +
        public static final <R,B> Either<Option<B>,R> sequenceEitherLeft(Option<Either<B,R>> option)
        +
        Sequence the given option and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the right value
        +
        B - the type of the left value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherRight

        +
        public static final <L,B> Either<L,Option<B>> sequenceEitherRight(Option<Either<L,B>> option)
        +
        Sequence the given option and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceF

        +
        public static final <C,B> F<C,Option<B>> sequenceF(Option<F<C,B>> option)
        +
        Sequence the given option and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceIO

        +
        public static final <B> IO<Option<B>> sequenceIO(Option<IO<B>> option)
        +
        Sequence the given option and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static final <B> List<Option<B>> sequenceList(Option<List<B>> option)
        +
        Sequence the given option and collect the output as an list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceOption

        +
        public static final <B> Option<Option<B>> sequenceOption(Option<Option<B>> option)
        +
        Sequence the given option and collect the output as an option.
        +
        +
        Type Parameters:
        +
        B - the type of the option value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the option
        +
        +
        • +
      + + + +
        +
      • +

        sequenceP1

        +
        public static final <B> P1<Option<B>> sequenceP1(Option<P1<B>> option)
        +
        Sequence the given option and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        B - the type of the P1 value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSeq

        +
        public static final <B> Seq<Option<B>> sequenceSeq(Option<Seq<B>> option)
        +
        Sequence the given option and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSet

        +
        public static final <B> Set<Option<B>> sequenceSet(Ord<B> ord,
+                                                   Option<Set<B>> option)
        +
        Sequence the given option and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        option - the given option
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public static final <B> Stream<Option<B>> sequenceStream(Option<Stream<B>> option)
        +
        Sequence the given option and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceTrampoline

        +
        public static final <B> Trampoline<Option<B>> sequenceTrampoline(Option<Trampoline<B>> option)
        +
        Sequence the given option and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        option - the given trampoline
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static final <E,B> Validation<E,Option<B>> sequenceValidation(Option<Validation<E,B>> option)
        +
        Sequence the given option and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        option - the given option
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public final <L,B> Either<L,Option<B>> traverseEither(F<A,Either<L,B>> f)
        +
        Traverse this option with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherLeft

        +
        public final <R,B> Either<Option<B>,R> traverseEitherLeft(F<A,Either<B,R>> f)
        +
        Traverse this option with the given function and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherRight

        +
        public final <L,B> Either<L,Option<B>> traverseEitherRight(F<A,Either<L,B>> f)
        +
        Traverse this option with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public final <C,B> F<C,Option<B>> traverseF(F<A,F<C,B>> f)
        +
        Traverse this option with the given function and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <B> IO<Option<B>> traverseIO(F<A,IO<B>> f)
        +
        Traverse this option with the given function and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <B> List<Option<B>> traverseList(F<A,List<B>> f)
        +
        Traverse this option with the given function and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <B> Option<Option<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverse this option with the given function and collect the output as an option.
        +
        +
        Type Parameters:
        +
        B - the type of the option value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the option
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <B> P1<Option<B>> traverseP1(F<A,P1<B>> f)
        +
        Traverse this option with the given function and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        B - the type of the P1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public final <B> Seq<Option<B>> traverseSeq(F<A,Seq<B>> f)
        +
        Traverse this option with the given function and collect the output a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public final <B> Set<Option<B>> traverseSet(Ord<B> ord,
+                                            F<A,Set<B>> f)
        +
        Traverse this option with the given function and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        f - the given function
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <B> Stream<Option<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traverse this option with the given function and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        traverseTrampoline

        +
        public final <B> Trampoline<Option<B>> traverseTrampoline(F<A,Trampoline<B>> f)
        +
        Traverse this option with the given function and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the trampoline value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <E,B> Validation<E,Option<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traverse this option with the given function and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + + + + + +
        +
      • +

        apply

        +
        public final <B> Option<B> apply(Option<F<A,B>> of)
        +
        Performs function application within an optional value (applicative functor pattern).
        +
        +
        Parameters:
        +
        of - The optional value of functions to apply.
        +
        Returns:
        +
        A new optional value after applying the given optional value of functions through this + optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(F0<Option<A>> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        orElse

        +
        public final Option<A> orElse(Option<A> o)
        +
        Returns this optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        Parameters:
        +
        o - The optional value to return if this optional value has no value.
        +
        Returns:
        +
        This optional value if there is one, otherwise, returns the argument optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(X x)
        +
        Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this optional value has no value.
        +
        Returns:
        +
        An either projection of this optional value.
        +
        +
        • +
      + + + + + +
        +
      • +

        toValidation

        +
        public final <X> Validation<X,A> toValidation(X x)
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public static <A,X> F<Option<A>,F<X,Either<X,A>>> toEither()
        +
        A first-class version of the toEither method.
        +
        +
        Returns:
        +
        A function that returns an either projection of a given optional value, given a value to + return in left.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this optional value.
        +
        +
        Returns:
        +
        A list projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream projection of this optional value.
        +
        +
        Returns:
        +
        A stream projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns an array projection of this optional value.
        +
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns an array projection of this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array projection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this optional value.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        toNull

        +
        public final A toNull()
        +
        Returns the value from this optional value, or if there is no value, returns null. + This is intended for interfacing with APIs that expect a null for non-existence.
        +
        +
        Returns:
        +
        This optional value or null if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        Parameters:
        +
        f - the predicate function to test on the value of this optional value.
        +
        Returns:
        +
        true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this optional value.
        +
        +
        Returns:
        +
        An immutable collection of this optional value.
        +
        +
        • +
      + + + +
        +
      • +

        some_

        +
        public static <T> F<T,Option<T>> some_()
        +
        • +
      + + + + + +
        +
      • +

        some

        +
        public static <T> Option<T> some(T t)
        +
        Constructs an optional value that has a value of the given argument.
        +
        +
        Parameters:
        +
        t - The value for the returned optional value.
        +
        Returns:
        +
        An optional value that has a value of the given argument.
        +
        +
        • +
      + + + +
        +
      • +

        none_

        +
        public static <T> F<T,Option<T>> none_()
        +
        • +
      + + + +
        +
      • +

        none

        +
        public static <T> Option<T> none()
        +
        Constructs an optional value that has no value.
        +
        +
        Returns:
        +
        An optional value that has no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromNull

        +
        public static <T> Option<T> fromNull(T t)
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Parameters:
        +
        t - The unsafe nullable value.
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + +
        +
      • +

        fromNull

        +
        public static <T> F<T,Option<T>> fromNull()
        +
        Turns an unsafe nullable value into a safe optional value. If t == null then + return none, otherwise, return the given value in some.
        +
        +
        Returns:
        +
        If t == null then return none, otherwise, return it in some.
        +
        +
        • +
      + + + + + +
        +
      • +

        option_

        +
        public static final <A,B> F<Option<A>,B> option_(B none,
+                                                 F<A,B> some)
        +
        First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
        +
        +
        Parameters:
        +
        none - The value to return if this optional value has no value.
        +
        some - The function to apply to the value of this optional value.
        +
        Returns:
        +
        the reducing function.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Option<A> join(Option<Option<A>> o)
        +
        Joins the given optional value of optional value using a bind operation.
        +
        +
        Parameters:
        +
        o - The optional value of optional value to join.
        +
        Returns:
        +
        A new optional value that is the join of the given optional value.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Option<List<A>> sequence(List<Option<A>> a)
        +
        Sequence a list through the option monad.
        +
        +
        Parameters:
        +
        a - The list of option to sequence.
        +
        Returns:
        +
        The option of list after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <E,A> Option<Validation<E,A>> sequence(Validation<E,Option<A>> a)
        +
        Sequence a validation through the option monad.
        +
        +
        Parameters:
        +
        a - The validation of option to sequence.
        +
        Returns:
        +
        The option of validation after sequencing.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(F<A,java.lang.Boolean> f,
+                                A a)
        +
        Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        Parameters:
        +
        f - The predicate to test on the given argument.
        +
        a - The argument to test the predicate on and potentially use as the value of the returned + optional value.
        +
        Returns:
        +
        an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                F0<A> a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iif

        +
        public static <A> Option<A> iif(boolean p,
+                                A a)
        +
        Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        Parameters:
        +
        p - The value to be true to return the given value.
        +
        a - the value to return in an optional value if the given boolean is true.
        +
        Returns:
        +
        An optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
        +
        +
        • +
      + + + +
        +
      • +

        iif

        +
        public static <A> F2<F<A,java.lang.Boolean>,A,Option<A>> iif()
        +
        First-class version of the iif function.
        +
        +
        Returns:
        +
        a function that returns an optional value that has a value of the given argument, if the given predicate + holds on that argument, or no value otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> List<A> somes(List<Option<A>> as)
        +
        Returns all the values in the given list.
        +
        +
        Parameters:
        +
        as - The list of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given list.
        +
        +
        • +
      + + + +
        +
      • +

        somes

        +
        public static <A> Stream<A> somes(Stream<Option<A>> as)
        +
        Returns all the values in the given stream.
        +
        +
        Parameters:
        +
        as - The stream of potential values to get actual values from.
        +
        Returns:
        +
        All the values in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Option<java.lang.String> fromString(java.lang.String s)
        +
        Returns an optional non-empty string, or no value if the given string is empty.
        +
        +
        Parameters:
        +
        s - A string to turn into an optional non-empty string.
        +
        Returns:
        +
        an optional non-empty string, or no value if the given string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.String>> fromString()
        +
        Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        Returns:
        +
        a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
        +
        +
        • +
      + + + +
        +
      • +

        fromSome

        +
        public static <A> F<Option<A>,A> fromSome()
        +
        Returns a function that takes an optional value to a value or errors if there is no value.
        +
        +
        Returns:
        +
        A function that takes an optional value to a value or errors if there is no value.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public static <A,B,C> F<Option<A>,F<Option<B>,Option<C>>> liftM2(F<A,F<B,C>> f)
        +
        Promotes a function of arity-2 so that it operates over options.
        +
        +
        Parameters:
        +
        f - A function to promote.
        +
        Returns:
        +
        The given function promoted to operate on options.
        +
        +
        • +
      + + + +
        +
      • +

        liftM2

        +
        public final <B,C> Option<C> liftM2(Option<B> ob,
+                                    F2<A,B,C> f)
        +
        Lift the function of arity-2 through options.
        +
        +
        Parameters:
        +
        f - A function to lift.
        +
        Returns:
        +
        An optional result.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> F<F<A,Option<B>>,F<Option<A>,Option<B>>> bind()
        +
        First-class bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across an option with a final join.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Option<Option<A>>,Option<A>> join()
        +
        First-class join function.
        +
        +
        Returns:
        +
        A function that joins an Option of an Option to make a single Option.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/PriorityQueue.html b/javadoc/5.0/functionaljava/fj/data/PriorityQueue.html new file mode 100644 index 0000000..dc9d8af --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/PriorityQueue.html @@ -0,0 +1,643 @@ + + + + + +PriorityQueue (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class PriorityQueue<K,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.PriorityQueue<K,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class PriorityQueue<K,A>
+extends java.lang.Object
    +
    A priority queue implementation backed by a + FingerTree. The finger tree nodes are + annotated with type K, are combined using a monoid of K and both the + key and value are stored in the leaf. Priorities of the same value + are returned FIFO (first in, first out).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        priorityQueue

        +
        public static <K,A> PriorityQueue<K,A> priorityQueue(Equal<K> e,
+                                                     FingerTree<K,P2<K,A>> ft)
        +
        Creates a priority queue from a finger tree.
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <K,A> PriorityQueue<K,A> empty(Monoid<K> m,
+                                             Equal<K> e)
        +
        Creates an empty priority queue.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations.
        +
        e - A value to compare key equality.
        +
        +
        • +
      + + + +
        +
      • +

        emptyInt

        +
        public static <A> PriorityQueue<java.lang.Integer,A> emptyInt()
        +
        An empty priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> PriorityQueue<K,B> map(F<A,B> f)
        +
        Maps the values in each node with function f.
        +
        • +
      + + + +
        +
      • +

        filterValues

        +
        public PriorityQueue<K,A> filterValues(F<A,java.lang.Boolean> f)
        +
        Filters nodes based on the value inside each node.
        +
        • +
      + + + +
        +
      • +

        filterKeys

        +
        public PriorityQueue<K,A> filterKeys(F<K,java.lang.Boolean> f)
        +
        Filters the nodes based on the annotation of each node.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Is the tree empty?
        +
        • +
      + + + +
        +
      • +

        top

        +
        public Option<P2<K,A>> top()
        +
        If the tree is not empty, returns the node with highest priority otherwise returns nothing.
        +
        • +
      + + + +
        +
      • +

        topN

        +
        public List<P2<K,A>> topN()
        +
        Returns all the elements of the queue with the highest (same) priority.
        +
        • +
      + + + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(K k,
+                                  A a)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(List<P2<K,A>> list)
        +
        Adds nodes using the list of products with priority k and value a. This operation takes O(list.length()).
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Does the priority k exist already?
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(java.lang.Iterable<P2<K,A>> it)
        +
        Adds nodes using the iterable of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        enqueue

        +
        public PriorityQueue<K,A> enqueue(P2<K,A> p)
        +
        Adds a node with priority k and value a. This operation take O(1).
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue()
        +
        Removes the node with the highest priority.
        +
        • +
      + + + +
        +
      • +

        topDequeue

        +
        public P2<Option<P2<K,A>>,PriorityQueue<K,A>> topDequeue()
        +
        Returns a tuple of the node with the highest priority and the rest of the priority queue.
        +
        • +
      + + + + + +
        +
      • +

        unqueue

        +
        public <B> B unqueue(B empty,
+                     F2<P2<K,A>,PriorityQueue<K,A>,B> topDequeue)
        +
        Performs a reduction on this priority queue using the given arguments.
        +
        +
        Parameters:
        +
        empty - The value to return if this queue is empty.
        +
        topDequeue - The function to apply to the top priority element and the tail of the queue (without its top element).
        +
        Returns:
        +
        A reduction on this queue.
        +
        +
        • +
      + + + +
        +
      • +

        dequeue

        +
        public PriorityQueue<K,A> dequeue(int n)
        +
        Removes the top n elements with the highest priority.
        +
        • +
      + + + + + +
        +
      • +

        isLessThan

        +
        public boolean isLessThan(Ord<K> ok,
+                          K k)
        +
        Does the top of the queue have lower priority than k?
        +
        • +
      + + + + + +
        +
      • +

        isGreaterThan

        +
        public boolean isGreaterThan(Ord<K> ok,
+                             K k)
        +
        • +
      + + + + + +
        +
      • +

        isEqual

        +
        public boolean isEqual(Ord<K> ok,
+                       K k)
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,A>> toStream()
        +
        Returns a stream of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,A>> toList()
        +
        Returns a list of products with priority k and value a.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Reader.html b/javadoc/5.0/functionaljava/fj/data/Reader.html new file mode 100644 index 0000000..97b12e0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Reader.html @@ -0,0 +1,364 @@ + + + + + +Reader (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data
+

Class Reader<A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Reader<A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Reader<A,B>
+extends java.lang.Object
    +
    The Reader monad (also called the function monad, so equivalent to the idea of F).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Reader

        +
        public Reader(F<A,B> f)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFunction

        +
        public final F<A,B> getFunction()
        +
        • +
      + + + +
        +
      • +

        unit

        +
        public static <A,B> Reader<A,B> unit(F<A,B> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <A,B> Reader<A,B> constant(B b)
        +
        • +
      + + + + + +
        +
      • +

        f

        +
        public final B f(A a)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <C> Reader<A,C> map(F<B,C> f)
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        public final <C> Reader<A,C> andThen(F<B,C> f)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/SafeIO.html b/javadoc/5.0/functionaljava/fj/data/SafeIO.html new file mode 100644 index 0000000..1beeee4 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/SafeIO.html @@ -0,0 +1,265 @@ + + + + + +SafeIO (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Interface SafeIO<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IO<A>, Try0<A,java.io.IOException>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    +
    @FunctionalInterface
+public interface SafeIO<A>
+extends IO<A>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        A run()
        +
        +
        Specified by:
        +
        run in interface IO<A>
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        default A f()
        +
        +
        Specified by:
        +
        f in interface IO<A>
        +
        Specified by:
        +
        f in interface Try0<A,java.io.IOException>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Seq.html b/javadoc/5.0/functionaljava/fj/data/Seq.html new file mode 100644 index 0000000..8396c20 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Seq.html @@ -0,0 +1,1698 @@ + + + + + +Seq (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Seq<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Seq<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Seq<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an immutable finite sequence, implemented as a finger tree. This structure gives O(1) access to + the head and tail, as well as O(log n) random access and concatenation of sequences.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Seq<A>append(Seq<A> as) +
      Appends the given sequence to this sequence.
      +
      static <A> Seq<A>arraySeq(A... as) +
      Constructs a sequence from the array.
      +
      <B> Seq<B>bind(F<A,Seq<B>> f) +
      Bind the given function across this seq.
      +
      Seq<A>cons(A a) +
      Inserts the given element at the front of this sequence.
      +
      Seq<A>delete(int i) +
      Delete the element at the given index.
      +
      Seq<A>drop(int n) +
      Drops the given number of elements from the head of this sequence if they are available.
      +
      static <A> Seq<A>empty() +
      The empty sequence.
      +
      booleanequals(java.lang.Object other) 
      Seq<A>filter(F<A,java.lang.Boolean> f) 
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      static <A> Seq<A>fromJavaList(java.util.List<A> list) +
      Constructs a sequence from the given list.
      +
      inthashCode() 
      Ahead() +
      The first element of this sequence.
      +
      Option<A>headOption() 
      Aindex(int i) +
      Returns the element at the given index.
      +
      Seq<A>init() +
      The sequence without the last element.
      +
      Seq<A>insert(int index, + A a) +
      Inserts the element at the given index.
      +
      booleanisEmpty() +
      Checks if this is the empty sequence.
      +
      booleanisNotEmpty() +
      Checks if this sequence is not empty.
      +
      static <A> Seq<A>iterableSeq(java.lang.Iterable<A> i) +
      Constructs a sequence from the iterable.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this seq.
      +
      static <A> Seq<A>iteratorSeq(java.util.Iterator<A> i) +
      Constructs a sequence from the iterator.
      +
      Alast() +
      The last element of this sequence.
      +
      intlength() +
      Returns the number of elements in this sequence.
      +
      static <A> Seq<A>listSeq(List<A> list) +
      Constructs a sequence from the given list.
      +
      <B> Seq<B>map(F<A,B> f) 
      static <A> Seq<A>seq(A... as) +
      Constructs a sequence from the given elements.
      +
      static <L,B> Either<L,Seq<B>>sequenceEither(Seq<Either<L,B>> seq) +
      Sequence the given seq and collect the output on the right side of an either.
      +
      static <R,B> Either<Seq<B>,R>sequenceEitherLeft(Seq<Either<B,R>> seq) +
      Sequence the given seq and collect the output on the left side of an either.
      +
      static <L,B> Either<L,Seq<B>>sequenceEitherRight(Seq<Either<L,B>> seq) +
      Sequence the given seq and collect the output on the right side of an either.
      +
      static <C,B> F<C,Seq<B>>sequenceF(Seq<F<C,B>> seq) +
      Sequence the given seq and collect the output as a function.
      +
      static <B> IO<Seq<B>>sequenceIO(Seq<IO<B>> seq) +
      Sequence the given seq and collect the output as an IO.
      +
      static <B> List<Seq<B>>sequenceList(Seq<List<B>> seq) +
      Sequence the given seq and collect the output as a list.
      +
      static <B> Option<Seq<B>>sequenceOption(Seq<Option<B>> seq) +
      Sequence the given seq and collect the output as an seq.
      +
      static <B> P1<Seq<B>>sequenceP1(Seq<P1<B>> seq) +
      Sequence the given seq and collect the output as a P1.
      +
      static <B> Seq<Seq<B>>sequenceSeq(Seq<Seq<B>> seq) +
      Sequence the given seq and collect the output as a seq.
      +
      static <B> Set<Seq<B>>sequenceSet(Ord<B> ord, + Seq<Set<B>> seq) +
      Sequence the given seq and collect the output as a set; use the given ord to order the set.
      +
      static <B> Stream<Seq<B>>sequenceStream(Seq<Stream<B>> seq) +
      Sequence the given seq and collect the output as a stream.
      +
      static <B> Trampoline<Seq<B>>sequenceTrampoline(Seq<Trampoline<B>> seq) +
      Sequence the given seq and collect the output as a trampoline.
      +
      static <E,B> Validation<E,Seq<B>>sequenceValidation(Semigroup<E> semigroup, + Seq<Validation<E,B>> seq) +
      Sequence the given seq and collect the output as a validation; use the given semigroup to reduce the errors.
      +
      static <E,B> Validation<E,Seq<B>>sequenceValidation(Seq<Validation<E,B>> seq) +
      Sequence the given seq and collect the output as a validation.
      +
      static <A> Seq<A>single(A a) +
      A singleton sequence.
      +
      Seq<A>snoc(A a) +
      Inserts the given element at the end of this sequence.
      +
      P2<Seq<A>,Seq<A>>split(int i) +
      Splits this sequence into a pair of sequences at the given position.
      +
      Seq<A>tail() +
      The sequence without the first element.
      +
      Seq<A>take(int n) +
      Takes the given number of elements from the head of this sequence if they are available.
      +
      java.util.List<A>toJavaList() +
      Converts the sequence to a java.util.List
      +
      List<A>toList() +
      Converts this sequence to a List
      +
      Stream<A>toStream() +
      Converts this sequence to a Stream
      +
      java.lang.StringtoString() 
      <B,L> Either<L,Seq<B>>traverseEither(F<A,Either<L,B>> f) +
      Traverse this seq with the given function and collect the output on the right side of an either.
      +
      <R,B> Either<Seq<B>,R>traverseEitherLeft(F<A,Either<B,R>> f) +
      Traverse this seq with the given function and collect the output on the left side of an either.
      +
      <L,B> Either<L,Seq<B>>traverseEitherRight(F<A,Either<L,B>> f) +
      Traverse this seq with the given function and collect the output on the right side of an either.
      +
      <C,B> F<C,Seq<B>>traverseF(F<A,F<C,B>> f) +
      Traverse this seq with the given function and collect the output as a function.
      +
      <B> IO<Seq<B>>traverseIO(F<A,IO<B>> f) +
      Traverse this seq with the given function and collect the output as an IO.
      +
      <B> List<Seq<B>>traverseList(F<A,List<B>> f) +
      Traverse this seq with the given function and collect the output as a list.
      +
      <B> Option<Seq<B>>traverseOption(F<A,Option<B>> f) +
      Traverses through the Seq with the given function
      +
      <B> P1<Seq<B>>traverseP1(F<A,P1<B>> f) +
      Traverse this seq with the given function and collect the output as a p1.
      +
      <B> Seq<Seq<B>>traverseSeq(F<A,Seq<B>> f) +
      Traverse this seq with the given function and collect the output as a seq.
      +
      <B> Set<Seq<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) +
      Traverse this seq with the given function and collect the output as a set; use the given ord to order the set.
      +
      <B> Stream<Seq<B>>traverseStream(F<A,Stream<B>> f) +
      Traverse this seq with the given function and collect the output as a stream.
      +
      <B> Trampoline<Seq<B>>traverseTrampoline(F<A,Trampoline<B>> f) +
      Traverse this seq with the given function and collect the output as a trampoline.
      +
      <E,B> Validation<E,Seq<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traverse this seq with the given function and collect the output as a validation.
      +
      <E,B> Validation<E,Seq<B>>traverseValidation(Semigroup<E> semigroup, + F<A,Validation<E,B>> f) +
      Traverse this seq with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
      +
      Seq<A>update(int i, + A a) +
      Replace the element at the given index with the supplied value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <A> Seq<A> empty()
        +
        The empty sequence.
        +
        +
        Returns:
        +
        A sequence with no elements.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Seq<A> single(A a)
        +
        A singleton sequence.
        +
        +
        Parameters:
        +
        a - The single element in the sequence.
        +
        Returns:
        +
        A new sequence with the given element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        seq

        +
        @SafeVarargs
+public static <A> Seq<A> seq(A... as)
        +
        Constructs a sequence from the given elements.
        +
        +
        Parameters:
        +
        as - The elements to create the sequence from.
        +
        Returns:
        +
        A sequence with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        listSeq

        +
        public static <A> Seq<A> listSeq(List<A> list)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSeq

        +
        public static <A> Seq<A> iterableSeq(java.lang.Iterable<A> i)
        +
        Constructs a sequence from the iterable.
        +
        +
        Parameters:
        +
        i - The iterable to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSeq

        +
        public static <A> Seq<A> iteratorSeq(java.util.Iterator<A> i)
        +
        Constructs a sequence from the iterator.
        +
        +
        Parameters:
        +
        i - The iterator to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySeq

        +
        @SafeVarargs
+public static <A> Seq<A> arraySeq(A... as)
        +
        Constructs a sequence from the array.
        +
        • +
      + + + +
        +
      • +

        fromJavaList

        +
        public static <A> Seq<A> fromJavaList(java.util.List<A> list)
        +
        Constructs a sequence from the given list.
        +
        +
        Parameters:
        +
        list - The list to create the sequence from.
        +
        Returns:
        +
        A sequence with the elements of the list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public Seq<A> cons(A a)
        +
        Inserts the given element at the front of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the front of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public Seq<A> snoc(A a)
        +
        Inserts the given element at the end of this sequence.
        +
        +
        Parameters:
        +
        a - An element to insert at the end of this sequence.
        +
        Returns:
        +
        A new sequence with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        The first element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public Option<A> headOption()
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        The last element of this sequence. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public Seq<A> tail()
        +
        The sequence without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the first element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public Seq<A> init()
        +
        The sequence without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The sequence without the last element if this sequence is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Converts this sequence to a Stream
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<A> toList()
        +
        Converts this sequence to a List
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public java.util.List<A> toJavaList()
        +
        Converts the sequence to a java.util.List
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this seq. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this seq.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public Seq<A> append(Seq<A> as)
        +
        Appends the given sequence to this sequence.
        +
        +
        Parameters:
        +
        as - A sequence to append to this one.
        +
        Returns:
        +
        A new sequence with the given sequence appended to this one.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Checks if this is the empty sequence.
        +
        +
        Returns:
        +
        True if this sequence is empty, otherwise false.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public Seq<A> insert(int index,
+                     A a)
        +
        Inserts the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        index - The index of the element to return.
        +
        Returns:
        +
        The sequence with the element inserted at the given index, + or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public boolean isNotEmpty()
        +
        Checks if this sequence is not empty.
        +
        +
        Returns:
        +
        True if this sequence is not empty, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in this sequence.
        +
        +
        Returns:
        +
        the number of elements in this sequence.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public P2<Seq<A>,Seq<A>> split(int i)
        +
        Splits this sequence into a pair of sequences at the given position. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subsequence containing elements with indices less than i + and the subsequence containing elements with indices greater than or equal to i.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public A index(int i)
        +
        Returns the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to return.
        +
        Returns:
        +
        The element at the given index, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public Seq<A> update(int i,
+                     A a)
        +
        Replace the element at the given index with the supplied value. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        a - The new value.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Seq<A> delete(int i)
        +
        Delete the element at the given index. This is an O(log(n)) operation.
        +
        +
        Parameters:
        +
        i - The index of the element to update.
        +
        Returns:
        +
        The updated sequence, or throws an error if the index is out of bounds.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public Seq<A> take(int n)
        +
        Takes the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The maximum number of elements to take from this sequence.
        +
        Returns:
        +
        A sequence consisting only of the first n elements of this sequence, or else the whole sequence, + if it has less than n elements.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public Seq<A> drop(int n)
        +
        Drops the given number of elements from the head of this sequence if they are available.
        +
        +
        Parameters:
        +
        n - The number of elements to drop from this sequence.
        +
        Returns:
        +
        A sequence consisting of all elements of this sequence except the first n ones, or else the empty sequence, + if this sequence has less than n elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,A,B> f,
+                      B z)
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F2<A,B,B> f,
+                       B z)
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public Seq<A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Seq<B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Seq<B> bind(F<A,Seq<B>> f)
        +
        Bind the given function across this seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEither

        +
        public static <L,B> Either<L,Seq<B>> sequenceEither(Seq<Either<L,B>> seq)
        +
        Sequence the given seq and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherLeft

        +
        public static <R,B> Either<Seq<B>,R> sequenceEitherLeft(Seq<Either<B,R>> seq)
        +
        Sequence the given seq and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the right value
        +
        B - the type of the left value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherRight

        +
        public static <L,B> Either<L,Seq<B>> sequenceEitherRight(Seq<Either<L,B>> seq)
        +
        Sequence the given seq and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceF

        +
        public static <C,B> F<C,Seq<B>> sequenceF(Seq<F<C,B>> seq)
        +
        Sequence the given seq and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceIO

        +
        public static <B> IO<Seq<B>> sequenceIO(Seq<IO<B>> seq)
        +
        Sequence the given seq and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static <B> List<Seq<B>> sequenceList(Seq<List<B>> seq)
        +
        Sequence the given seq and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceOption

        +
        public static <B> Option<Seq<B>> sequenceOption(Seq<Option<B>> seq)
        +
        Sequence the given seq and collect the output as an seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceP1

        +
        public static <B> P1<Seq<B>> sequenceP1(Seq<P1<B>> seq)
        +
        Sequence the given seq and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        B - the type of the P1 value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSeq

        +
        public static <B> Seq<Seq<B>> sequenceSeq(Seq<Seq<B>> seq)
        +
        Sequence the given seq and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSet

        +
        public static <B> Set<Seq<B>> sequenceSet(Ord<B> ord,
+                                          Seq<Set<B>> seq)
        +
        Sequence the given seq and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        seq - the given seq
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public static <B> Stream<Seq<B>> sequenceStream(Seq<Stream<B>> seq)
        +
        Sequence the given seq and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceTrampoline

        +
        public static <B> Trampoline<Seq<B>> sequenceTrampoline(Seq<Trampoline<B>> seq)
        +
        Sequence the given seq and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        seq - the given trampoline
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static <E,B> Validation<E,Seq<B>> sequenceValidation(Seq<Validation<E,B>> seq)
        +
        Sequence the given seq and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        seq - the given seq
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static <E,B> Validation<E,Seq<B>> sequenceValidation(Semigroup<E> semigroup,
+                                                            Seq<Validation<E,B>> seq)
        +
        Sequence the given seq and collect the output as a validation; use the given semigroup to reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        semigroup - the given semigroup
        +
        seq - the given seq
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public <B,L> Either<L,Seq<B>> traverseEither(F<A,Either<L,B>> f)
        +
        Traverse this seq with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherLeft

        +
        public <R,B> Either<Seq<B>,R> traverseEitherLeft(F<A,Either<B,R>> f)
        +
        Traverse this seq with the given function and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherRight

        +
        public <L,B> Either<L,Seq<B>> traverseEitherRight(F<A,Either<L,B>> f)
        +
        Traverse this seq with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public <C,B> F<C,Seq<B>> traverseF(F<A,F<C,B>> f)
        +
        Traverse this seq with the given function and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <B> IO<Seq<B>> traverseIO(F<A,IO<B>> f)
        +
        Traverse this seq with the given function and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <B> List<Seq<B>> traverseList(F<A,List<B>> f)
        +
        Traverse this seq with the given function and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public <B> Option<Seq<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverses through the Seq with the given function
        +
        +
        Parameters:
        +
        f - The function that produces Option value
        +
        Returns:
        +
        none if applying f returns none to any element of the seq or f mapped seq in some .
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <B> P1<Seq<B>> traverseP1(F<A,P1<B>> f)
        +
        Traverse this seq with the given function and collect the output as a p1.
        +
        +
        Type Parameters:
        +
        B - the type of the p1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the p1
        +
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public <B> Seq<Seq<B>> traverseSeq(F<A,Seq<B>> f)
        +
        Traverse this seq with the given function and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public <B> Set<Seq<B>> traverseSet(Ord<B> ord,
+                                   F<A,Set<B>> f)
        +
        Traverse this seq with the given function and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        f - the given function
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public <B> Stream<Seq<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traverse this seq with the given function and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        traverseTrampoline

        +
        public <B> Trampoline<Seq<B>> traverseTrampoline(F<A,Trampoline<B>> f)
        +
        Traverse this seq with the given function and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the trampoline value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public <E,B> Validation<E,Seq<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traverse this seq with the given function and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public <E,B> Validation<E,Seq<B>> traverseValidation(Semigroup<E> semigroup,
+                                                     F<A,Validation<E,B>> f)
        +
        Traverse this seq with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        semigroup - the given semigroup
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Set.html b/javadoc/5.0/functionaljava/fj/data/Set.html new file mode 100644 index 0000000..e0f1063 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Set.html @@ -0,0 +1,1318 @@ + + + + + +Set (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Set<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Set<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Set<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides an in-memory, immutable set, implemented as a red/black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> Set<A>arraySet(Ord<A> o, + A... as) +
      Return the elements of the given iterator as a set.
      +
      <B> Set<B>bind(Ord<B> o, + F<A,Set<B>> f) +
      Binds the given function across this set.
      +
      F<A,F<Set<A>,Set<A>>>delete() +
      First-class deletion function.
      +
      Set<A>delete(A a) +
      Deletes the given element from this set.
      +
      static <A> Set<A>empty(Ord<A> ord) +
      The empty set.
      +
      booleanequals(java.lang.Object other) 
      Set<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this Set using the given monoid.
      +
      <B> BfoldMapRight(F<A,B> f, + Monoid<B> m) +
      Folds this Set from the right using the given monoid.
      +
      inthashCode() 
      static <A> F<A,F<Set<A>,Set<A>>>insert() +
      First-class insertion function.
      +
      Set<A>insert(A x) +
      Inserts the given element into this set.
      +
      static <A> F<Set<A>,F<Set<A>,Set<A>>>intersect() +
      A first class function for intersect(Set).
      +
      Set<A>intersect(Set<A> s) +
      Remove all elements from this set that do not occur in the given set.
      +
      booleanisEmpty() 
      static <A> Set<A>iterableSet(Ord<A> o, + java.lang.Iterable<A> as) +
      Return the elements of the given iterable as a set.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator over this set.
      +
      static <A> Set<A>iteratorSet(Ord<A> o, + java.util.Iterator<A> as) +
      Return the elements of the given iterator as a set.
      +
      static <A> Set<A>join(Ord<A> o, + Set<Set<A>> s) +
      Join a set of sets into a single set.
      +
      Option<A>lookup(A a) +
      Find element equal to the given one.
      +
      Option<A>lookupGE(A a) +
      Find smallest element greater or equal to the given one.
      +
      Option<A>lookupGT(A a) +
      Find smallest element greater than the given one.
      +
      Option<A>lookupLE(A a) +
      Find largest element smaller or equal to the given one.
      +
      Option<A>lookupLT(A a) +
      Find largest element smaller than the given one.
      +
      <B> Set<B>map(Ord<B> o, + F<A,B> f) +
      Maps the given function across this set.
      +
      Option<A>max() 
      static <A> F<Set<A>,F<A,java.lang.Boolean>>member() +
      First-class membership check.
      +
      booleanmember(A x) +
      Checks if the given element is a member of this set.
      +
      Option<A>min() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>minus() +
      A first class function for minus(Set).
      +
      Set<A>minus(Set<A> s) +
      Remove all elements from this set that occur in the given set.
      +
      Ord<A>ord() +
      Returns the order of this Set.
      +
      static <A> Set<A>set(Ord<A> o, + A... as) +
      Constructs a set from the given elements.
      +
      static <A> Set<A>single(Ord<A> o, + A a) +
      Returns a set with a single element.
      +
      intsize() +
      Returns the size of this set.
      +
      P3<Set<A>,Option<A>,Set<A>>split(A a) +
      Splits this set at the given element.
      +
      booleansubsetOf(Set<A> s) +
      Returns true if this set is a subset of the given set.
      +
      java.util.HashSet<A>toJavaHashSet() +
      Returns a java.util.HashSet representation of this set.
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List representation of this set.
      +
      java.util.Set<A>toJavaSet() +
      Returns a java.util.Set representation of this set.
      +
      java.util.TreeSet<A>toJavaTreeSet() +
      Returns a java.util.TreeSet representation of this set.
      +
      List<A>toList() +
      Returns a list representation of this set.
      +
      List<A>toListReverse() +
      Returns a list representation of this set in reverse order.
      +
      Stream<A>toStream() +
      Returns a stream representation of this set.
      +
      Stream<A>toStreamReverse() +
      Returns a stream representation of this set in reverse order.
      +
      java.lang.StringtoString() 
      static <A> F<Set<A>,F<Set<A>,Set<A>>>union() +
      A first class function for union(Set).
      +
      Set<A>union(Set<A> s) +
      Add all the elements of the given set to this set.
      +
      P2<java.lang.Boolean,Set<A>>update(A a, + F<A,A> f) +
      Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public final Ord<A> ord()
        +
        Returns the order of this Set.
        +
        +
        Returns:
        +
        the order of this Set.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public final P2<java.lang.Boolean,Set<A>> update(A a,
+                                                 F<A,A> f)
        +
        Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
        +
        +
        Parameters:
        +
        a - An element to replace.
        +
        f - A function to transforms the found element.
        +
        Returns:
        +
        A pair of: (1) True if an element was found that matches the given element, otherwise false. + (2) A new set with the given function applied to the first set element + that was equal to the given element.
        +
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <A> Set<A> empty(Ord<A> ord)
        +
        The empty set.
        +
        +
        Parameters:
        +
        ord - An order for the type of elements.
        +
        Returns:
        +
        the empty set.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        member

        +
        public final boolean member(A x)
        +
        Checks if the given element is a member of this set.
        +
        +
        Parameters:
        +
        x - An element to check for membership in this set.
        +
        Returns:
        +
        true if the given element is a member of this set.
        +
        +
        • +
      + + + +
        +
      • +

        member

        +
        public static <A> F<Set<A>,F<A,java.lang.Boolean>> member()
        +
        First-class membership check.
        +
        +
        Returns:
        +
        A function that returns true if the given element if a member of the given set.
        +
        +
        • +
      + + + + + +
        +
      • +

        insert

        +
        public final Set<A> insert(A x)
        +
        Inserts the given element into this set.
        +
        +
        Parameters:
        +
        x - An element to insert into this set.
        +
        Returns:
        +
        A new set with the given element inserted.
        +
        +
        • +
      + + + +
        +
      • +

        insert

        +
        public static <A> F<A,F<Set<A>,Set<A>>> insert()
        +
        First-class insertion function.
        +
        +
        Returns:
        +
        A function that inserts a given element into a given set.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator over this set.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator over this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Set<A> single(Ord<A> o,
+                                A a)
        +
        Returns a set with a single element.
        +
        +
        Parameters:
        +
        o - An order for the type of element.
        +
        a - An element to put in a set.
        +
        Returns:
        +
        A new set with the given element in it.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Set<B> map(Ord<B> o,
+                            F<A,B> f)
        +
        Maps the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        f - A function to map across this set.
        +
        Returns:
        +
        The set of the results of applying the given function to the elements of this set.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public final <B> B foldMap(F<A,B> f,
+                           Monoid<B> m)
        +
        Folds this Set using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        foldMapRight

        +
        public final <B> B foldMapRight(F<A,B> f,
+                                Monoid<B> m)
        +
        Folds this Set from the right using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this Set's elements, to the monoid.
        +
        m - The monoid to fold this Set with.
        +
        Returns:
        +
        The result of folding the Set from the right with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list representation of this set.
        +
        +
        Returns:
        +
        a list representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaSet

        +
        public final java.util.Set<A> toJavaSet()
        +
        Returns a java.util.Set representation of this set.
        +
        +
        Returns:
        +
        a java.util.Set representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaHashSet

        +
        public final java.util.HashSet<A> toJavaHashSet()
        +
        Returns a java.util.HashSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.HashSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaTreeSet

        +
        public final java.util.TreeSet<A> toJavaTreeSet()
        +
        Returns a java.util.TreeSet representation of this set.
        +
        +
        Returns:
        +
        a java.util.TreeSet representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List representation of this set.
        +
        +
        Returns:
        +
        a java.util.List representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public final List<A> toListReverse()
        +
        Returns a list representation of this set in reverse order.
        +
        +
        Returns:
        +
        a list representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<A> toStream()
        +
        Returns a stream representation of this set.
        +
        +
        Returns:
        +
        a stream representation of this set.
        +
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public final Stream<A> toStreamReverse()
        +
        Returns a stream representation of this set in reverse order.
        +
        +
        Returns:
        +
        a stream representation of this set in reverse order.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Set<B> bind(Ord<B> o,
+                             F<A,Set<B>> f)
        +
        Binds the given function across this set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the target set.
        +
        f - A function to bind across this set.
        +
        Returns:
        +
        A new set after applying the given function and joining the resulting sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public final Set<A> union(Set<A> s)
        +
        Add all the elements of the given set to this set.
        +
        +
        Parameters:
        +
        s - A set to add to this set.
        +
        Returns:
        +
        A new set containing all elements of both sets.
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> union()
        +
        A first class function for union(Set).
        +
        +
        Returns:
        +
        A function that adds all the elements of one set to another set.
        +
        See Also:
        +
        union(Set)
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Set<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new set whose elements all match the given predicate.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public final Set<A> delete(A a)
        +
        Deletes the given element from this set.
        +
        +
        Parameters:
        +
        a - an element to remove.
        +
        Returns:
        +
        A new set containing all the elements of this set, except the given element.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public final F<A,F<Set<A>,Set<A>>> delete()
        +
        First-class deletion function.
        +
        +
        Returns:
        +
        A function that deletes a given element from a given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public final Set<A> intersect(Set<A> s)
        +
        Remove all elements from this set that do not occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to retain.
        +
        Returns:
        +
        A new set which is the intersection of this set and the given set.
        +
        +
        • +
      + + + +
        +
      • +

        intersect

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> intersect()
        +
        A first class function for intersect(Set).
        +
        +
        Returns:
        +
        A function that intersects two given sets.
        +
        See Also:
        +
        intersect(Set)
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Set<A> minus(Set<A> s)
        +
        Remove all elements from this set that occur in the given set.
        +
        +
        Parameters:
        +
        s - A set of elements to delete.
        +
        Returns:
        +
        A new set which contains only the elements of this set that do not occur in the given set.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public static <A> F<Set<A>,F<Set<A>,Set<A>>> minus()
        +
        A first class function for minus(Set).
        +
        +
        Returns:
        +
        A function that removes all elements of one set from another set.
        +
        See Also:
        +
        minus(Set)
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public final Option<A> min()
        +
        • +
      + + + +
        +
      • +

        max

        +
        public final Option<A> max()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public final int size()
        +
        Returns the size of this set.
        +
        +
        Returns:
        +
        The number of elements in this set.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public final P3<Set<A>,Option<A>,Set<A>> split(A a)
        +
        Splits this set at the given element. Returns a product-3 of: +
          +
        • A set containing all the elements of this set which are less than the given value.
          • +
        • An option of a value equal to the given value, if one was found in this set, otherwise None. +
        • A set containing all the elements of this set which are greater than the given value.
          • +
        +
        +
        Parameters:
        +
        a - A value at which to split this set.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are less than the given value + and all the elements in the second set are greater than the given value, and the optional value is the + given value if found, otherwise None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookup

        +
        public final Option<A> lookup(A a)
        +
        Find element equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some element in this set equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLT

        +
        public final Option<A> lookupLT(A a)
        +
        Find largest element smaller than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGT

        +
        public final Option<A> lookupGT(A a)
        +
        Find smallest element greater than the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater than the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupLE

        +
        public final Option<A> lookupLE(A a)
        +
        Find largest element smaller or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some largest element in this set smaller or equal to the given one, or None.
        +
        +
        • +
      + + + + + +
        +
      • +

        lookupGE

        +
        public final Option<A> lookupGE(A a)
        +
        Find smallest element greater or equal to the given one.
        +
        +
        Parameters:
        +
        a - An element to compare with.
        +
        Returns:
        +
        Some smallest element in this set greater or equal to the given one, or None.
        +
        +
        • +
      + + + +
        +
      • +

        subsetOf

        +
        public final boolean subsetOf(Set<A> s)
        +
        Returns true if this set is a subset of the given set.
        +
        +
        Parameters:
        +
        s - A set which is a superset of this set if this method returns true.
        +
        Returns:
        +
        true if this set is a subset of the given set.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Set<A> join(Ord<A> o,
+                              Set<Set<A>> s)
        +
        Join a set of sets into a single set.
        +
        +
        Parameters:
        +
        s - A set of sets.
        +
        o - An order for the elements of the new set.
        +
        Returns:
        +
        A new set which is the join of the given set of sets.
        +
        +
        • +
      + + + +
        +
      • +

        iterableSet

        +
        public static <A> Set<A> iterableSet(Ord<A> o,
+                                     java.lang.Iterable<A> as)
        +
        Return the elements of the given iterable as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterable of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorSet

        +
        public static <A> Set<A> iteratorSet(Ord<A> o,
+                                     java.util.Iterator<A> as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        arraySet

        +
        @SafeVarargs
+public static <A> Set<A> arraySet(Ord<A> o,
+                                                A... as)
        +
        Return the elements of the given iterator as a set.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - An iterator of elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterator.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        @SafeVarargs
+public static <A> Set<A> set(Ord<A> o,
+                                           A... as)
        +
        Constructs a set from the given elements.
        +
        +
        Parameters:
        +
        o - An order for the elements of the new set.
        +
        as - The elements to add to a set.
        +
        Returns:
        +
        A new set containing the elements of the given iterable.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/State.html b/javadoc/5.0/functionaljava/fj/data/State.html new file mode 100644 index 0000000..280998a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/State.html @@ -0,0 +1,512 @@ + + + + + +State (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class State<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.State<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class State<S,A>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public static <S,A> State<S,A> unit(F<S,P2<S,A>> runF)
        +
        • +
      + + + +
        +
      • +

        init

        +
        public static <S> State<S,S> init()
        +
        • +
      + + + +
        +
      • +

        units

        +
        public static <S> State<S,S> units(F<S,S> f)
        +
        • +
      + + + + + +
        +
      • +

        constant

        +
        public static <S,A> State<S,A> constant(A a)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public static <S,A> State<S,A> gets(F<S,A> f)
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public static <S> State<S,Unit> put(S s)
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public static <S> State<S,Unit> modify(F<S,S> f)
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public static <S,A,B> State<S,B> flatMap(State<S,A> ts,
+                                         F<A,State<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <S,A> State<S,List<A>> sequence(List<State<S,A>> list)
        +
        Evaluate each action in the sequence from left to right, and collect the results.
        +
        • +
      + + + +
        +
      • +

        traverse

        +
        public static <S,A,B> State<S,List<B>> traverse(List<A> list,
+                                                F<A,State<S,B>> f)
        +
        Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
        +
        • +
      + + + + + +
        +
      • +

        run

        +
        public P2<S,A> run(S s)
        +
        • +
      + + + + + +
        +
      • +

        eval

        +
        public A eval(S s)
        +
        • +
      + + + + + +
        +
      • +

        exec

        +
        public S exec(S s)
        +
        • +
      + + + +
        +
      • +

        gets

        +
        public State<S,S> gets()
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> State<S,B> map(F<A,B> f)
        +
        • +
      + + + +
        +
      • +

        mapState

        +
        public <B> State<S,B> mapState(F<P2<S,A>,P2<S,B>> f)
        +
        • +
      + + + +
        +
      • +

        withs

        +
        public State<S,A> withs(F<S,S> f)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> State<S,B> bind(F<A,State<S,B>> f)
        +
        Bind the given function across this state.
        +
        +
        Type Parameters:
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the state
        +
        +
        • +
      + + + +
        +
      • +

        flatMap

        +
        public <B> State<S,B> flatMap(F<A,State<S,B>> f)
        +
        Bind the given function across this state.
        +
        +
        Type Parameters:
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the state
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Stream.html b/javadoc/5.0/functionaljava/fj/data/Stream.html new file mode 100644 index 0000000..ed71735 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Stream.html @@ -0,0 +1,3864 @@ + + + + + +Stream (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Stream<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Stream<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public abstract class Stream<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A lazy (not yet evaluated), immutable, singly linked list.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Stream<A>append(F0<Stream<A>> as) +
      Appends the given stream to this stream.
      +
      Stream<A>append(Stream<A> as) +
      Appends the given stream to this stream.
      +
      <B> Stream<B>apply(Stream<F<A,B>> sf) +
      Performs function application within a stream (applicative functor pattern).
      +
      A[]array(java.lang.Class<A[]> c) +
      Returns an array from this stream.
      +
      static <A> Stream<A>arrayStream(A... as) 
      static java.lang.StringasString(Stream<java.lang.Character> cs) +
      Returns a string from the given stream of characters.
      +
      static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>>bind_() +
      A first-class version of the bind function.
      +
      <B> Stream<B>bind(F<A,Stream<B>> f) +
      Binds the given function across each element of this stream with a final join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F<A,F<B,C>> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C> Stream<C>bind(Stream<B> sb, + F2<A,B,C> f) +
      Binds the given function across each element of this stream and the given stream with a final + join.
      +
      <B,C,D> Stream<D>bind(Stream<B> sb, + Stream<C> sc, + F<A,F<B,F<C,D>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E> Stream<E>bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + F<A,F<B,F<C,F<D,E>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$>
      Stream<F$>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + F<A,F<B,F<C,F<D,F<E,F$>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G>
      Stream<G>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H>
      Stream<H>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B,C,D,E,F$,G,H,I>
      Stream<I>      		bind(Stream<B> sb, + Stream<C> sc, + Stream<D> sd, + Stream<E> se, + Stream<F$> sf, + Stream<G> sg, + Stream<H> sh, + F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f) +
      Binds the given function across each element of this stream and the given streams with a final + join.
      +
      <B> Stream<B>cobind(F<Stream<A>,B> k) +
      Binds the given function across the stream of substreams of this stream.
      +
      static <A> F<A,F<Stream<A>,Stream<A>>>cons_() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      static <A> F<A,F<P1<Stream<A>>,Stream<A>>>cons() +
      Returns a function that prepends (cons) an element to a stream to produce a new stream.
      +
      Stream<A>cons(A a) +
      Prepends (cons) the given element to this stream to product a new stream.
      +
      static <A> Stream<A>cons(A head, + F0<Stream<A>> tail) +
      Prepends the given head element to the given tail element to produce a new stream.
      +
      static <A> Stream<A>cycle(Stream<A> as) +
      Returns an infinite-length stream of the given elements cycling.
      +
      Stream<A>drop(int i) +
      Drops the given number of elements from the head of this stream if they are available.
      +
      Stream<A>dropWhile(F<A,java.lang.Boolean> f) +
      Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
      +
      static <A> Stream<A>enumerationStream(java.util.Enumeration<A> e) 
      booleanequals(java.lang.Object other) 
      booleanexists(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
      +
      static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>>filter() +
      Returns a first-class version of the filter function.
      +
      Stream<A>filter(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
      +
      Option<A>find(F<A,java.lang.Boolean> f) +
      Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
      +
      <B> BfoldLeft(F<B,F<A,B>> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B b) +
      Performs a left-fold reduction across this stream.
      +
      AfoldLeft1(F<A,F<A,A>> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      AfoldLeft1(F2<A,A,A> f) +
      Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
      +
      static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>>foldRight() +
      A first-class version of the foldRight function.
      +
      <B> BfoldRight(F<A,F<P1<B>,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight(F2<A,P1<B>,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F<A,F<B,B>> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      <B> BfoldRight1(F2<A,B,B> f, + B b) +
      Performs a right-fold reduction across this stream.
      +
      booleanforall(F<A,java.lang.Boolean> f) +
      Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
      +
      Unitforeach(F<A,Unit> f) +
      Performs a side-effect for each element of this stream.
      +
      voidforeachDoEffect(Effect1<A> f) +
      Performs a side-effect for each element of this stream.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
      +
      static <A> Stream<A>forever(Enumerator<A> e, + A from, + long step) +
      Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
      +
      static <A,B> Stream<A>fromFunction(Enumerator<B> e, + F<B,A> f, + B i) +
      Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
      +
      static <A> Stream<A>fromFunction(F<Natural,A> f) +
      Converts a function of natural numbers to a stream.
      +
      static Stream<java.lang.Character>fromString(java.lang.String s) +
      Returns a stream of characters from the given string.
      +
      inthashCode() 
      abstract Ahead() +
      The first element of the stream or fails for the empty stream.
      +
      Aindex(int i) +
      Returns the element at the given index if it exists, fails otherwise.
      +
      Option<java.lang.Integer>indexOf(F<A,java.lang.Boolean> p) +
      Returns the position of the first element matching the given predicate, if any.
      +
      Stream<Stream<A>>inits() +
      Returns a stream of all prefixes of this stream.
      +
      Stream<A>interleave(Stream<A> as) +
      Interleaves the given stream with this stream to produce a new stream.
      +
      Stream<A>intersperse(A a) +
      Intersperses the given value between each two elements of the stream.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isEmpty_() +
      Returns a function that determines whether a given stream is empty.
      +
      booleanisEmpty() +
      Returns true if this stream is empty, false otherwise.
      +
      static <A> F<Stream<A>,java.lang.Boolean>isNotEmpty_() +
      Returns a function that determines whether a given stream is not empty.
      +
      booleanisNotEmpty() +
      Returns false if this stream is empty, true otherwise.
      +
      static <A> Stream<A>iterableStream(java.lang.Iterable<A> i) +
      Takes the given iterable to a stream.
      +
      static <A> F<F<A,A>,F<A,Stream<A>>>iterate() +
      A first-class version of the iterate function.
      +
      static <A> Stream<A>iterate(F<A,A> f, + A a) +
      Returns a stream constructed by applying the given iteration function starting at the given value.
      +
      static <A> Stream<A>iterateWhile(F<A,A> f, + F<A,java.lang.Boolean> p, + A a) +
      Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for this stream.
      +
      static <A> Stream<A>iteratorStream(java.util.Iterator<A> it) +
      Constructs a stream with the given elements in the Iterator.
      +
      static <A> F<Stream<Stream<A>>,Stream<A>>join() +
      A first-class version of join
      +
      static <A> Stream<A>join(Stream<Stream<A>> o) +
      Joins the given stream of streams by concatenation.
      +
      Alast() +
      Get the last element of this stream.
      +
      intlength() +
      The length of this stream.
      +
      static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>>map_() +
      Provides a first-class version of the map function.
      +
      <B> Stream<B>map(F<A,B> f) +
      Maps the given function across this stream.
      +
      <B,C> F<B,Stream<C>>mapM(F<A,F<B,C>> f) +
      Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
      +
      Stream<A>minus(Equal<A> eq, + Stream<A> xs) +
      Returns a new stream of all the items in this stream that do not appear in the given stream.
      +
      static <A> P1<Stream<A>>nil_() +
      Returns an empty stream.
      +
      static <A> Stream<A>nil() +
      Returns an empty stream.
      +
      AorHead(F0<A> a) +
      Returns the head of this stream if there is one or the given argument if this stream is empty.
      +
      P1<Stream<A>>orTail(F0<Stream<A>> as) +
      Returns the tail of this stream if there is one or the given argument if this stream is empty.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
      +
      static <A> Stream<A>range(Enumerator<A> e, + A from, + A to, + long step) +
      Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
      +
      static Stream<java.lang.Integer>range(int from) +
      Returns an infinite stream of integers from the given from value (inclusive).
      +
      static Stream<java.lang.Integer>range(int from, + long to) +
      Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
      +
      Stream<A>removeAll(F<A,java.lang.Boolean> f) +
      Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
      +
      static <A> Stream<A>repeat(A a) +
      Returns an infinite-length stream of the given element.
      +
      Stream<A>replace(F<A,java.lang.Boolean> p, + A a) +
      Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
      +
      Stream<A>reverse() +
      Reverse this stream in constant stack space.
      +
      static <A,B> F<B,Stream<A>>sequence_(Stream<F<B,A>> fs) +
      Turn a stream of functions into a function returning a stream.
      +
      static <A> Stream<P1<A>>sequence(F0<Stream<A>> p) +
      Sequence through the Stream monad.
      +
      static <A> Stream<IO<A>>sequence(IO<Stream<A>> io) +
      Sequence through the Stream monad.
      +
      static <A> Stream<Option<A>>sequence(Option<Stream<A>> o) +
      Sequence through the Stream monad.
      +
      <B> Stream<B>sequence(Stream<B> bs) +
      Performs a bind across each stream element, but ignores the element value each time.
      +
      static <L,B> Either<L,Stream<B>>sequenceEither(Stream<Either<L,B>> stream) +
      Sequence the given stream and collect the output on the right side of an either.
      +
      static <R,B> Either<Stream<B>,R>sequenceEitherLeft(Stream<Either<B,R>> stream) +
      Sequence the given stream and collect the output on the left side of an either.
      +
      static <L,B> Either<L,Stream<B>>sequenceEitherRight(Stream<Either<L,B>> stream) +
      Sequence the given stream and collect the output on the right side of an either.
      +
      static <C,B> F<C,Stream<B>>sequenceF(Stream<F<C,B>> stream) +
      Sequence the given stream and collect the output as a function.
      +
      static <B> IO<Stream<B>>sequenceIO(Stream<IO<B>> stream) +
      Sequence the given stream and collect the output as an IO.
      +
      static <B> List<Stream<B>>sequenceList(Stream<List<B>> stream) +
      Sequence the given stream and collect the output as a list.
      +
      static <B> Option<Stream<B>>sequenceOption(Stream<Option<B>> stream) +
      Sequence the given stream and collect the output as an stream.
      +
      static <B> P1<Stream<B>>sequenceP1(Stream<P1<B>> stream) +
      Sequence the given stream and collect the output as a P1.
      +
      static <B> Seq<Stream<B>>sequenceSeq(Stream<Seq<B>> stream) +
      Sequence the given stream and collect the output as a seq.
      +
      static <B> Set<Stream<B>>sequenceSet(Ord<B> ord, + Stream<Set<B>> stream) +
      Sequence the given stream and collect the output as a set; use the given ord to order the set.
      +
      static <B> Stream<Stream<B>>sequenceStream(Stream<Stream<B>> stream) +
      Sequence the given stream and collect the output as a stream.
      +
      static <B> Trampoline<Stream<B>>sequenceTrampoline(Stream<Trampoline<B>> stream) +
      Sequence the given stream and collect the output as a trampoline.
      +
      static <E,B> Validation<E,Stream<B>>sequenceValidation(Semigroup<E> semigroup, + Stream<Validation<E,B>> stream) +
      Sequence the given stream and collect the output as a validation; use the given semigroup to reduce the errors.
      +
      static <E,B> Validation<E,Stream<B>>sequenceValidation(Stream<Validation<E,B>> stream) +
      Sequence the given stream and collect the output as a validation.
      +
      <B> Stream<B>sequenceW(Stream<F<Stream<A>,B>> fs) +
      Applies a stream of comonadic functions to this stream, returning a stream of values.
      +
      static <A> F<A,Stream<A>>single() +
      Returns a function that yields a stream containing its argument.
      +
      static <A> Stream<A>single(A a) +
      Returns a stream of one element containing the given value.
      +
      Stream<A>snoc(A a) +
      Append the given element to this stream to product a new stream.
      +
      Stream<A>snoc(F0<A> a) +
      Append the given element to this stream to produce a new stream.
      +
      Stream<A>sort(Ord<A> o) +
      Sort this stream according to the given ordering.
      +
      Stream<A>sort(Ord<A> o, + Strategy<Unit> s) +
      Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
      +
      P2<Stream<A>,Stream<A>>span(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
      +
      P2<Stream<A>,Stream<A>>split(F<A,java.lang.Boolean> p) +
      Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
      +
      static <A> Stream<A>stream(A... as) +
      Constructs a stream with the given elements.
      +
      Stream<Stream<A>>substreams() +
      Returns a stream of all infixes of this stream.
      +
      abstract P1<Stream<A>>tail() +
      The stream without the first element or fails for the empty stream.
      +
      Stream<Stream<A>>tails() +
      Returns a stream of the suffixes of this stream.
      +
      Stream<A>take(int n) +
      Returns the first n elements from the head of this stream.
      +
      Stream<A>takeWhile(F<A,java.lang.Boolean> f) +
      Returns the first elements of the head of this stream that match the given predicate function.
      +
      Array<A>toArray() +
      Returns a array projection of this stream.
      +
      Array<A>toArray(java.lang.Class<A[]> c) +
      Returns a array projection of this stream.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this stream.
      +
      <X> Either<X,A>toEither(F0<X> x) +
      Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
      +
      F<java.lang.Integer,A>toFunction() +
      Converts this stream to a function of natural numbers.
      +
      java.util.List<A>toJavaList() +
      Returns a java.util.List projection of this stream.
      +
      List<A>toList() +
      Returns a list projection of this stream.
      +
      Option<A>toOption() +
      Returns an option projection of this stream; None if empty, or the first element + in Some.
      +
      java.lang.StringtoString() 
      java.lang.StringtoStringEager() 
      java.lang.StringtoStringLazy() 
      <B,L> Either<L,Stream<B>>traverseEither(F<A,Either<L,B>> f) +
      Traverse this stream with the given function and collect the output on the right side of an either.
      +
      <R,B> Either<Stream<B>,R>traverseEitherLeft(F<A,Either<B,R>> f) +
      Traverse this stream with the given function and collect the output on the left side of an either.
      +
      <L,B> Either<L,Stream<B>>traverseEitherRight(F<A,Either<L,B>> f) +
      Traverse this stream with the given function and collect the output on the right side of an either.
      +
      <C,B> F<C,Stream<B>>traverseF(F<A,F<C,B>> f) +
      Traverse this stream with the given function and collect the output as a function.
      +
      <B> IO<Stream<B>>traverseIO(F<A,IO<B>> f) +
      Traverse this stream with the given function and collect the output as an IO.
      +
      <B> List<Stream<B>>traverseList(F<A,List<B>> f) +
      Traverse this stream with the given function and collect the output as a list.
      +
      <B> Option<Stream<B>>traverseOption(F<A,Option<B>> f) +
      Traverses through the Seq with the given function
      +
      <B> P1<Stream<B>>traverseP1(F<A,P1<B>> f) +
      Traverse this stream with the given function and collect the output as a p1.
      +
      <B> Seq<Stream<B>>traverseSeq(F<A,Seq<B>> f) +
      Traverse this stream with the given function and collect the output as a seq.
      +
      <B> Set<Stream<B>>traverseSet(Ord<B> ord, + F<A,Set<B>> f) +
      Traverse this stream with the given function and collect the output as a set; use the given ord to order the set.
      +
      <B> Stream<Stream<B>>traverseStream(F<A,Stream<B>> f) +
      Traverse this stream with the given function and collect the output as a stream.
      +
      <B> Trampoline<Stream<B>>traverseTrampoline(F<A,Trampoline<B>> f) +
      Traverse this stream with the given function and collect the output as a trampoline.
      +
      <E,B> Validation<E,Stream<B>>traverseValidation(F<A,Validation<E,B>> f) +
      Traverse this stream with the given function and collect the output as a validation.
      +
      <E,B> Validation<E,Stream<B>>traverseValidation(Semigroup<E> semigroup, + F<A,Validation<E,B>> f) +
      Traverse this stream with the given function and collect the output as a validation; use the given semigroup to + reduce the errors.
      +
      <B> Buncons(B nil, + F<A,F<P1<Stream<A>>,B>> cons) +
      Performs a reduction on this stream using the given arguments.
      +
      static <A,B> Stream<A>unfold(F<B,Option<P2<A,B>>> f, + B b) +
      Unfolds across the given function starting at the given value to produce a stream.
      +
      static <A,B> P2<Stream<A>,Stream<B>>unzip(Stream<P2<A,B>> xs) +
      Transforms a stream of pairs into a stream of first components and a stream of second components.
      +
      <B> Stream<B>zapp(Stream<F<A,B>> fs) +
      Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
      +
      <B> Stream<P2<A,B>>zip(Stream<B> bs) +
      Zips this stream with the given stream to produce a stream of pairs.
      +
      Stream<P2<A,java.lang.Integer>>zipIndex() +
      Zips this stream with the index of its element as a pair.
      +
      static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>>zipWith() +
      A first-class version of the zipWith function.
      +
      <B,C> F<Stream<B>,Stream<C>>zipWith(F<A,F<B,C>> f) +
      Partially-applied version of zipWith.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F<A,F<B,C>> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      <B,C> Stream<C>zipWith(Stream<B> bs, + F2<A,B,C> f) +
      Zips this stream with the given stream using the given function to produce a new stream.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<A> iterator()
        +
        Returns an iterator for this stream. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this stream.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        Returns:
        +
        The first element of the stream or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract P1<Stream<A>> tail()
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        Returns:
        +
        The stream without the first element or fails for the empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Returns true if this stream is empty, false otherwise.
        +
        +
        Returns:
        +
        true if this stream is empty, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty

        +
        public final boolean isNotEmpty()
        +
        Returns false if this stream is empty, true otherwise.
        +
        +
        Returns:
        +
        false if this stream is empty, true otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F<A,F<P1<Stream<A>>,B>> cons)
        +
        Performs a reduction on this stream using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this stream is empty.
        +
        cons - The function to apply to the head and tail of this stream if it is not empty.
        +
        Returns:
        +
        A reduction on this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F<A,F<P1<B>,B>> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,P1<B>,B> f,
+                             B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F<A,F<B,B>> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight1

        +
        public final <B> B foldRight1(F2<A,B,B> f,
+                              B b)
        +
        Performs a right-fold reduction across this stream. This function uses O(length) stack space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F<B,F<A,B>> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this stream. This function runs in constant space.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        b - The beginning value to start the application from.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F2<A,A,A> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        foldLeft1

        +
        public final A foldLeft1(F<A,F<A,A>> f)
        +
        Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of the stream.
        +
        Returns:
        +
        The final result after the left-fold reduction.
        +
        +
        • +
      + + + +
        +
      • +

        orHead

        +
        public final A orHead(F0<A> a)
        +
        Returns the head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        a - The argument to return if this stream is empty.
        +
        Returns:
        +
        The head of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        orTail

        +
        public final P1<Stream<A>> orTail(F0<Stream<A>> as)
        +
        Returns the tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        Parameters:
        +
        as - The argument to return if this stream is empty.
        +
        Returns:
        +
        The tail of this stream if there is one or the given argument if this stream is empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        intersperse

        +
        public final Stream<A> intersperse(A a)
        +
        Intersperses the given value between each two elements of the stream.
        +
        +
        Parameters:
        +
        a - The value to intersperse between values of the stream.
        +
        Returns:
        +
        A new stream with the given value between each two elements of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Stream<B> map(F<A,B> f)
        +
        Maps the given function across this stream.
        +
        +
        Parameters:
        +
        f - The function to map across this stream.
        +
        Returns:
        +
        A new stream after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        map_

        +
        public static <A,B> F<F<A,B>,F<Stream<A>,Stream<B>>> map_()
        +
        Provides a first-class version of the map function.
        +
        +
        Returns:
        +
        A function that maps a given function across a given stream.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<A,Unit> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<A> f)
        +
        Performs a side-effect for each element of this stream.
        +
        +
        Parameters:
        +
        f - The side-effect to perform for the given element.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final Stream<A> filter(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements all match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(Stream<A> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public final Stream<A> append(F0<Stream<A>> as)
        +
        Appends the given stream to this stream.
        +
        +
        Parameters:
        +
        as - The stream to append to this one.
        +
        Returns:
        +
        A new stream that has appended the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public final Stream<A> minus(Equal<A> eq,
+                             Stream<A> xs)
        +
        Returns a new stream of all the items in this stream that do not appear in the given stream.
        +
        +
        Parameters:
        +
        eq - an equality for the items of the streams.
        +
        xs - a list to subtract from this stream.
        +
        Returns:
        +
        a stream of all the items in this stream that do not appear in the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public final Stream<A> removeAll(F<A,java.lang.Boolean> f)
        +
        Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
        +
        +
        Parameters:
        +
        f - The predicate function to filter on.
        +
        Returns:
        +
        A new stream whose elements do not match the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        sequence_

        +
        public static <A,B> F<B,Stream<A>> sequence_(Stream<F<B,A>> fs)
        +
        Turn a stream of functions into a function returning a stream.
        +
        +
        Parameters:
        +
        fs - The stream of functions to sequence into a single function that returns a stream.
        +
        Returns:
        +
        A function that, when given an argument, applies all the functions in the given stream to it + and returns a stream of the results.
        +
        +
        • +
      + + + +
        +
      • +

        mapM

        +
        public final <B,C> F<B,Stream<C>> mapM(F<A,F<B,C>> f)
        +
        Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
        +
        +
        Parameters:
        +
        f - A function of arity-2
        +
        Returns:
        +
        A function that, when given an argument, applies the given function to that argument and every element + in this list.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B> Stream<B> bind(F<A,Stream<B>> f)
        +
        Binds the given function across each element of this stream with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to each element of this stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F<A,F<B,C>> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C> Stream<C> bind(Stream<B> sb,
+                                  F2<A,B,C> f)
        +
        Binds the given function across each element of this stream and the given stream with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given stream.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D> Stream<D> bind(Stream<B> sb,
+                                    Stream<C> sc,
+                                    F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E> Stream<E> bind(Stream<B> sb,
+                                      Stream<C> sc,
+                                      Stream<D> sd,
+                                      F<A,F<B,F<C,F<D,E>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$> Stream<F$> bind(Stream<B> sb,
+                                          Stream<C> sc,
+                                          Stream<D> sd,
+                                          Stream<E> se,
+                                          F<A,F<B,F<C,F<D,F<E,F$>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G> Stream<G> bind(Stream<B> sb,
+                                           Stream<C> sc,
+                                           Stream<D> sd,
+                                           Stream<E> se,
+                                           Stream<F$> sf,
+                                           F<A,F<B,F<C,F<D,F<E,F<F$,G>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H> Stream<H> bind(Stream<B> sb,
+                                             Stream<C> sc,
+                                             Stream<D> sd,
+                                             Stream<E> se,
+                                             Stream<F$> sf,
+                                             Stream<G> sg,
+                                             F<A,F<B,F<C,F<D,F<E,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <B,C,D,E,F$,G,H,I> Stream<I> bind(Stream<B> sb,
+                                               Stream<C> sc,
+                                               Stream<D> sd,
+                                               Stream<E> se,
+                                               Stream<F$> sf,
+                                               Stream<G> sg,
+                                               Stream<H> sh,
+                                               F<A,F<B,F<C,F<D,F<E,F<F$,F<G,F<H,I>>>>>>>> f)
        +
        Binds the given function across each element of this stream and the given streams with a final + join.
        +
        +
        Parameters:
        +
        sb - A given stream to bind the given function with.
        +
        sc - A given stream to bind the given function with.
        +
        sd - A given stream to bind the given function with.
        +
        se - A given stream to bind the given function with.
        +
        sf - A given stream to bind the given function with.
        +
        sg - A given stream to bind the given function with.
        +
        sh - A given stream to bind the given function with.
        +
        f - The function to apply to each element of this stream and the given streams.
        +
        Returns:
        +
        A new stream after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <B> Stream<B> sequence(Stream<B> bs)
        +
        Performs a bind across each stream element, but ignores the element value each time.
        +
        +
        Parameters:
        +
        bs - The stream to apply in the final join.
        +
        Returns:
        +
        A new stream after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<IO<A>> sequence(IO<Stream<A>> io)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        io - The IO stream to sequence.
        +
        Returns:
        +
        The stream of IOs after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<P1<A>> sequence(F0<Stream<A>> p)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        p - The lazy stream to sequence.
        +
        Returns:
        +
        The stream of (pre-calculated) lazy values after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> Stream<Option<A>> sequence(Option<Stream<A>> o)
        +
        Sequence through the Stream monad.
        +
        +
        Parameters:
        +
        o - The optional stream to sequence.
        +
        Returns:
        +
        The stream of options after sequencing.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <B> Stream<B> apply(Stream<F<A,B>> sf)
        +
        Performs function application within a stream (applicative functor pattern).
        +
        +
        Parameters:
        +
        sf - The stream of functions to apply.
        +
        Returns:
        +
        A new stream after applying the given stream of functions through this stream.
        +
        +
        • +
      + + + +
        +
      • +

        interleave

        +
        public final Stream<A> interleave(Stream<A> as)
        +
        Interleaves the given stream with this stream to produce a new stream.
        +
        +
        Parameters:
        +
        as - The stream to interleave this stream with.
        +
        Returns:
        +
        A new stream with elements interleaved from this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        enumerationStream

        +
        public static <A> Stream<A> enumerationStream(java.util.Enumeration<A> e)
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o)
        +
        Sort this stream according to the given ordering.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public final Stream<A> sort(Ord<A> o,
+                            Strategy<Unit> s)
        +
        Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
        +
        +
        Parameters:
        +
        o - An ordering for the elements of this stream.
        +
        s - A strategy for parallelising the algorithm.
        +
        Returns:
        +
        A new stream with the elements of this stream sorted according to the given ordering.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public final java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this stream.
        +
        +
        Returns:
        +
        An immutable collection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from,
+                                              long to)
        +
        Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        to - The maximum value for the stream (exclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive) to the given + to value (exclusive).
        +
        +
        • +
      + + + + + +
        +
      • +

        stream

        +
        @SafeVarargs
+public static <A> Stream<A> stream(A... as)
        +
        Constructs a stream with the given elements.
        +
        +
        Parameters:
        +
        as - The elements which which to construct a stream.
        +
        Returns:
        +
        a new stream with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorStream

        +
        public static <A> Stream<A> iteratorStream(java.util.Iterator<A> it)
        +
        Constructs a stream with the given elements in the Iterator.
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        forever

        +
        public static <A> Stream<A> forever(Enumerator<A> e,
+                                    A from,
+                                    long step)
        +
        Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
        +
        +
        • +
      + + + + + +
        +
      • +

        range

        +
        public static <A> Stream<A> range(Enumerator<A> e,
+                                  A from,
+                                  A to,
+                                  long step)
        +
        Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        Parameters:
        +
        e - The enumerator to compute successors from.
        +
        from - The value to begin computing successors from.
        +
        to - The value to stop computing successors from.
        +
        step - The increment to step.
        +
        Returns:
        +
        A stream using the given enumerator from the given value to the other given value stepping at the given + increment.
        +
        +
        • +
      + + + +
        +
      • +

        range

        +
        public static Stream<java.lang.Integer> range(int from)
        +
        Returns an infinite stream of integers from the given from value (inclusive).
        +
        +
        Parameters:
        +
        from - The minimum value for the stream (inclusive).
        +
        Returns:
        +
        A stream of integers from the given from value (inclusive).
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> F<F<A,java.lang.Boolean>,F<Stream<A>,Stream<A>>> filter()
        +
        Returns a first-class version of the filter function.
        +
        +
        Returns:
        +
        a function that filters a given stream using a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zapp

        +
        public final <B> Stream<B> zapp(Stream<F<A,B>> fs)
        +
        Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream. If this stream and the given stream + have different lengths, then the longer stream is normalised so this function never fails.
        +
        +
        Parameters:
        +
        fs - The stream of functions to apply to this stream.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F<A,F<B,C>> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> Stream<C> zipWith(Stream<B> bs,
+                                     F2<A,B,C> f)
        +
        Zips this stream with the given stream using the given function to produce a new stream. If + this stream and the given stream have different lengths, then the longer stream is normalised + so this function never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        f - The function to zip this stream and the given stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public final <B,C> F<Stream<B>,Stream<C>> zipWith(F<A,F<B,C>> f)
        +
        Partially-applied version of zipWith. + Returns a function that zips a given stream with this stream using the given function.
        +
        +
        Parameters:
        +
        f - The function to zip this stream and a given stream with.
        +
        Returns:
        +
        A function that zips a given stream with this stream using the given function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public final <B> Stream<P2<A,B>> zip(Stream<B> bs)
        +
        Zips this stream with the given stream to produce a stream of pairs. If this stream and the + given stream have different lengths, then the longer stream is normalised so this function + never fails.
        +
        +
        Parameters:
        +
        bs - The stream to zip this stream with.
        +
        Returns:
        +
        A new stream with a length the same as the shortest of this stream and the given + stream.
        +
        +
        • +
      + + + +
        +
      • +

        zipIndex

        +
        public final Stream<P2<A,java.lang.Integer>> zipIndex()
        +
        Zips this stream with the index of its element as a pair.
        +
        +
        Returns:
        +
        A new stream with the same length as this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final <X> Either<X,A> toEither(F0<X> x)
        +
        Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
        +
        +
        Parameters:
        +
        x - The value to return in left if this stream is empty.
        +
        Returns:
        +
        An either projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<A> toOption()
        +
        Returns an option projection of this stream; None if empty, or the first element + in Some.
        +
        +
        Returns:
        +
        An option projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<A> toList()
        +
        Returns a list projection of this stream.
        +
        +
        Returns:
        +
        A list projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toJavaList

        +
        public final java.util.List<A> toJavaList()
        +
        Returns a java.util.List projection of this stream.
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray()
        +
        Returns a array projection of this stream.
        +
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<A> toArray(java.lang.Class<A[]> c)
        +
        Returns a array projection of this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        A array projection of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        array

        +
        public final A[] array(java.lang.Class<A[]> c)
        +
        Returns an array from this stream.
        +
        +
        Parameters:
        +
        c - The class type of the array to return.
        +
        Returns:
        +
        An array from this stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public final Stream<A> cons(A a)
        +
        Prepends (cons) the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to prepend.
        +
        Returns:
        +
        A new stream with the given element at the head.
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public static java.lang.String asString(Stream<java.lang.Character> cs)
        +
        Returns a string from the given stream of characters. The inverse of this function is fromString(String).
        +
        +
        Parameters:
        +
        cs - The stream of characters to produce the string from.
        +
        Returns:
        +
        A string from the given stream of characters.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static Stream<java.lang.Character> fromString(java.lang.String s)
        +
        Returns a stream of characters from the given string. The inverse of this function is asString(Stream).
        +
        +
        Parameters:
        +
        s - The string to produce the stream of characters from.
        +
        Returns:
        +
        A stream of characters from the given string.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(A a)
        +
        Append the given element to this stream to product a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        snoc

        +
        public final Stream<A> snoc(F0<A> a)
        +
        Append the given element to this stream to produce a new stream.
        +
        +
        Parameters:
        +
        a - The element to append.
        +
        Returns:
        +
        A new stream with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        take

        +
        public final Stream<A> take(int n)
        +
        Returns the first n elements from the head of this stream.
        +
        +
        Parameters:
        +
        n - The number of elements to take from this stream.
        +
        Returns:
        +
        The first n elements from the head of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        drop

        +
        public final Stream<A> drop(int i)
        +
        Drops the given number of elements from the head of this stream if they are available.
        +
        +
        Parameters:
        +
        i - The number of elements to drop from the head of this stream.
        +
        Returns:
        +
        A stream with a length the same, or less than, this stream.
        +
        +
        • +
      + + + +
        +
      • +

        takeWhile

        +
        public final Stream<A> takeWhile(F<A,java.lang.Boolean> f)
        +
        Returns the first elements of the head of this stream that match the given predicate function.
        +
        +
        Parameters:
        +
        f - The predicate function to apply on this stream until it finds an element that does not + hold, or the stream is exhausted.
        +
        Returns:
        +
        The first elements of the head of this stream that match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        dropWhile

        +
        public final Stream<A> dropWhile(F<A,java.lang.Boolean> f)
        +
        Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
        +
        +
        Parameters:
        +
        f - The predicate function to apply through this stream.
        +
        Returns:
        +
        The stream whose first element does not match the given predicate function.
        +
        +
        • +
      + + + +
        +
      • +

        span

        +
        public final P2<Stream<A>,Stream<A>> span(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public final Stream<A> replace(F<A,java.lang.Boolean> p,
+                               A a)
        +
        Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        Parameters:
        +
        p - The predicate to match replaced elements.
        +
        a - The element with which to replace elements.
        +
        Returns:
        +
        A new stream resulting from replacing all elements that match the given predicate with the given element.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<Stream<A>,Stream<A>> split(F<A,java.lang.Boolean> p)
        +
        Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        Parameters:
        +
        p - A predicate not to be satisfied by a prefix of this stream.
        +
        Returns:
        +
        A tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public final Stream<A> reverse()
        +
        Reverse this stream in constant stack space.
        +
        +
        Returns:
        +
        A new stream that is the reverse of this one.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public final A last()
        +
        Get the last element of this stream. Undefined for infinite streams.
        +
        +
        Returns:
        +
        The last element in this stream, if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public final int length()
        +
        The length of this stream. This function will not terminate for an infinite stream.
        +
        +
        Returns:
        +
        The length of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public final A index(int i)
        +
        Returns the element at the given index if it exists, fails otherwise.
        +
        +
        Parameters:
        +
        i - The index at which to get the element to return.
        +
        Returns:
        +
        The element at the given index if it exists, fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
        +
        +
        Parameters:
        +
        f - the predicate function to test on each element of this stream.
        +
        Returns:
        +
        true if the predicate holds for all of the elements of this stream, + false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStringLazy

        +
        public final java.lang.String toStringLazy()
        +
        • +
      + + + +
        +
      • +

        toStringEager

        +
        public final java.lang.String toStringEager()
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<A,java.lang.Boolean> f)
        +
        Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
        +
        +
        Parameters:
        +
        f - The predicate function to test on the elements of this stream.
        +
        Returns:
        +
        true if the predicate holds for at least one of the elements of this + stream.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final Option<A> find(F<A,java.lang.Boolean> f)
        +
        Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        Parameters:
        +
        f - The predicate function to test on elements of this stream.
        +
        Returns:
        +
        The first occurrence of an element that matches the given predicate or no value if no + elements match.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public final <B> Stream<B> cobind(F<Stream<A>,B> k)
        +
        Binds the given function across the stream of substreams of this stream.
        +
        +
        Parameters:
        +
        k - A function to bind across this stream and its substreams.
        +
        Returns:
        +
        a new stream of the results of applying the given function to this stream and its substreams.
        +
        +
        • +
      + + + +
        +
      • +

        tails

        +
        public final Stream<Stream<A>> tails()
        +
        Returns a stream of the suffixes of this stream. A stream is considered to be a suffix of itself in this context.
        +
        +
        Returns:
        +
        a stream of the suffixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        inits

        +
        public final Stream<Stream<A>> inits()
        +
        Returns a stream of all prefixes of this stream. A stream is considered a prefix of itself in tnis context.
        +
        +
        Returns:
        +
        a stream of the prefixes of this stream, starting with the stream itself.
        +
        +
        • +
      + + + +
        +
      • +

        substreams

        +
        public final Stream<Stream<A>> substreams()
        +
        Returns a stream of all infixes of this stream. A stream is considered to contain itself.
        +
        +
        Returns:
        +
        a stream of the infixes of this stream.
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public final Option<java.lang.Integer> indexOf(F<A,java.lang.Boolean> p)
        +
        Returns the position of the first element matching the given predicate, if any.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        the position of the first element matching the given predicate, if any.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceW

        +
        public final <B> Stream<B> sequenceW(Stream<F<Stream<A>,B>> fs)
        +
        Applies a stream of comonadic functions to this stream, returning a stream of values.
        +
        +
        Parameters:
        +
        fs - A stream of comonadic functions to apply to this stream.
        +
        Returns:
        +
        A new stream of the results of applying the stream of functions to this stream.
        +
        +
        • +
      + + + +
        +
      • +

        toFunction

        +
        public final F<java.lang.Integer,A> toFunction()
        +
        Converts this stream to a function of natural numbers.
        +
        +
        Returns:
        +
        A function from natural numbers to values with the corresponding position in this stream.
        +
        +
        • +
      + + + +
        +
      • +

        fromFunction

        +
        public static <A> Stream<A> fromFunction(F<Natural,A> f)
        +
        Converts a function of natural numbers to a stream.
        +
        +
        Parameters:
        +
        f - The function to convert to a stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the natural numbers, starting at 0.
        +
        +
        • +
      + + + + + +
        +
      • +

        fromFunction

        +
        public static <A,B> Stream<A> fromFunction(Enumerator<B> e,
+                                           F<B,A> f,
+                                           B i)
        +
        Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
        +
        +
        Parameters:
        +
        e - An enumerator for the domain of the function.
        +
        f - The function to convert to a stream.
        +
        i - The index into the function at which to begin the stream.
        +
        Returns:
        +
        A new stream of the results of the given function applied to the values of the given enumerator, + starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        unzip

        +
        public static <A,B> P2<Stream<A>,Stream<B>> unzip(Stream<P2<A,B>> xs)
        +
        Transforms a stream of pairs into a stream of first components and a stream of second components.
        +
        +
        Parameters:
        +
        xs - The stream of pairs to transform.
        +
        Returns:
        +
        A stream of first components and a stream of second components.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public static <A,B,C> F<Stream<A>,F<Stream<B>,F<F<A,F<B,C>>,Stream<C>>>> zipWith()
        +
        A first-class version of the zipWith function.
        +
        +
        Returns:
        +
        a function that zips two given streams with a given function.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> F<A,F<P1<Stream<A>>,Stream<A>>> cons()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        cons_

        +
        public static <A> F<A,F<Stream<A>,Stream<A>>> cons_()
        +
        Returns a function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        Returns:
        +
        A function that prepends (cons) an element to a stream to produce a new stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil

        +
        public static <A> Stream<A> nil()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        nil_

        +
        public static <A> P1<Stream<A>> nil_()
        +
        Returns an empty stream.
        +
        +
        Returns:
        +
        An empty stream.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isEmpty_()
        +
        Returns a function that determines whether a given stream is empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is empty.
        +
        +
        • +
      + + + +
        +
      • +

        isNotEmpty_

        +
        public static <A> F<Stream<A>,java.lang.Boolean> isNotEmpty_()
        +
        Returns a function that determines whether a given stream is not empty.
        +
        +
        Returns:
        +
        A function that determines whether a given stream is not empty.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Stream<A> single(A a)
        +
        Returns a stream of one element containing the given value.
        +
        +
        Parameters:
        +
        a - The value for the head of the returned stream.
        +
        Returns:
        +
        A stream of one element containing the given value.
        +
        +
        • +
      + + + +
        +
      • +

        single

        +
        public static <A> F<A,Stream<A>> single()
        +
        Returns a function that yields a stream containing its argument.
        +
        +
        Returns:
        +
        a function that yields a stream containing its argument.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <A> Stream<A> cons(A head,
+                                 F0<Stream<A>> tail)
        +
        Prepends the given head element to the given tail element to produce a new stream.
        +
        +
        Parameters:
        +
        head - The element to prepend.
        +
        tail - The stream to prepend to.
        +
        Returns:
        +
        The stream with the given element prepended.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> Stream<A> join(Stream<Stream<A>> o)
        +
        Joins the given stream of streams by concatenation.
        +
        +
        Parameters:
        +
        o - The stream of streams to join.
        +
        Returns:
        +
        A new stream that is the join of the given streams.
        +
        +
        • +
      + + + +
        +
      • +

        join

        +
        public static <A> F<Stream<Stream<A>>,Stream<A>> join()
        +
        A first-class version of join
        +
        +
        Returns:
        +
        A function that joins a stream of streams using a bind operation.
        +
        +
        • +
      + + + + + +
        +
      • +

        unfold

        +
        public static <A,B> Stream<A> unfold(F<B,Option<P2<A,B>>> f,
+                                     B b)
        +
        Unfolds across the given function starting at the given value to produce a stream.
        +
        +
        Parameters:
        +
        f - The function to unfold across.
        +
        b - The start value to begin the unfold.
        +
        Returns:
        +
        A new stream that is a result of unfolding until the function does not produce a + value.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterateWhile

        +
        public static <A> Stream<A> iterateWhile(F<A,A> f,
+                                         F<A,java.lang.Boolean> p,
+                                         A a)
        +
        Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        Parameters:
        +
        f - The function to iterate with.
        +
        p - The predicate which must be true for the next item in order to continue the iteration.
        +
        a - The input to the first iteration.
        +
        Returns:
        +
        A stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
        +
        +
        • +
      + + + +
        +
      • +

        iterableStream

        +
        public static <A> Stream<A> iterableStream(java.lang.Iterable<A> i)
        +
        Takes the given iterable to a stream.
        +
        +
        Parameters:
        +
        i - The iterable to take to a stream.
        +
        Returns:
        +
        A stream from the given iterable.
        +
        +
        • +
      + + + + + +
        +
      • +

        arrayStream

        +
        @SafeVarargs
+public static <A> Stream<A> arrayStream(A... as)
        +
        • +
      + + + + + +
        +
      • +

        repeat

        +
        public static <A> Stream<A> repeat(A a)
        +
        Returns an infinite-length stream of the given element.
        +
        +
        Parameters:
        +
        a - The element to repeat infinitely.
        +
        Returns:
        +
        An infinite-length stream of the given element.
        +
        +
        • +
      + + + +
        +
      • +

        cycle

        +
        public static <A> Stream<A> cycle(Stream<A> as)
        +
        Returns an infinite-length stream of the given elements cycling. Fails on the empty stream.
        +
        +
        Parameters:
        +
        as - The elements to cycle infinitely. This must not be empty.
        +
        Returns:
        +
        An infinite-length stream of the given elements cycling.
        +
        +
        • +
      + + + + + +
        +
      • +

        iterate

        +
        public static <A> Stream<A> iterate(F<A,A> f,
+                                    A a)
        +
        Returns a stream constructed by applying the given iteration function starting at the given value.
        +
        +
        Parameters:
        +
        f - The iteration function.
        +
        a - The value to begin iterating from.
        +
        Returns:
        +
        A stream constructed by applying the given iteration function starting at the given value.
        +
        +
        • +
      + + + +
        +
      • +

        iterate

        +
        public static <A> F<F<A,A>,F<A,Stream<A>>> iterate()
        +
        A first-class version of the iterate function.
        +
        +
        Returns:
        +
        A function that returns a stream constructed by applying a given iteration function + starting at a given value.
        +
        +
        • +
      + + + +
        +
      • +

        bind_

        +
        public static <A,B> F<F<A,Stream<B>>,F<Stream<A>,Stream<B>>> bind_()
        +
        A first-class version of the bind function.
        +
        +
        Returns:
        +
        A function that binds a given function across a given stream, joining the resulting streams.
        +
        +
        • +
      + + + +
        +
      • +

        foldRight

        +
        public static <A,B> F<F<A,F<P1<B>,B>>,F<B,F<Stream<A>,B>>> foldRight()
        +
        A first-class version of the foldRight function.
        +
        +
        Returns:
        +
        A function that folds a given stream with a given function.
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEither

        +
        public static <L,B> Either<L,Stream<B>> sequenceEither(Stream<Either<L,B>> stream)
        +
        Sequence the given stream and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherLeft

        +
        public static <R,B> Either<Stream<B>,R> sequenceEitherLeft(Stream<Either<B,R>> stream)
        +
        Sequence the given stream and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the right value
        +
        B - the type of the left value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherRight

        +
        public static <L,B> Either<L,Stream<B>> sequenceEitherRight(Stream<Either<L,B>> stream)
        +
        Sequence the given stream and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        B - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceF

        +
        public static <C,B> F<C,Stream<B>> sequenceF(Stream<F<C,B>> stream)
        +
        Sequence the given stream and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceIO

        +
        public static <B> IO<Stream<B>> sequenceIO(Stream<IO<B>> stream)
        +
        Sequence the given stream and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static <B> List<Stream<B>> sequenceList(Stream<List<B>> stream)
        +
        Sequence the given stream and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceOption

        +
        public static <B> Option<Stream<B>> sequenceOption(Stream<Option<B>> stream)
        +
        Sequence the given stream and collect the output as an stream.
        +
        +
        Type Parameters:
        +
        B - the type of the option value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceP1

        +
        public static <B> P1<Stream<B>> sequenceP1(Stream<P1<B>> stream)
        +
        Sequence the given stream and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        B - the type of the P1 value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSeq

        +
        public static <B> Seq<Stream<B>> sequenceSeq(Stream<Seq<B>> stream)
        +
        Sequence the given stream and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSet

        +
        public static <B> Set<Stream<B>> sequenceSet(Ord<B> ord,
+                                             Stream<Set<B>> stream)
        +
        Sequence the given stream and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        stream - the given stream
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public static <B> Stream<Stream<B>> sequenceStream(Stream<Stream<B>> stream)
        +
        Sequence the given stream and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceTrampoline

        +
        public static <B> Trampoline<Stream<B>> sequenceTrampoline(Stream<Trampoline<B>> stream)
        +
        Sequence the given stream and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        stream - the given trampoline
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static <E,B> Validation<E,Stream<B>> sequenceValidation(Stream<Validation<E,B>> stream)
        +
        Sequence the given stream and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        stream - the given stream
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static <E,B> Validation<E,Stream<B>> sequenceValidation(Semigroup<E> semigroup,
+                                                               Stream<Validation<E,B>> stream)
        +
        Sequence the given stream and collect the output as a validation; use the given semigroup to reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        semigroup - the given semigroup
        +
        stream - the given stream
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseEither

        +
        public <B,L> Either<L,Stream<B>> traverseEither(F<A,Either<L,B>> f)
        +
        Traverse this stream with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherLeft

        +
        public <R,B> Either<Stream<B>,R> traverseEitherLeft(F<A,Either<B,R>> f)
        +
        Traverse this stream with the given function and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        R - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherRight

        +
        public <L,B> Either<L,Stream<B>> traverseEitherRight(F<A,Either<L,B>> f)
        +
        Traverse this stream with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        B - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public <C,B> F<C,Stream<B>> traverseF(F<A,F<C,B>> f)
        +
        Traverse this stream with the given function and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public <B> IO<Stream<B>> traverseIO(F<A,IO<B>> f)
        +
        Traverse this stream with the given function and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        B - the type of the IO value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public <B> List<Stream<B>> traverseList(F<A,List<B>> f)
        +
        Traverse this stream with the given function and collect the output as a list.
        +
        +
        Type Parameters:
        +
        B - the type of the list value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public <B> Option<Stream<B>> traverseOption(F<A,Option<B>> f)
        +
        Traverses through the Seq with the given function
        +
        +
        Parameters:
        +
        f - The function that produces Option value
        +
        Returns:
        +
        none if applying f returns none to any element of the seq or f mapped seq in some .
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public <B> P1<Stream<B>> traverseP1(F<A,P1<B>> f)
        +
        Traverse this stream with the given function and collect the output as a p1.
        +
        +
        Type Parameters:
        +
        B - the type of the p1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the p1
        +
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public <B> Seq<Stream<B>> traverseSeq(F<A,Seq<B>> f)
        +
        Traverse this stream with the given function and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        B - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public <B> Set<Stream<B>> traverseSet(Ord<B> ord,
+                                      F<A,Set<B>> f)
        +
        Traverse this stream with the given function and collect the output as a set; use the given ord to order the set.
        +
        +
        Type Parameters:
        +
        B - the type of the set value
        +
        Parameters:
        +
        ord - the given ord
        +
        f - the given function
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public <B> Stream<Stream<B>> traverseStream(F<A,Stream<B>> f)
        +
        Traverse this stream with the given function and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        B - the type of the stream value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        traverseTrampoline

        +
        public <B> Trampoline<Stream<B>> traverseTrampoline(F<A,Trampoline<B>> f)
        +
        Traverse this stream with the given function and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        B - the type of the trampoline value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <E,B> Validation<E,Stream<B>> traverseValidation(F<A,Validation<E,B>> f)
        +
        Traverse this stream with the given function and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <E,B> Validation<E,Stream<B>> traverseValidation(Semigroup<E> semigroup,
+                                                              F<A,Validation<E,B>> f)
        +
        Traverse this stream with the given function and collect the output as a validation; use the given semigroup to + reduce the errors.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        B - the type of the success value
        +
        Parameters:
        +
        semigroup - the given semigroup
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Tree.html b/javadoc/5.0/functionaljava/fj/data/Tree.html new file mode 100644 index 0000000..4215f31 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Tree.html @@ -0,0 +1,908 @@ + + + + + +Tree (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Tree<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Tree<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Tree<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> Tree<B>bottomUp(Tree<A> t, + F<P2<A,Stream<B>>,B> f) +
      Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
      +
      <B> Tree<B>cobind(F<Tree<A>,B> f) +
      Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
      +
      Tree<Tree<A>>cojoin() +
      Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
      +
      java.lang.Stringdraw(Show<A> s) +
      Draws a 2-dimensional representation of a tree.
      +
      booleanequals(java.lang.Object other) 
      static <A> F<Tree<A>,Stream<A>>flatten_() +
      + flatten :: Tree a -> [a] + flatten t = squish t [] +
      +
      Stream<A>flatten() +
      Puts the elements of the tree into a Stream, in pre-order.
      +
      static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>>fmap_() +
      Provides a transformation to lift any function so that it maps over Trees.
      +
      <B> Tree<B>fmap(F<A,B> f) +
      Maps the given function over this tree.
      +
      static <A,B> F<Tree<A>,B>foldMap_(F<A,B> f, + Monoid<B> m) +
      Provides a function that folds a tree with the given monoid.
      +
      <B> BfoldMap(F<A,B> f, + Monoid<B> m) +
      Folds this tree using the given monoid.
      +
      inthashCode() 
      booleanisLeaf() 
      java.util.Iterator<A>iterator() +
      Returns an iterator for this tree.
      +
      static <A> Tree<A>leaf(A root) +
      Creates a nullary tree.
      +
      intlength() 
      Stream<Stream<A>>levels() +
      Provides a stream of the elements of the tree at each level, in level order.
      +
      static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>>node() +
      First-class constructor of trees.
      +
      static <A> Tree<A>node(A root, + List<Tree<A>> forest) +
      Creates a new n-ary given a root and a subforest of length n.
      +
      static <A> Tree<A>node(A root, + P1<Stream<Tree<A>>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> Tree<A>node(A root, + Stream<Tree<A>> forest) +
      Creates a new tree given a root and a (potentially infinite) subforest.
      +
      static <A> F<Tree<A>,A>root_() +
      Provides a transformation from a tree to its root.
      +
      Aroot() +
      Returns the root element of the tree.
      +
      static <A> Show<Tree<A>>show2D(Show<A> s) +
      Provides a show instance that draws a 2-dimensional representation of a tree.
      +
      static <A> F<Tree<A>,P1<Stream<Tree<A>>>>subForest_() +
      Provides a transformation from a tree to its subforest.
      +
      P1<Stream<Tree<A>>>subForest() +
      Returns a stream of the tree's subtrees.
      +
      java.util.Collection<A>toCollection() +
      Projects an immutable collection of this tree.
      +
      java.lang.StringtoString() 
      static <A,B> F<B,Tree<A>>unfoldTree(F<B,P2<A,P1<Stream<B>>>> f) +
      Builds a tree from a seed value.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F<A,F<B,C>> f) +
      Zips this tree with another, using the given function.
      +
      <B,C> Tree<C>zipWith(Tree<B> bs, + F2<A,B,C> f) +
      Zips this tree with another, using the given function.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for this tree. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        A iterator for this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        leaf

        +
        public static <A> Tree<A> leaf(A root)
        +
        Creates a nullary tree.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        Returns:
        +
        A nullary tree with the root element in it.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               P1<Stream<Tree<A>>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               Stream<Tree<A>> forest)
        +
        Creates a new tree given a root and a (potentially infinite) subforest.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A stream of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        node

        +
        public static <A> Tree<A> node(A root,
+                               List<Tree<A>> forest)
        +
        Creates a new n-ary given a root and a subforest of length n.
        +
        +
        Parameters:
        +
        root - The root element of the tree.
        +
        forest - A list of the tree's subtrees.
        +
        Returns:
        +
        A newly sprouted tree.
        +
        +
        • +
      + + + +
        +
      • +

        node

        +
        public static <A> F<A,F<P1<Stream<Tree<A>>>,Tree<A>>> node()
        +
        First-class constructor of trees.
        +
        +
        Returns:
        +
        A function that constructs an n-ary tree given a root and a subforest or length n.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public A root()
        +
        Returns the root element of the tree.
        +
        +
        Returns:
        +
        The root element of the tree.
        +
        +
        • +
      + + + +
        +
      • +

        subForest

        +
        public P1<Stream<Tree<A>>> subForest()
        +
        Returns a stream of the tree's subtrees.
        +
        +
        Returns:
        +
        A stream of the tree's subtrees.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<Tree<A>,A> root_()
        +
        Provides a transformation from a tree to its root.
        +
        +
        Returns:
        +
        A transformation from a tree to its root.
        +
        +
        • +
      + + + +
        +
      • +

        subForest_

        +
        public static <A> F<Tree<A>,P1<Stream<Tree<A>>>> subForest_()
        +
        Provides a transformation from a tree to its subforest.
        +
        +
        Returns:
        +
        A transformation from a tree to its subforest.
        +
        +
        • +
      + + + +
        +
      • +

        flatten

        +
        public Stream<A> flatten()
        +
        Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        flatten_

        +
        public static <A> F<Tree<A>,Stream<A>> flatten_()
        +
        
+ flatten :: Tree a -> [a]
+ flatten t = squish t []
+
        + where squish (Node x ts) xs = x:Prelude.foldr squish xs ts + Puts the elements of the tree into a Stream, in pre-order.
        +
        +
        Returns:
        +
        The elements of the tree in pre-order.
        +
        +
        • +
      + + + +
        +
      • +

        levels

        +
        public Stream<Stream<A>> levels()
        +
        Provides a stream of the elements of the tree at each level, in level order.
        +
        +
        Returns:
        +
        The elements of the tree at each level.
        +
        +
        • +
      + + + +
        +
      • +

        fmap

        +
        public <B> Tree<B> fmap(F<A,B> f)
        +
        Maps the given function over this tree.
        +
        +
        Parameters:
        +
        f - The function to map over this tree.
        +
        Returns:
        +
        The new Tree after the function has been applied to each element in this Tree.
        +
        +
        • +
      + + + +
        +
      • +

        fmap_

        +
        public static <A,B> F<F<A,B>,F<Tree<A>,Tree<B>>> fmap_()
        +
        Provides a transformation to lift any function so that it maps over Trees.
        +
        +
        Returns:
        +
        A transformation to lift any function so that it maps over Trees.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public <B> B foldMap(F<A,B> f,
+                     Monoid<B> m)
        +
        Folds this tree using the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from this tree's elements, to the monoid.
        +
        m - The monoid to fold this tree with.
        +
        Returns:
        +
        The result of folding the tree with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toCollection

        +
        public java.util.Collection<A> toCollection()
        +
        Projects an immutable collection of this tree.
        +
        +
        Returns:
        +
        An immutable collection of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        foldMap_

        +
        public static <A,B> F<Tree<A>,B> foldMap_(F<A,B> f,
+                                          Monoid<B> m)
        +
        Provides a function that folds a tree with the given monoid.
        +
        +
        Parameters:
        +
        f - A transformation from a tree's elements to the monoid.
        +
        m - A monoid to fold the tree with.
        +
        Returns:
        +
        A function that, given a tree, folds it with the given monoid.
        +
        +
        • +
      + + + +
        +
      • +

        unfoldTree

        +
        public static <A,B> F<B,Tree<A>> unfoldTree(F<B,P2<A,P1<Stream<B>>>> f)
        +
        Builds a tree from a seed value.
        +
        +
        Parameters:
        +
        f - A function with which to build the tree.
        +
        Returns:
        +
        A function which, given a seed value, yields a tree.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Tree<B> cobind(F<Tree<A>,B> f)
        +
        Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
        +
        +
        Parameters:
        +
        f - A function to bind across all the subtrees of this tree.
        +
        Returns:
        +
        A new tree, with the results of applying the given function to each subtree of this tree. The result + of applying the function to the entire tree is the root label, and the results of applying to the + root's children are labels of the root's subforest, etc.
        +
        +
        • +
      + + + +
        +
      • +

        cojoin

        +
        public Tree<Tree<A>> cojoin()
        +
        Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
        +
        +
        Returns:
        +
        A tree of trees, with this tree as its root label, and subtrees of this tree as the labels of + its child nodes.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        draw

        +
        public java.lang.String draw(Show<A> s)
        +
        Draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a String showing this tree in two dimensions.
        +
        +
        • +
      + + + +
        +
      • +

        show2D

        +
        public static <A> Show<Tree<A>> show2D(Show<A> s)
        +
        Provides a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        Parameters:
        +
        s - A show instance for the elements of the tree.
        +
        Returns:
        +
        a show instance that draws a 2-dimensional representation of a tree.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F2<A,B,C> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Tree<C> zipWith(Tree<B> bs,
+                             F<A,F<B,C>> f)
        +
        Zips this tree with another, using the given function. The resulting tree is the structural intersection + of the two trees.
        +
        +
        Parameters:
        +
        bs - A tree to zip this tree with.
        +
        f - A function with which to zip together the two trees.
        +
        Returns:
        +
        A new tree of the results of applying the given function over this tree and the given tree, position-wise.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/TreeMap.html b/javadoc/5.0/functionaljava/fj/data/TreeMap.html new file mode 100644 index 0000000..01b917c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/TreeMap.html @@ -0,0 +1,1013 @@ + + + + + +TreeMap (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeMap<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeMap<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<P2<K,V>>
    +
    +
    +
    +
    public final class TreeMap<K,V>
+extends java.lang.Object
+implements java.lang.Iterable<P2<K,V>>
    +
    An immutable, in-memory map, backed by a red-black tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <K,V> TreeMap<K,V>arrayTreeMap(Ord<K> keyOrd, + P2<K,V>... ps) +
      Constructs a tree map from the given elements.
      +
      booleancontains(K k) +
      Determines if the given key value exists in this tree map.
      +
      TreeMap<K,V>delete(K k) +
      Deletes the entry in the tree map that corresponds to the given key.
      +
      static <K,V> TreeMap<K,V>empty(Ord<K> keyOrd) +
      Constructs an empty tree map.
      +
      booleanequals(java.lang.Object other) 
      static <K,V> TreeMap<K,V>fromMutableMap(Ord<K> ord, + java.util.Map<K,V> m) +
      An immutable projection of the given mutable map.
      +
      F<K,Option<V>>get() +
      Returns a first-class version of the get method for this TreeMap.
      +
      Option<V>get(K k) +
      Returns a potential value that the given key maps to.
      +
      inthashCode() 
      booleanisEmpty() +
      Determines if this tree map has any entries.
      +
      static <K,V> TreeMap<K,V>iterableTreeMap(Ord<K> keyOrd, + java.lang.Iterable<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      java.util.Iterator<P2<K,V>>iterator() +
      Returns an iterator for this map's key-value pairs.
      +
      static <K,V> TreeMap<K,V>iteratorTreeMap(Ord<K> keyOrd, + java.util.Iterator<P2<K,V>> it) +
      Constructs a tree map from the given elements.
      +
      List<K>keys() +
      Returns all keys in this tree map.
      +
      <W> TreeMap<K,W>map(F<V,W> f) +
      Maps the given function across the values of this TreeMap.
      +
      Option<P2<K,V>>max() +
      Returns the maximum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>maxKey() +
      Returns the maximum key in the tree if the tree is not empty.
      +
      Option<P2<K,V>>min() +
      Returns the minimum (key, value) pair in the tree if the tree is not empty.
      +
      Option<K>minKey() +
      Returns the minimum key in the tree if the tree is not empty.
      +
      TreeMap<K,V>set(K k, + V v) +
      Inserts the given key and value association into the tree map.
      +
      static <K,V> TreeMap<K,V>setTreeMap(Ord<K> ord, + Set<P2<K,Option<V>>> s) +
      Constructs a TreeMap from the given set.
      +
      intsize() +
      Returns the number of entries in this tree map.
      +
      P3<Set<V>,Option<V>,Set<V>>split(Ord<V> ord, + K k) +
      Splits this TreeMap at the given key.
      +
      P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>>splitLookup(K k) +
      Splits this TreeMap at the given key.
      +
      List<P2<K,V>>toList() 
      List<P2<K,V>>toListReverse() 
      java.util.Map<K,V>toMutableMap() +
      A mutable map projection of this tree map.
      +
      Stream<P2<K,V>>toStream() 
      Stream<P2<K,V>>toStreamReverse() 
      java.lang.StringtoString() 
      static <K,V> TreeMap<K,V>treeMap(Ord<K> keyOrd, + P2<K,V>... p2s) +
      Constructs a tree map from the given elements.
      +
      TreeMap<K,V>union(java.lang.Iterable<P2<K,V>> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      TreeMap<K,V>union(TreeMap<K,V> t2) +
      The expression t1.union(t2) takes the left-biased union of t1 + and t2.
      +
      P2<java.lang.Boolean,TreeMap<K,V>>update(K k, + F<V,V> f) +
      Modifies the value for the given key, if present, by applying the given function to it.
      +
      TreeMap<K,V>update(K k, + F<V,V> f, + V v) +
      Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
      +
      List<V>values() +
      Returns all values in this tree map.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static <K,V> TreeMap<K,V> empty(Ord<K> keyOrd)
        +
        Constructs an empty tree map.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        Returns:
        +
        an empty TreeMap with the given key order.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> treeMap(Ord<K> keyOrd,
+                                                       P2<K,V>... p2s)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        p2s - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iterableTreeMap

        +
        public static <K,V> TreeMap<K,V> iterableTreeMap(Ord<K> keyOrd,
+                                                 java.lang.Iterable<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        iteratorTreeMap

        +
        public static <K,V> TreeMap<K,V> iteratorTreeMap(Ord<K> keyOrd,
+                                                 java.util.Iterator<P2<K,V>> it)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        it - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + +
        +
      • +

        arrayTreeMap

        +
        @SafeVarargs
+public static <K,V> TreeMap<K,V> arrayTreeMap(Ord<K> keyOrd,
+                                                            P2<K,V>... ps)
        +
        Constructs a tree map from the given elements.
        +
        +
        Parameters:
        +
        keyOrd - An order for the keys of the tree map.
        +
        ps - The elements to construct the tree map with.
        +
        Returns:
        +
        A TreeMap with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public Option<V> get(K k)
        +
        Returns a potential value that the given key maps to.
        +
        +
        Parameters:
        +
        k - The key to look up in the tree map.
        +
        Returns:
        +
        A potential value for the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public TreeMap<K,V> set(K k,
+                        V v)
        +
        Inserts the given key and value association into the tree map. + If the given key is already mapped to a value, the old value is replaced with the given one.
        +
        +
        Parameters:
        +
        k - The key to insert.
        +
        v - The value to insert.
        +
        Returns:
        +
        A new tree map with the given value mapped to the given key.
        +
        +
        • +
      + + + + + +
        +
      • +

        delete

        +
        public TreeMap<K,V> delete(K k)
        +
        Deletes the entry in the tree map that corresponds to the given key.
        +
        +
        Parameters:
        +
        k - The key to delete from this tree map.
        +
        Returns:
        +
        A new tree map with the entry corresponding to the given key removed.
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of entries in this tree map.
        +
        +
        Returns:
        +
        The number of entries in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Determines if this tree map has any entries.
        +
        +
        Returns:
        +
        true if this tree map has no entries, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<V> values()
        +
        Returns all values in this tree map.
        +
        +
        Returns:
        +
        All values in this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        keys

        +
        public List<K> keys()
        +
        Returns all keys in this tree map.
        +
        +
        Returns:
        +
        All keys in this tree map.
        +
        +
        • +
      + + + + + +
        +
      • +

        contains

        +
        public boolean contains(K k)
        +
        Determines if the given key value exists in this tree map.
        +
        +
        Parameters:
        +
        k - The key value to look for in this tree map.
        +
        Returns:
        +
        true if this tree map contains the given key, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<P2<K,V>> iterator()
        +
        Returns an iterator for this map's key-value pairs. + This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<P2<K,V>>
        +
        Returns:
        +
        A iterator for this map's key-value pairs.
        +
        +
        • +
      + + + +
        +
      • +

        toMutableMap

        +
        public java.util.Map<K,V> toMutableMap()
        +
        A mutable map projection of this tree map.
        +
        +
        Returns:
        +
        A new mutable map isomorphic to this tree map.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        • +
      + + + +
        +
      • +

        toStreamReverse

        +
        public Stream<P2<K,V>> toStreamReverse()
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        • +
      + + + +
        +
      • +

        toListReverse

        +
        public List<P2<K,V>> toListReverse()
        +
        • +
      + + + +
        +
      • +

        fromMutableMap

        +
        public static <K,V> TreeMap<K,V> fromMutableMap(Ord<K> ord,
+                                                java.util.Map<K,V> m)
        +
        An immutable projection of the given mutable map.
        +
        +
        Parameters:
        +
        ord - An order for the map's keys.
        +
        m - A mutable map to project to an immutable one.
        +
        Returns:
        +
        A new immutable tree map isomorphic to the given mutable map.
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public F<K,Option<V>> get()
        +
        Returns a first-class version of the get method for this TreeMap.
        +
        +
        Returns:
        +
        a functional representation of this TreeMap.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public P2<java.lang.Boolean,TreeMap<K,V>> update(K k,
+                                                 F<V,V> f)
        +
        Modifies the value for the given key, if present, by applying the given function to it.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function, + paired with True if the map was modified, otherwise False.
        +
        +
        • +
      + + + + + +
        +
      • +

        update

        +
        public TreeMap<K,V> update(K k,
+                           F<V,V> f,
+                           V v)
        +
        Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
        +
        +
        Parameters:
        +
        k - The key for the value to modify.
        +
        f - A function with which to modify the value.
        +
        v - A value to associate with the given key if the key is not already present.
        +
        Returns:
        +
        A new tree map with the value for the given key transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        split

        +
        public P3<Set<V>,Option<V>,Set<V>> split(Ord<V> ord,
+                                         K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A set containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A set containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two sets and an optional value, where all elements in the first set are mapped to keys less than the given + key in this map, all the elements in the second set are mapped to keys greater than the given key, + and the optional value is the value associated with the given key if present, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        setTreeMap

        +
        public static <K,V> TreeMap<K,V> setTreeMap(Ord<K> ord,
+                                            Set<P2<K,Option<V>>> s)
        +
        Constructs a TreeMap from the given set.
        +
        +
        Parameters:
        +
        ord - An order for the keys of the tree map.
        +
        s - The elements to construct the tree map with.
        +
        Returns:
        +
        a TreeMap with the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        splitLookup

        +
        public P3<TreeMap<K,V>,Option<V>,TreeMap<K,V>> splitLookup(K k)
        +
        Splits this TreeMap at the given key. Returns a triple of: +
          +
        • A tree map containing all the values of this map associated with keys less than the given key.
          • +
        • An option of a value mapped to the given key, if it exists in this map, otherwise None. +
        • A tree map containing all the values of this map associated with keys greater than the given key.
          • +
        +
        +
        Parameters:
        +
        k - A key at which to split this map.
        +
        Returns:
        +
        Two tree maps and an optional value, where all keys in the first tree map are mapped + to keys less than the given key in this map, all the keys in the second tree map are mapped + to keys greater than the given key, and the optional value is the value associated with the + given key if present, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <W> TreeMap<K,W> map(F<V,W> f)
        +
        Maps the given function across the values of this TreeMap.
        +
        +
        Parameters:
        +
        f - A function to apply to the values of this TreeMap.
        +
        Returns:
        +
        A new TreeMap with the values transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public Option<P2<K,V>> min()
        +
        Returns the minimum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        minKey

        +
        public Option<K> minKey()
        +
        Returns the minimum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        max

        +
        public Option<P2<K,V>> max()
        +
        Returns the maximum (key, value) pair in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        maxKey

        +
        public Option<K> maxKey()
        +
        Returns the maximum key in the tree if the tree is not empty.
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(TreeMap<K,V> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other tree we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      + + + +
        +
      • +

        union

        +
        public TreeMap<K,V> union(java.lang.Iterable<P2<K,V>> t2)
        +
        The expression t1.union(t2) takes the left-biased union of t1 + and t2. It prefers t1 when duplicate keys are encountered.
        +
        +
        Parameters:
        +
        t2 - The other list/set of pairs we wish to combine with this one
        +
        Returns:
        +
        The combined TreeMap
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/TreeZipper.html b/javadoc/5.0/functionaljava/fj/data/TreeZipper.html new file mode 100644 index 0000000..93d2550 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/TreeZipper.html @@ -0,0 +1,1367 @@ + + + + + +TreeZipper (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class TreeZipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.TreeZipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<TreeZipper<A>>
    +
    +
    +
    +
    public final class TreeZipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<TreeZipper<A>>
    +
    Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree. + Provides navigation, insertion, deletion, and memorization of visited locations within a tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<TreeZipper<A>> iterator()
        +
        Returns an iterator of all the positions of this TreeZipper. Exists for use with the foreach syntax.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<TreeZipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this TreeZipper.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> TreeZipper<A> treeZipper(Tree<A> tree,
+                                           Stream<Tree<A>> lefts,
+                                           Stream<Tree<A>> rights,
+                                           Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents)
        +
        Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
        +
        +
        Parameters:
        +
        tree - The currently selected tree.
        +
        lefts - The selected tree's left siblings, closest first.
        +
        rights - The selected tree's right siblings, closest first.
        +
        parents - The parent of the selected tree, and the parent's siblings.
        +
        Returns:
        +
        A new zipper with the given tree selected, and the given forests on the left and right.
        +
        +
        • +
      + + + +
        +
      • +

        treeZipper

        +
        public static <A> F<Tree<A>,F<Stream<Tree<A>>,F<Stream<Tree<A>>,F<Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>>,TreeZipper<A>>>>> treeZipper()
        +
        First-class constructor for tree zippers.
        +
        +
        Returns:
        +
        A function that returns a new tree zipper, given a selected tree, left and right siblings, + and a parent context.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        eq

        +
        public static <A> Equal<TreeZipper<A>> eq(Equal<A> e)
        +
        An Equal instance for tree zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for tree elements.
        +
        Returns:
        +
        An Equal instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<TreeZipper<A>> show(Show<A> s)
        +
        A Show instance for tree zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for tree elements.
        +
        Returns:
        +
        A Show instance for tree zippers.
        +
        +
        • +
      + + + +
        +
      • +

        parent

        +
        public Option<TreeZipper<A>> parent()
        +
        Navigates to the parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the parent node of the current node, + or none if the current node is the root node.
        +
        +
        • +
      + + + +
        +
      • +

        root

        +
        public TreeZipper<A> root()
        +
        Navigates to the top-most parent of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the top-most parent of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        root_

        +
        public static <A> F<TreeZipper<A>,TreeZipper<A>> root_()
        +
        A first-class version of the root function.
        +
        +
        Returns:
        +
        A function that returns a new tree-zipper focused on the root of the given tree zipper's tree.
        +
        +
        • +
      + + + +
        +
      • +

        left

        +
        public Option<TreeZipper<A>> left()
        +
        Navigates to the left sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the left sibling of the current node, + or none if there are no siblings on the left.
        +
        +
        • +
      + + + +
        +
      • +

        right

        +
        public Option<TreeZipper<A>> right()
        +
        Navigates to the right sibling of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the right sibling of the current node, + or none if there are no siblings on the right.
        +
        +
        • +
      + + + +
        +
      • +

        firstChild

        +
        public Option<TreeZipper<A>> firstChild()
        +
        Navigtes to the first child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the first child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        lastChild

        +
        public Option<TreeZipper<A>> lastChild()
        +
        Navigtes to the last child of the current location.
        +
        +
        Returns:
        +
        A new tree zipper focused on the last child of the current node, or none if the node has no children.
        +
        +
        • +
      + + + +
        +
      • +

        getChild

        +
        public Option<TreeZipper<A>> getChild(int n)
        +
        Navigates to the given child of the current location, starting at index 0.
        +
        +
        Parameters:
        +
        n - The index of the child to which to navigate.
        +
        Returns:
        +
        An optional tree zipper focused on the child node at the given index, or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public Option<TreeZipper<A>> findChild(F<Tree<A>,java.lang.Boolean> p)
        +
        Navigates to the first child of the current location, that satisfies the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to be satisfied by the child node.
        +
        Returns:
        +
        An optional tree zipper focused on the first child node that satisfies the given predicate, + or none if there is no such child.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> TreeZipper<A> fromTree(Tree<A> t)
        +
        Creates a new tree zipper focused on the root of the given tree.
        +
        +
        Parameters:
        +
        t - A tree over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the root of the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        fromForest

        +
        public static <A> Option<TreeZipper<A>> fromForest(Stream<Tree<A>> ts)
        +
        Creates a new tree zipper focused on the first element of the given forest.
        +
        +
        Parameters:
        +
        ts - A forest over which to create a new zipper.
        +
        Returns:
        +
        a new tree zipper focused on the first element of the given forest.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public Tree<A> toTree()
        +
        Returns the tree containing this location.
        +
        +
        Returns:
        +
        the tree containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        toForest

        +
        public Stream<Tree<A>> toForest()
        +
        Returns the forest containing this location.
        +
        +
        Returns:
        +
        the forest containing this location.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public Tree<A> focus()
        +
        Returns the tree at the currently focused node.
        +
        +
        Returns:
        +
        the tree at the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<Tree<A>> lefts()
        +
        Returns the left siblings of the currently focused node.
        +
        +
        Returns:
        +
        the left siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<Tree<A>> rights()
        +
        Returns the right siblings of the currently focused node.
        +
        +
        Returns:
        +
        the right siblings of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        parents

        +
        public Stream<P3<Stream<Tree<A>>,A,Stream<Tree<A>>>> parents()
        +
        Returns the parents of the currently focused node.
        +
        +
        Returns:
        +
        the parents of the currently focused node.
        +
        +
        • +
      + + + +
        +
      • +

        isRoot

        +
        public boolean isRoot()
        +
        Indicates whether the current node is at the top of the tree.
        +
        +
        Returns:
        +
        true if the current node is the root of the tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isFirst

        +
        public boolean isFirst()
        +
        Indicates whether the current node is the leftmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no left siblings, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLast

        +
        public boolean isLast()
        +
        Indicates whether the current node is the rightmost tree in the current forest.
        +
        +
        Returns:
        +
        true if the current node has no siblings on its right, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isLeaf

        +
        public boolean isLeaf()
        +
        Indicates whether the current node is at the bottom of the tree.
        +
        +
        Returns:
        +
        true if the current node has no child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        isChild

        +
        public boolean isChild()
        +
        Indicates whether the current node is a child node of another node.
        +
        +
        Returns:
        +
        true if the current node has a parent node, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        hasChildren

        +
        public boolean hasChildren()
        +
        Indicates whether the current node has any child nodes.
        +
        +
        Returns:
        +
        true if the current node has child nodes, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        setTree

        +
        public TreeZipper<A> setTree(Tree<A> t)
        +
        Replaces the current node with the given tree.
        +
        +
        Parameters:
        +
        t - A tree with which to replace the current node.
        +
        Returns:
        +
        A new tree zipper in which the focused node is replaced with the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        modifyTree

        +
        public TreeZipper<A> modifyTree(F<Tree<A>,Tree<A>> f)
        +
        Modifies the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to modify the current tree.
        +
        Returns:
        +
        A new tree zipper in which the focused node has been transformed by the given function.
        +
        +
        • +
      + + + +
        +
      • +

        modifyLabel

        +
        public TreeZipper<A> modifyLabel(F<A,A> f)
        +
        Modifies the label at the current node with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to transform the current node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label transformed by the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        setLabel

        +
        public TreeZipper<A> setLabel(A v)
        +
        Replaces the label of the current node with the given value.
        +
        +
        Parameters:
        +
        v - The new value for the node's label.
        +
        Returns:
        +
        A new tree zipper with the focused node's label replaced by the given value.
        +
        +
        • +
      + + + +
        +
      • +

        getLabel

        +
        public A getLabel()
        +
        Returns the label at the current node.
        +
        +
        Returns:
        +
        the label at the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertLeft

        +
        public TreeZipper<A> insertLeft(Tree<A> t)
        +
        Inserts a tree to the left of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the left of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the right.
        +
        +
        • +
      + + + +
        +
      • +

        insertRight

        +
        public TreeZipper<A> insertRight(Tree<A> t)
        +
        Inserts a tree to the right of the current position. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert to the right of the current position.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus and the current tree on the left.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownFirst

        +
        public TreeZipper<A> insertDownFirst(Tree<A> t)
        +
        Inserts a tree as the first child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the first child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownLast

        +
        public TreeZipper<A> insertDownLast(Tree<A> t)
        +
        Inserts a tree as the last child of the current node. The inserted tree becomes the current tree.
        +
        +
        Parameters:
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, as the last child of the current node.
        +
        +
        • +
      + + + +
        +
      • +

        insertDownAt

        +
        public Option<TreeZipper<A>> insertDownAt(int n,
+                                          Tree<A> t)
        +
        Inserts a tree at the specified location in the current node's stream of children. The inserted tree + becomes the current node.
        +
        +
        Parameters:
        +
        n - The index at which to insert the given tree, starting at 0.
        +
        t - A tree to insert.
        +
        Returns:
        +
        A new tree zipper with the given tree in focus, at the specified index in the current node's stream + of children, or None if the current node has fewer than n children.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public Option<TreeZipper<A>> delete()
        +
        Removes the current node from the tree. The new position becomes the right sibling, or the left sibling + if the current node has no right siblings, or the parent node if the current node has no siblings.
        +
        +
        Returns:
        +
        A new tree zipper with the current node removed.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public TreeZipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the nodes in this zipper with a boolean that indicates whether that node has focus. + All of the booleans will be false, except for the focused node.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each node of this zipper paired with a boolean that is true if that + node has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> TreeZipper<B> map(F<A,B> f)
        +
        Maps the given function across this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to the label of every node.
        +
        +
        • +
      + + + +
        +
      • +

        fromTree

        +
        public static <A> F<Tree<A>,TreeZipper<A>> fromTree()
        +
        First-class conversion of a Tree to the corresponding tree zipper.
        +
        +
        Returns:
        +
        A function that takes a tree to its tree zipper representation.
        +
        +
        • +
      + + + +
        +
      • +

        left_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> left_()
        +
        A first-class version of the left() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its left sibling.
        +
        +
        • +
      + + + +
        +
      • +

        right_

        +
        public static <A> F<TreeZipper<A>,Option<TreeZipper<A>>> right_()
        +
        A first-class version of the right() function.
        +
        +
        Returns:
        +
        A function that focuses the given tree zipper on its right sibling.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public TreeZipper<TreeZipper<A>> positions()
        +
        Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern). + This tree zipper becomes the focused node of the new zipper.
        +
        +
        Returns:
        +
        A tree zipper over the tree of all possible permutations of this tree zipper.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> TreeZipper<B> cobind(F<TreeZipper<A>,B> f)
        +
        Maps the given function over the tree of all positions for this zipper (comonad pattern). Returns a zipper + over the tree of results of the function application.
        +
        +
        Parameters:
        +
        f - A function to map over the tree of all positions for this zipper.
        +
        Returns:
        +
        A zipper over the tree of results of the function application.
        +
        +
        • +
      + + + +
        +
      • +

        findChild

        +
        public static <A> F2<F<Tree<A>,java.lang.Boolean>,TreeZipper<A>,Option<TreeZipper<A>>> findChild()
        +
        A first-class version of the findChild function.
        +
        +
        Returns:
        +
        a function that finds the first child, of a given tree zipper, that matches a given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F2<A,B,C> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> TreeZipper<C> zipWith(TreeZipper<B> bs,
+                                   F<A,F<B,C>> f)
        +
        Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions. + The structure of the resulting TreeZipper is the structural intersection of the two TreeZippers.
        +
        +
        Parameters:
        +
        bs - A TreeZipper to zip this one with.
        +
        f - A function with which to zip together the two TreeZippers.
        +
        Returns:
        +
        The result of applying the given function over this TreeZipper and the given TreeZipper, location-wise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Validation.FailProjection.html b/javadoc/5.0/functionaljava/fj/data/Validation.FailProjection.html new file mode 100644 index 0000000..7f3454f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Validation.FailProjection.html @@ -0,0 +1,677 @@ + + + + + +Validation.FailProjection (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Validation.FailProjection<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation.FailProjection<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>
    +
    +
    +
    Enclosing class:
    +
    Validation<E,T>
    +
    +
    +
    +
    public static final class Validation.FailProjection<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<E>
    +
    A failing projection of a validation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <A> Validation<A,T>apply(Validation<F<E,A>,T> v) +
      Function application on the failing value.
      +
      <A> Validation<A,T>bind(F<E,Validation<A,T>> f) +
      Binds the given function across this validation's failing value if it has one.
      +
      booleanexists(F<E,java.lang.Boolean> f) +
      Returns false if this is a success or returns the result of the application of the given + function to the failing value.
      +
      EfailE(F0<java.lang.String> err) +
      Returns the failing value or fails with the given error message.
      +
      EfailE(java.lang.String err) +
      Returns the failing value or fails with the given error message.
      +
      <A> Option<Validation<E,A>>filter(F<E,java.lang.Boolean> f) +
      Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
      +
      booleanforall(F<E,java.lang.Boolean> f) +
      Returns true if this is a success or returns the result of the application of the given + function to the failing value.
      +
      Unitforeach(F<E,Unit> f) +
      Executes a side-effect on the failing value if there is one.
      +
      voidforeachDoEffect(Effect1<E> f) +
      Executes a side-effect on the failing value if there is one.
      +
      java.util.Iterator<E>iterator() +
      Returns an iterator for this projection.
      +
      <A> Validation<A,T>map(F<E,A> f) +
      Maps the given function across the failing side of this validation.
      +
      Eon(F<T,E> f) +
      The failing value or the application of the given function to the success value.
      +
      EorFail(E e) +
      Returns the failing value or the given value.
      +
      EorFail(F0<E> e) +
      Returns the failing value or the given value.
      +
      <A> Validation<A,T>sequence(Validation<A,T> v) +
      Performs a bind across the validation, but ignores the element value in the function.
      +
      Array<E>toArray() +
      Returns a single element array if this is a failing value, otherwise an empty list.
      +
      List<E>toList() +
      Returns a single element list if this is a failing value, otherwise an empty list.
      +
      Option<E>toOption() +
      Returns the failing value in Some if there is one, otherwise None.
      +
      Stream<E>toStream() +
      Returns a single element stream if this is a failing value, otherwise an empty list.
      +
      Validation<E,T>validation() +
      Returns the underlying validation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validation

        +
        public Validation<E,T> validation()
        +
        Returns the underlying validation.
        +
        +
        Returns:
        +
        The underlying validation.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(F0<java.lang.String> err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        failE

        +
        public E failE(java.lang.String err)
        +
        Returns the failing value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The failing value.
        +
        +
        • +
      + + + +
        +
      • +

        orFail

        +
        public E orFail(F0<E> e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orFail

        +
        public E orFail(E e)
        +
        Returns the failing value or the given value.
        +
        +
        Parameters:
        +
        e - The value to return if this is success.
        +
        Returns:
        +
        The failing value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public E on(F<T,E> f)
        +
        The failing value or the application of the given function to the success value.
        +
        +
        Parameters:
        +
        f - The function to execute on the success value.
        +
        Returns:
        +
        The failing value or the application of the given function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public Unit foreach(F<E,Unit> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public void foreachDoEffect(Effect1<E> f)
        +
        Executes a side-effect on the failing value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <A> Validation<A,T> map(F<E,A> f)
        +
        Maps the given function across the failing side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <A> Validation<A,T> bind(F<E,Validation<A,T>> f)
        +
        Binds the given function across this validation's failing value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <A> Validation<A,T> sequence(Validation<A,T> v)
        +
        Performs a bind across the validation, but ignores the element value in the function.
        +
        +
        Parameters:
        +
        v - The validation value to apply in the final join.
        +
        Returns:
        +
        A new validation value after the final join.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public <A> Option<Validation<E,A>> filter(F<E,java.lang.Boolean> f)
        +
        Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <A> Validation<A,T> apply(Validation<F<E,A>,T> v)
        +
        Function application on the failing value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the failing value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public boolean forall(F<E,java.lang.Boolean> f)
        +
        Returns true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        true if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(F<E,java.lang.Boolean> f)
        +
        Returns false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this failing value.
        +
        Returns:
        +
        false if this is a success or returns the result of the application of the given + function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<E> toList()
        +
        Returns a single element list if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public Option<E> toOption()
        +
        Returns the failing value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The failing value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<E> toArray()
        +
        Returns a single element array if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<E> toStream()
        +
        Returns a single element stream if this is a failing value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a failing value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        Returns an iterator for this projection. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Returns:
        +
        A iterator for this projection.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Validation.html b/javadoc/5.0/functionaljava/fj/data/Validation.html new file mode 100644 index 0000000..9204ef0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Validation.html @@ -0,0 +1,3041 @@ + + + + + +Validation (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
fj.data
+

Class Validation<E,T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Validation<E,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<T>
    +
    +
    +
    +
    public class Validation<E,T>
+extends java.lang.Object
+implements java.lang.Iterable<T>
    +
    Isomorphic to Either but has renamed functions and represents failure on the left and success on the right. + This type also has accumulating functions that accept a Semigroup for binding computation while keeping error + values
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parseByte

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Byte>> parseByte
        +
        A function that parses a string into a byte.
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Double>> parseDouble
        +
        A function that parses a string into a double.
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Float>> parseFloat
        +
        A function that parses a string into a float.
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Integer>> parseInt
        +
        A function that parses a string into an integer.
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Long>> parseLong
        +
        A function that parses a string into a long.
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static final F<java.lang.String,Validation<java.lang.NumberFormatException,java.lang.Short>> parseShort
        +
        A function that parses a string into a short.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Validation

        +
        protected Validation(Either<E,T> e)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isFail

        +
        public final boolean isFail()
        +
        Returns true if this is a failure, false otherwise.
        +
        +
        Returns:
        +
        true if this is a failure, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        isSuccess

        +
        public final boolean isSuccess()
        +
        Returns true if this is a success, false otherwise.
        +
        +
        Returns:
        +
        true if this is a success, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        fail

        +
        public final E fail()
        +
        Returns the failing value, or throws an error if there is no failing value.
        +
        +
        Returns:
        +
        the failing value, or throws an error if there is no failing value.
        +
        +
        • +
      + + + +
        +
      • +

        success

        +
        public final T success()
        +
        Returns the success value, or throws an error if there is no success value.
        +
        +
        Returns:
        +
        the success value, or throws an error if there is no success value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public final <X> X validation(F<E,X> fail,
+                              F<T,X> success)
        +
        The catamorphism for validation. Folds over this validation breaking into left or right.
        +
        +
        Parameters:
        +
        fail - The function to call if this failed.
        +
        success - The function to call if this succeeded.
        +
        Returns:
        +
        The reduced value.
        +
        +
        • +
      + + + +
        +
      • +

        f

        +
        public final Validation.FailProjection<E,T> f()
        +
        Returns a failing projection of this validation.
        +
        +
        Returns:
        +
        a failing projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        toEither

        +
        public final Either<E,T> toEither()
        +
        Returns an either projection of this validation.
        +
        +
        Returns:
        +
        An either projection of this validation.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(F0<java.lang.String> err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        successE

        +
        public final T successE(java.lang.String err)
        +
        Returns the success value or fails with the given error message.
        +
        +
        Parameters:
        +
        err - The error message to fail with.
        +
        Returns:
        +
        The success value.
        +
        +
        • +
      + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(F0<T> t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        orSuccess

        +
        public final T orSuccess(T t)
        +
        Returns the success value or the given value.
        +
        +
        Parameters:
        +
        t - The value to return if this is failure.
        +
        Returns:
        +
        The success value or the given value.
        +
        +
        • +
      + + + +
        +
      • +

        on

        +
        public final T on(F<E,T> f)
        +
        The success value or the application of the given function to the failing value.
        +
        +
        Parameters:
        +
        f - The function to execute on the failing value.
        +
        Returns:
        +
        The success value or the application of the given function to the failing value.
        +
        +
        • +
      + + + +
        +
      • +

        foreach

        +
        public final Unit foreach(F<T,Unit> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        Returns:
        +
        The unit value.
        +
        +
        • +
      + + + +
        +
      • +

        foreachDoEffect

        +
        public final void foreachDoEffect(Effect1<T> f)
        +
        Executes a side-effect on the success value if there is one.
        +
        +
        Parameters:
        +
        f - The side-effect to execute.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <A> Validation<E,A> map(F<T,A> f)
        +
        Maps the given function across the success side of this validation.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A new validation with the function mapped.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public final <A> Validation<E,A> bind(F<T,Validation<E,A>> f)
        +
        Binds the given function across this validation's success value if it has one.
        +
        +
        Parameters:
        +
        f - The function to bind across this validation.
        +
        Returns:
        +
        A new validation value after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public final <A> Validation<E,A> sequence(Validation<E,A> v)
        +
        Anonymous bind through this validation.
        +
        +
        Parameters:
        +
        v - The value to bind with.
        +
        Returns:
        +
        A validation after binding.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <E,A> Validation<E,List<A>> sequence(Semigroup<E> s,
+                                                   List<Validation<E,A>> list)
        +
        If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <A> Option<Validation<A,T>> filter(F<T,java.lang.Boolean> f)
        +
        Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public final <A> Validation<E,A> apply(Validation<E,F<T,A>> v)
        +
        Function application on the success value.
        +
        +
        Parameters:
        +
        v - The validation of the function to apply on the success value.
        +
        Returns:
        +
        The result of function application in validation.
        +
        +
        • +
      + + + +
        +
      • +

        forall

        +
        public final boolean forall(F<T,java.lang.Boolean> f)
        +
        Returns true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        true if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public final boolean exists(F<T,java.lang.Boolean> f)
        +
        Returns false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        Parameters:
        +
        f - The predicate function to test on this success value.
        +
        Returns:
        +
        false if this is a failure or returns the result of the application of the given + function to the success value.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public final List<T> toList()
        +
        Returns a single element list if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element list if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toOption

        +
        public final Option<T> toOption()
        +
        Returns the success value in Some if there is one, otherwise None.
        +
        +
        Returns:
        +
        The success value in Some if there is one, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public final Array<T> toArray()
        +
        Returns a single element array if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element array if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public final Stream<T> toStream()
        +
        Returns a single element stream if this is a success value, otherwise an empty list.
        +
        +
        Returns:
        +
        A single element stream if this is a success value, otherwise an empty list.
        +
        +
        • +
      + + + +
        +
      • +

        accumapply

        +
        public final <A> Validation<E,A> accumapply(Semigroup<E> s,
+                                            Validation<E,F<T,A>> v)
        +
        Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if
        +
        v - The validating function to apply.
        +
        Returns:
        +
        A failing validation if this or the given validation failed (with errors accumulated if both) or a + succeeding validation if both succeeded.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F<T,F<A,B>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Validation<E,B> accumulate(Semigroup<E> s,
+                                              Validation<E,A> va,
+                                              F2<T,A,B> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A> Option<E> accumulate(Semigroup<E> s,
+                                      Validation<E,A> va)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F<T,F<A,F<B,C>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Validation<E,C> accumulate(Semigroup<E> s,
+                                                Validation<E,A> va,
+                                                Validation<E,B> vb,
+                                                F3<T,A,B,C> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B> Option<E> accumulate(Semigroup<E> s,
+                                        Validation<E,A> va,
+                                        Validation<E,B> vb)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F<T,F<A,F<B,F<C,D>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Validation<E,D> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  F4<T,A,B,C,D> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C> Option<E> accumulate(Semigroup<E> s,
+                                          Validation<E,A> va,
+                                          Validation<E,B> vb,
+                                          Validation<E,C> vc)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F<T,F<A,F<B,F<C,F<D,E$>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Validation<E,E$> accumulate(Semigroup<E> s,
+                                                      Validation<E,A> va,
+                                                      Validation<E,B> vb,
+                                                      Validation<E,C> vc,
+                                                      Validation<E,D> vd,
+                                                      F5<T,A,B,C,D,E$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D> Option<E> accumulate(Semigroup<E> s,
+                                            Validation<E,A> va,
+                                            Validation<E,B> vb,
+                                            Validation<E,C> vc,
+                                            Validation<E,D> vd)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F<T,F<A,F<B,F<C,F<D,F<E$,F$>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Validation<E,F$> accumulate(Semigroup<E> s,
+                                                         Validation<E,A> va,
+                                                         Validation<E,B> vb,
+                                                         Validation<E,C> vc,
+                                                         Validation<E,D> vd,
+                                                         Validation<E,E$> ve,
+                                                         F6<T,A,B,C,D,E$,F$> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$> Option<E> accumulate(Semigroup<E> s,
+                                               Validation<E,A> va,
+                                               Validation<E,B> vb,
+                                               Validation<E,C> vc,
+                                               Validation<E,D> vd,
+                                               Validation<E,E$> ve)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Validation<E,G> accumulate(Semigroup<E> s,
+                                                          Validation<E,A> va,
+                                                          Validation<E,B> vb,
+                                                          Validation<E,C> vc,
+                                                          Validation<E,D> vd,
+                                                          Validation<E,E$> ve,
+                                                          Validation<E,F$> vf,
+                                                          F7<T,A,B,C,D,E$,F$,G> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$> Option<E> accumulate(Semigroup<E> s,
+                                                  Validation<E,A> va,
+                                                  Validation<E,B> vb,
+                                                  Validation<E,C> vc,
+                                                  Validation<E,D> vd,
+                                                  Validation<E,E$> ve,
+                                                  Validation<E,F$> vf)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F<T,F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>>> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G,H> Validation<E,H> accumulate(Semigroup<E> s,
+                                                            Validation<E,A> va,
+                                                            Validation<E,B> vb,
+                                                            Validation<E,C> vc,
+                                                            Validation<E,D> vd,
+                                                            Validation<E,E$> ve,
+                                                            Validation<E,F$> vf,
+                                                            Validation<E,G> vg,
+                                                            F8<T,A,B,C,D,E$,F$,G,H> f)
        +
        Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        f - The function to apply if all validations have succeeded.
        +
        Returns:
        +
        A succeeding validation if all validations succeeded, or a failing validation with errors accumulated if + one or more failed.
        +
        +
        • +
      + + + +
        +
      • +

        accumulate

        +
        public final <A,B,C,D,E$,F$,G> Option<E> accumulate(Semigroup<E> s,
+                                                    Validation<E,A> va,
+                                                    Validation<E,B> vb,
+                                                    Validation<E,C> vc,
+                                                    Validation<E,D> vd,
+                                                    Validation<E,E$> ve,
+                                                    Validation<E,F$> vf,
+                                                    Validation<E,G> vg)
        +
        Accumulates errors anonymously.
        +
        +
        Parameters:
        +
        s - The semigroup to accumulate errors with if one or more validations fail.
        +
        va - The second validation to accumulate errors with if it failed.
        +
        vb - The third validation to accumulate errors with if it failed.
        +
        vc - The fourth validation to accumulate errors with if it failed.
        +
        vd - The fifth validation to accumulate errors with if it failed.
        +
        ve - The sixth validation to accumulate errors with if it failed.
        +
        vf - The seventh validation to accumulate errors with if it failed.
        +
        vg - The eighth validation to accumulate errors with if it failed.
        +
        Returns:
        +
        A Some if one or more validations failed (accumulated with the semigroup), otherwise, + None.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public final java.util.Iterator<T> iterator()
        +
        Returns an iterator for this validation. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<T>
        +
        Returns:
        +
        A iterator for this validation.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        sequenceNonCumulative

        +
        public static <A,E> Validation<List<E>,List<A>> sequenceNonCumulative(List<Validation<E,A>> list)
        +
        If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values. Does not accumulate the failures into a + single failure using a semigroup.
        +
        • +
      + + + +
        +
      • +

        sequenceEitherLeft

        +
        public static final <E,R,C> Either<Validation<E,C>,R> sequenceEitherLeft(Validation<E,Either<C,R>> validation)
        +
        Sequence the given validation and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        R - the type of the right value
        +
        C - the type of the left value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceEitherRight

        +
        public static final <E,L,C> Either<L,Validation<E,C>> sequenceEitherRight(Validation<E,Either<L,C>> validation)
        +
        Sequence the given validation and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the right value
        +
        L - the type of the left value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the either
        +
        +
        • +
      + + + +
        +
      • +

        sequenceF

        +
        public static final <E,C,B> F<C,Validation<E,B>> sequenceF(Validation<E,F<C,B>> validation)
        +
        Sequence the given validation and collect the output as a function.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of input value
        +
        B - the type of output value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        sequenceIO

        +
        public static final <E,C> IO<Validation<E,C>> sequenceIO(Validation<E,IO<C>> validation)
        +
        Sequence the given validation and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the IO value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        sequenceList

        +
        public static final <E,C> List<Validation<E,C>> sequenceList(Validation<E,List<C>> validation)
        +
        Sequence the given validation and collect the output as a list.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the list value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        sequenceOption

        +
        public static final <E,C> Option<Validation<E,C>> sequenceOption(Validation<E,Option<C>> validation)
        +
        Sequence the given validation and collect the output as an option.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the option value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the option
        +
        +
        • +
      + + + +
        +
      • +

        sequenceP1

        +
        public static final <E,C> P1<Validation<E,C>> sequenceP1(Validation<E,P1<C>> validation)
        +
        Sequence the given validation and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the P1 value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSeq

        +
        public static final <E,C> Seq<Validation<E,C>> sequenceSeq(Validation<E,Seq<C>> validation)
        +
        Sequence the given validation and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the seq value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        sequenceSet

        +
        public static final <E,C> Set<Validation<E,C>> sequenceSet(Ord<E> ordE,
+                                                           Ord<C> ordC,
+                                                           Validation<E,Set<C>> validation)
        +
        Sequence the given validation and collect the output as a set.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the set value
        +
        Parameters:
        +
        ordE - the given failure value ord
        +
        ordC - the given success value ord
        +
        validation - the given validation
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        sequenceStream

        +
        public static final <E,C> Stream<Validation<E,C>> sequenceStream(Validation<E,Stream<C>> validation)
        +
        Sequence the given validation and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the stream value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        sequenceTrampoline

        +
        public static final <E,C> Trampoline<Validation<E,C>> sequenceTrampoline(Validation<E,Trampoline<C>> validation)
        +
        Sequence the given validation and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        C - the type of the trampoline value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + +
        +
      • +

        sequenceValidation

        +
        public static final <E,E1,C> Validation<E1,Validation<E,C>> sequenceValidation(Validation<E,Validation<E1,C>> validation)
        +
        Sequence the given validation and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E - the type of the failure value
        +
        E1 - the type of the failure value
        +
        C - the type of the success value
        +
        Parameters:
        +
        validation - the given validation
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherLeft

        +
        public final <R,C> Either<Validation<E,C>,R> traverseEitherLeft(F<T,Either<C,R>> f)
        +
        Traverse this validation with the given function and collect the output on the left side of an either.
        +
        +
        Type Parameters:
        +
        C - the type of the left value
        +
        R - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseEitherRight

        +
        public final <L,C> Either<L,Validation<E,C>> traverseEitherRight(F<T,Either<L,C>> f)
        +
        Traverse this validation with the given function and collect the output on the right side of an either.
        +
        +
        Type Parameters:
        +
        L - the type of the left value
        +
        C - the type of the right value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseF

        +
        public final <C,B> F<C,Validation<E,B>> traverseF(F<T,F<C,B>> f)
        +
        Traverse this validation with the given function and collect the output as a function.
        +
        +
        Type Parameters:
        +
        C - the type of the input value
        +
        B - the type of the output value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the function
        +
        +
        • +
      + + + +
        +
      • +

        traverseIO

        +
        public final <C> IO<Validation<E,C>> traverseIO(F<T,IO<C>> f)
        +
        Traverse this validation with the given function and collect the output as an IO.
        +
        +
        Type Parameters:
        +
        C - the type of the IO value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the IO
        +
        +
        • +
      + + + +
        +
      • +

        traverseList

        +
        public final <C> List<Validation<E,C>> traverseList(F<T,List<C>> f)
        +
        Traverse this validation with the given function and collect the output as a list.
        +
        +
        Type Parameters:
        +
        C - the type of the list value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        traverseOption

        +
        public final <C> Option<Validation<E,C>> traverseOption(F<T,Option<C>> f)
        +
        Traverse this validation with the given function and collect the output as an option.
        +
        +
        Type Parameters:
        +
        C - the type of the option value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the option
        +
        +
        • +
      + + + +
        +
      • +

        traverseP1

        +
        public final <C> P1<Validation<E,C>> traverseP1(F<T,P1<C>> f)
        +
        Traverse this validation with the given function and collect the output as a P1.
        +
        +
        Type Parameters:
        +
        C - the type of the P1 value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the P1
        +
        +
        • +
      + + + +
        +
      • +

        traverseSeq

        +
        public final <C> Seq<Validation<E,C>> traverseSeq(F<T,Seq<C>> f)
        +
        Traverse this validation with the given function and collect the output as a seq.
        +
        +
        Type Parameters:
        +
        C - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the seq
        +
        +
        • +
      + + + +
        +
      • +

        traverseSet

        +
        public final <C> Set<Validation<E,C>> traverseSet(Ord<E> ordE,
+                                                  Ord<C> ordC,
+                                                  F<T,Set<C>> f)
        +
        Traverse this validation with the given function and collect the output as a set; use the given success and failure value ords to order the set.
        +
        +
        Type Parameters:
        +
        C - the type of the set value
        +
        Parameters:
        +
        ordE - the given failure value ord
        +
        ordC - the given success value ord
        +
        f - the given function
        +
        Returns:
        +
        the set
        +
        +
        • +
      + + + +
        +
      • +

        traverseStream

        +
        public final <C> Stream<Validation<E,C>> traverseStream(F<T,Stream<C>> f)
        +
        Traverse this validation with the given function and collect the output as a stream.
        +
        +
        Type Parameters:
        +
        C - the type of the stream value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the stream
        +
        +
        • +
      + + + +
        +
      • +

        traverseTrampoline

        +
        public final <C> Trampoline<Validation<E,C>> traverseTrampoline(F<T,Trampoline<C>> f)
        +
        Traverse this validation with the given function and collect the output as a trampoline.
        +
        +
        Type Parameters:
        +
        C - the type of the trampoline value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the trampoline
        +
        +
        • +
      + + + +
        +
      • +

        traverseValidation

        +
        public final <E1,C> Validation<E1,Validation<E,C>> traverseValidation(F<T,Validation<E1,C>> f)
        +
        Traverse this validation with the given function and collect the output as a validation.
        +
        +
        Type Parameters:
        +
        E1 - the type of the failure value
        +
        C - the type of the seq value
        +
        Parameters:
        +
        f - the given function
        +
        Returns:
        +
        the validation
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        nel

        +
        public final Validation<NonEmptyList<E>,T> nel()
        +
        Puts this validation's failing value in a non-empty list if there is one.
        +
        +
        Returns:
        +
        A validation with its failing value in a non-empty list if there is one.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> Validation<E,T> validation(Either<E,T> e)
        +
        Construct a validation using the given either value.
        +
        +
        Parameters:
        +
        e - The either value to construct a validation with.
        +
        Returns:
        +
        A validation using the given either value.
        +
        +
        • +
      + + + +
        +
      • +

        validation

        +
        public static <E,T> F<Either<E,T>,Validation<E,T>> validation()
        +
        Returns a function that constructs a validation with an either.
        +
        +
        Returns:
        +
        A function that constructs a validation with an either.
        +
        +
        • +
      + + + +
        +
      • +

        either

        +
        public static <E,T> F<Validation<E,T>,Either<E,T>> either()
        +
        Returns a function that constructs an either with a validation.
        +
        +
        Returns:
        +
        A function that constructs an either with a validation.
        +
        +
        • +
      + + + + + +
        +
      • +

        success

        +
        public static <E,T> Validation<E,T> success(T t)
        +
        Returns a succeeding validation containing the given value.
        +
        +
        Parameters:
        +
        t - The value to use in the succeeding validation.
        +
        Returns:
        +
        A succeeding validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <E,T> Validation<E,T> fail(E e)
        +
        Returns a failing validation containing the given value.
        +
        +
        Parameters:
        +
        e - The value to use in the failing validation.
        +
        Returns:
        +
        A failing validation containing the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        failNEL

        +
        public static <E,T> Validation<NonEmptyList<E>,T> failNEL(E e)
        +
        Returns a failing validation containing a non-empty list that contains the given value.
        +
        +
        Parameters:
        +
        e - The value to use in a non-empty list for the failing validation.
        +
        Returns:
        +
        A failing validation containing a non-empty list that contains the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        condition

        +
        public static <E,T> Validation<E,T> condition(boolean c,
+                                              E e,
+                                              T t)
        +
        Returns a validation based on a boolean condition. If the condition is true, the validation succeeds, + otherwise it fails.
        +
        +
        Parameters:
        +
        c - The condition to base the returned validation on.
        +
        e - The failing value to use if the condition is false.
        +
        t - The succeeding value to use if the condition is true.
        +
        Returns:
        +
        A validation based on a boolean condition.
        +
        +
        • +
      + + + +
        +
      • +

        parseByte

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Byte> parseByte(java.lang.String s)
        +
        Parses the given string into a byte.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse byte or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseDouble

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Double> parseDouble(java.lang.String s)
        +
        Parses the given string into a double.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse double or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseFloat

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Float> parseFloat(java.lang.String s)
        +
        Parses the given string into a float.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse float or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseInt

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Integer> parseInt(java.lang.String s)
        +
        Parses the given string into a integer.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse integer or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseLong

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Long> parseLong(java.lang.String s)
        +
        Parses the given string into a long.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse long or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        parseShort

        +
        public static Validation<java.lang.NumberFormatException,java.lang.Short> parseShort(java.lang.String s)
        +
        Parses the given string into a short.
        +
        +
        Parameters:
        +
        s - The string to parse.
        +
        Returns:
        +
        A successfully parse short or a failing exception.
        +
        +
        • +
      + + + +
        +
      • +

        partition

        +
        public static <A,B> P2<List<A>,List<B>> partition(List<Validation<A,B>> list)
        +
        Partitions the list into the list of fails and the list of successes
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Writer.html b/javadoc/5.0/functionaljava/fj/data/Writer.html new file mode 100644 index 0000000..fc63f81 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Writer.html @@ -0,0 +1,378 @@ + + + + + +Writer (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Writer<W,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Writer<W,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Writer<W,A>
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public P2<W,A> run()
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        • +
      + + + +
        +
      • +

        log

        +
        public W log()
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<W> monoid()
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     W w,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        unit

        +
        public static <W,A> Writer<W,A> unit(A a,
+                                     Monoid<W> m)
        +
        • +
      + + + + + +
        +
      • +

        tell

        +
        public Writer<W,A> tell(W w)
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Writer<W,B> map(F<A,B> f)
        +
        • +
      + + + + + + + + + +
        +
      • +

        unit

        +
        public static <B> Writer<java.lang.String,B> unit(B b)
        +
        • +
      + + + +
        +
      • +

        stringLogger

        +
        public static <A> F<A,Writer<java.lang.String,A>> stringLogger()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/Zipper.html b/javadoc/5.0/functionaljava/fj/data/Zipper.html new file mode 100644 index 0000000..3fdfde1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/Zipper.html @@ -0,0 +1,1285 @@ + + + + + +Zipper (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data
+

Class Zipper<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.Zipper<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<Zipper<A>>
    +
    +
    +
    +
    public final class Zipper<A>
+extends java.lang.Object
+implements java.lang.Iterable<Zipper<A>>
    +
    Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream. Focus can be moved forward and backwards through the stream, elements can be inserted + before or after the focused position, and the focused item can be deleted. +

    + Based on the pointedlist library by Jeff Wheeler.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanatEnd() +
      Returns whether the focus is on the last element.
      +
      booleanatStart() +
      Returns whether the focus is on the first element.
      +
      <B> Zipper<B>cobind(F<Zipper<A>,B> f) +
      Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
      +
      Zipper<A>cycleNext() +
      Move the focus to the next element.
      +
      Zipper<A>cyclePrevious() +
      Move the focus to the previous element.
      +
      Option<Zipper<A>>deleteLeft() +
      Possibly deletes the element at the focus, then moves the element on the left into focus.
      +
      Option<Zipper<A>>deleteLeftCycle() +
      Possibly deletes the element at the focus, then move the element on the left into focus.
      +
      Zipper<A>deleteOthers() +
      Deletes all elements in the zipper except the focus.
      +
      Option<Zipper<A>>deleteRight() +
      Possibly deletes the element at the focus, then moves the element on the right into focus.
      +
      Option<Zipper<A>>deleteRightCycle() +
      Possibly deletes the element at the focus, then move the element on the right into focus.
      +
      static <A> Equal<Zipper<A>>eq(Equal<A> e) +
      An Equal instance for Zippers.
      +
      booleanequals(java.lang.Object other) 
      Option<Zipper<A>>find(F<A,java.lang.Boolean> p) +
      Moves the focus to the element matching the given predicate, if present.
      +
      Afocus() +
      Returns the focus element of this zipper.
      +
      <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Performs a right-fold reduction across this zipper.
      +
      static <A> Option<Zipper<A>>fromStream(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      static <A> Option<Zipper<A>>fromStreamEnd(Stream<A> a) +
      Possibly create a zipper if the provided stream has at least one element, otherwise None.
      +
      inthashCode() 
      intindex() +
      Returns the index of the focus.
      +
      Zipper<A>insertLeft(A a) +
      Inserts an element to the left of the focus, then moves the focus to the new element.
      +
      Zipper<A>insertRight(A a) +
      Inserts an element to the right of the focus, then moves the focus to the new element.
      +
      java.util.Iterator<Zipper<A>>iterator() +
      Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
      +
      Stream<A>lefts() +
      Returns a Stream of the elements to the left of focus.
      +
      intlength() +
      Returns the length of this zipper.
      +
      <B> Zipper<B>map(F<A,B> f) +
      Maps the given function across the elements of this zipper (covariant functor pattern).
      +
      static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>>move() +
      A first-class version of the move function.
      +
      Option<Zipper<A>>move(int n) +
      Move the focus to the specified index.
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>next_() +
      First-class version of the next() function.
      +
      Option<Zipper<A>>next() +
      Possibly moves the focus to the next element in the list.
      +
      static <A> Ord<Zipper<A>>ord(Ord<A> o) +
      An Ord instance for Zippers.
      +
      static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>>p_() +
      A first-class function that yields the product-3 representation of a given Zipper.
      +
      P3<Stream<A>,A,Stream<A>>p() +
      Returns the product-3 representation of this Zipper.
      +
      Zipper<Zipper<A>>positions() +
      Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
      +
      static <A> F<Zipper<A>,Option<Zipper<A>>>previous_() +
      First-class version of the previous() function.
      +
      Option<Zipper<A>>previous() +
      Possibly moves the focus to the previous element in the list.
      +
      Zipper<A>replace(A a) +
      Replaces the element in focus with the given element.
      +
      Stream<A>rights() +
      Returns a Stream of the elements to the right of focus.
      +
      static <A> Show<Zipper<A>>show(Show<A> s) +
      A Show instance for Zippers.
      +
      static <A> Zipper<A>single(A a) +
      Creates a new zipper with a single element.
      +
      Stream<A>toStream() +
      Returns the Stream representation of this zipper.
      +
      Zipper<A>tryNext() +
      Attempts to move the focus to the next element, or throws an error if there are no more elements.
      +
      Zipper<A>tryPrevious() +
      Attempts to move the focus to the previous element, or throws an error if there are no more elements.
      +
      static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>>zipper() +
      First-class constructor of zippers.
      +
      static <A> Zipper<A>zipper(P3<Stream<A>,A,Stream<A>> p) +
      Creates a new Zipper from the given triple.
      +
      static <A> Zipper<A>zipper(Stream<A> left, + A focus, + Stream<A> right) +
      Creates a new Zipper with the given streams before and after the focus, and the given focused item.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F<A,F<B,C>> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      <B,C> Zipper<C>zipWith(Zipper<B> bs, + F2<A,B,C> f) +
      Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
      +
      Zipper<P2<A,java.lang.Boolean>>zipWithFocus() +
      Zips the elements of this zipper with a boolean that indicates whether that element has focus.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(Stream<A> left,
+                                   A focus,
+                                   Stream<A> right)
        +
        Creates a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        Parameters:
        +
        left - The stream of elements before the focus.
        +
        focus - The element under focus.
        +
        right - The stream of elements after the focus.
        +
        Returns:
        +
        a new Zipper with the given streams before and after the focus, and the given focused item.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> Zipper<A> zipper(P3<Stream<A>,A,Stream<A>> p)
        +
        Creates a new Zipper from the given triple.
        +
        +
        Parameters:
        +
        p - A triple of the elements before the focus, the focus element, and the elements after the focus, + respectively.
        +
        Returns:
        +
        a new Zipper created from the given triple.
        +
        +
        • +
      + + + +
        +
      • +

        zipper

        +
        public static <A> F3<Stream<A>,A,Stream<A>,Zipper<A>> zipper()
        +
        First-class constructor of zippers.
        +
        +
        Returns:
        +
        A function that yields a new zipper given streams on the left and right and a focus element.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<Stream<A>,A,Stream<A>> p()
        +
        Returns the product-3 representation of this Zipper.
        +
        +
        Returns:
        +
        the product-3 representation of this Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<Zipper<A>,P3<Stream<A>,A,Stream<A>>> p_()
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        Returns:
        +
        A first-class function that yields the product-3 representation of a given Zipper.
        +
        +
        • +
      + + + +
        +
      • +

        ord

        +
        public static <A> Ord<Zipper<A>> ord(Ord<A> o)
        +
        An Ord instance for Zippers.
        +
        +
        Parameters:
        +
        o - An Ord instance for the element type.
        +
        Returns:
        +
        An Ord instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        eq

        +
        public static <A> Equal<Zipper<A>> eq(Equal<A> e)
        +
        An Equal instance for Zippers.
        +
        +
        Parameters:
        +
        e - An Equal instance for the element type.
        +
        Returns:
        +
        An Equal instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        show

        +
        public static <A> Show<Zipper<A>> show(Show<A> s)
        +
        A Show instance for Zippers.
        +
        +
        Parameters:
        +
        s - A Show instance for the element type.
        +
        Returns:
        +
        A Show instance for Zippers.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Zipper<B> map(F<A,B> f)
        +
        Maps the given function across the elements of this zipper (covariant functor pattern).
        +
        +
        Parameters:
        +
        f - A function to map across this zipper.
        +
        Returns:
        +
        A new zipper with the given function applied to all elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> f,
+                       B z)
        +
        Performs a right-fold reduction across this zipper.
        +
        +
        Parameters:
        +
        f - The function to apply on each element of this zipper.
        +
        z - The beginning value to start the application from.
        +
        Returns:
        +
        the final result after the right-fold reduction.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <A> Zipper<A> single(A a)
        +
        Creates a new zipper with a single element.
        +
        +
        Parameters:
        +
        a - The focus element of the new zipper.
        +
        Returns:
        +
        a new zipper with a single element which is in focus.
        +
        +
        • +
      + + + +
        +
      • +

        fromStream

        +
        public static <A> Option<Zipper<A>> fromStream(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's head will be the focus of the zipper, and the rest of the stream will follow + on the right side.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        fromStreamEnd

        +
        public static <A> Option<Zipper<A>> fromStreamEnd(Stream<A> a)
        +
        Possibly create a zipper if the provided stream has at least one element, otherwise None. + The provided stream's last element will be the focus of the zipper, following the rest of the stream in order, + to the left.
        +
        +
        Parameters:
        +
        a - The stream from which to create a zipper.
        +
        Returns:
        +
        a new zipper if the provided stream has at least one element, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        focus

        +
        public A focus()
        +
        Returns the focus element of this zipper.
        +
        +
        Returns:
        +
        the focus element of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public Option<Zipper<A>> next()
        +
        Possibly moves the focus to the next element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryNext

        +
        public Zipper<A> tryNext()
        +
        Attempts to move the focus to the next element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the right, if there are elements to the right of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        previous

        +
        public Option<Zipper<A>> previous()
        +
        Possibly moves the focus to the previous element in the list.
        +
        +
        Returns:
        +
        An optional zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise None.
        +
        +
        • +
      + + + +
        +
      • +

        tryPrevious

        +
        public Zipper<A> tryPrevious()
        +
        Attempts to move the focus to the previous element, or throws an error if there are no more elements.
        +
        +
        Returns:
        +
        A zipper with the focus moved one element to the left, if there are elements to the left of + focus, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        next_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> next_()
        +
        First-class version of the next() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the next element.
        +
        +
        • +
      + + + +
        +
      • +

        previous_

        +
        public static <A> F<Zipper<A>,Option<Zipper<A>>> previous_()
        +
        First-class version of the previous() function.
        +
        +
        Returns:
        +
        A function that moves the given zipper's focus to the previous element.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertLeft

        +
        public Zipper<A> insertLeft(A a)
        +
        Inserts an element to the left of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its right.
        +
        +
        • +
      + + + + + +
        +
      • +

        insertRight

        +
        public Zipper<A> insertRight(A a)
        +
        Inserts an element to the right of the focus, then moves the focus to the new element.
        +
        +
        Parameters:
        +
        a - A new element to insert into this zipper.
        +
        Returns:
        +
        A new zipper with the given element in focus, and the current focus element on its left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeft

        +
        public Option<Zipper<A>> deleteLeft()
        +
        Possibly deletes the element at the focus, then moves the element on the left into focus. + If no element is on the left, focus on the element to the right. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRight

        +
        public Option<Zipper<A>> deleteRight()
        +
        Possibly deletes the element at the focus, then moves the element on the right into focus. + If no element is on the right, focus on the element to the left. + Returns None if the focus element is the only element in this zipper.
        +
        +
        Returns:
        +
        A new zipper with this zipper's focus element removed, or None if deleting the focus element + would cause the zipper to be empty.
        +
        +
        • +
      + + + +
        +
      • +

        deleteOthers

        +
        public Zipper<A> deleteOthers()
        +
        Deletes all elements in the zipper except the focus.
        +
        +
        Returns:
        +
        A new zipper with the focus element as the only element.
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the length of this zipper.
        +
        +
        Returns:
        +
        the length of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        atStart

        +
        public boolean atStart()
        +
        Returns whether the focus is on the first element.
        +
        +
        Returns:
        +
        true if the focus is on the first element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        atEnd

        +
        public boolean atEnd()
        +
        Returns whether the focus is on the last element.
        +
        +
        Returns:
        +
        true if the focus is on the last element, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        positions

        +
        public Zipper<Zipper<A>> positions()
        +
        Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
        +
        +
        Returns:
        +
        a zipper of variations of the provided zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers.
        +
        +
        • +
      + + + +
        +
      • +

        cobind

        +
        public <B> Zipper<B> cobind(F<Zipper<A>,B> f)
        +
        Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
        +
        +
        Parameters:
        +
        f - The comonadic function to apply for each variation of this zipper.
        +
        Returns:
        +
        A new zipper, with the given function applied for each variation of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        zipWithFocus

        +
        public Zipper<P2<A,java.lang.Boolean>> zipWithFocus()
        +
        Zips the elements of this zipper with a boolean that indicates whether that element has focus. + All of the booleans will be false, except the focused element.
        +
        +
        Returns:
        +
        A new zipper of pairs, with each element of this zipper paired with a boolean that is true if that + element has focus, and false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public Option<Zipper<A>> move(int n)
        +
        Move the focus to the specified index.
        +
        +
        Parameters:
        +
        n - The index to which to move the focus.
        +
        Returns:
        +
        A new zipper with the focus moved to the specified index, or none if there is no such index.
        +
        +
        • +
      + + + +
        +
      • +

        move

        +
        public static <A> F<java.lang.Integer,F<Zipper<A>,Option<Zipper<A>>>> move()
        +
        A first-class version of the move function.
        +
        +
        Returns:
        +
        A function that moves the focus of the given zipper to the given index.
        +
        +
        • +
      + + + +
        +
      • +

        find

        +
        public Option<Zipper<A>> find(F<A,java.lang.Boolean> p)
        +
        Moves the focus to the element matching the given predicate, if present.
        +
        +
        Parameters:
        +
        p - A predicate to match.
        +
        Returns:
        +
        A new zipper with the nearest matching element focused if it is present in this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        index

        +
        public int index()
        +
        Returns the index of the focus.
        +
        +
        Returns:
        +
        the index of the focus.
        +
        +
        • +
      + + + +
        +
      • +

        cycleNext

        +
        public Zipper<A> cycleNext()
        +
        Move the focus to the next element. If the last element is focused, loop to the first element.
        +
        +
        Returns:
        +
        A new zipper with the next element focused, unless the last element is currently focused, in which case + the first element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        cyclePrevious

        +
        public Zipper<A> cyclePrevious()
        +
        Move the focus to the previous element. If the first element is focused, loop to the last element.
        +
        +
        Returns:
        +
        A new zipper with the previous element focused, unless the first element is currently focused, + in which case the last element becomes focused.
        +
        +
        • +
      + + + +
        +
      • +

        deleteLeftCycle

        +
        public Option<Zipper<A>> deleteLeftCycle()
        +
        Possibly deletes the element at the focus, then move the element on the left into focus. If no element is on the + left, focus on the last element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the previous element to the left, or the last + element if there is no element to the left.
        +
        +
        • +
      + + + +
        +
      • +

        deleteRightCycle

        +
        public Option<Zipper<A>> deleteRightCycle()
        +
        Possibly deletes the element at the focus, then move the element on the right into focus. If no element is on the + right, focus on the first element. If the deletion will cause the list to be empty, return None.
        +
        +
        Returns:
        +
        A new zipper with the focused element removed, and focus on the next element to the right, or the first + element if there is no element to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public Zipper<A> replace(A a)
        +
        Replaces the element in focus with the given element.
        +
        +
        Parameters:
        +
        a - An element to replace the focused element with.
        +
        Returns:
        +
        A new zipper with the given element in focus.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns the Stream representation of this zipper.
        +
        +
        Returns:
        +
        A stream that contains all the elements of this zipper.
        +
        +
        • +
      + + + +
        +
      • +

        lefts

        +
        public Stream<A> lefts()
        +
        Returns a Stream of the elements to the left of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the left of focus.
        +
        +
        • +
      + + + +
        +
      • +

        rights

        +
        public Stream<A> rights()
        +
        Returns a Stream of the elements to the right of focus.
        +
        +
        Returns:
        +
        a Stream of the elements to the right of focus.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F2<A,B,C> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> Zipper<C> zipWith(Zipper<B> bs,
+                               F<A,F<B,C>> f)
        +
        Zips this Zipper with another, applying the given function lock-step over both zippers in both directions. + The structure of the resulting Zipper is the structural intersection of the two Zippers.
        +
        +
        Parameters:
        +
        bs - A Zipper to zip this one with.
        +
        f - A function with which to zip together the two Zippers.
        +
        Returns:
        +
        The result of applying the given function over this Zipper and the given Zipper, location-wise.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<Zipper<A>> iterator()
        +
        Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<Zipper<A>>
        +
        Returns:
        +
        An iterator of all the positions of this Zipper, starting from the leftmost position.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Deep.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Deep.html new file mode 100644 index 0000000..0cb1f51 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Deep.html @@ -0,0 +1,726 @@ + + + + + +Deep (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Deep<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Deep<V,A>
+extends FingerTree<V,A>
    +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prefix

        +
        public Digit<V,A> prefix()
        +
        Returns the first few elements of this tree.
        +
        +
        Returns:
        +
        the first few elements of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        middle

        +
        public FingerTree<V,Node<V,A>> middle()
        +
        Returns a finger tree of the inner nodes of this tree.
        +
        +
        Returns:
        +
        a finger tree of the inner nodes of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        suffix

        +
        public Digit<V,A> suffix()
        +
        Returns the last few elements of this tree.
        +
        +
        Returns:
        +
        the last few elements of this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the sum of the measurements of this tree's elements, according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the tree. Matches the function on the Deep tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Digit.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Digit.html new file mode 100644 index 0000000..fdb9080 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Digit.html @@ -0,0 +1,479 @@ + + + + + +Digit (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Digit<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Digit<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Four, One, Three, Two
    +
    +
    +
    +
    public abstract class Digit<V,A>
+extends java.lang.Object
    +
    A digit is a vector of 1-4 elements. Serves as a pointer to the prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Digit<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps a function across the elements of this digit, measuring with the given measurement.
      +
      abstract <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Vmeasure() +
      Returns the sum of the measurements of this digit according to the monoid.
      +
      AreduceLeft(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      AreduceRight(F<A,F<A,A>> f) +
      Folds this digit to the right using the given function.
      +
      abstract Stream<A>toStream() 
      java.lang.StringtoString() 
      FingerTree<V,A>toTree() +
      Returns the tree representation of this digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public final A reduceRight(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public final A reduceLeft(F<A,F<A,A>> f)
        +
        Folds this digit to the right using the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold this digit.
        +
        Returns:
        +
        The right reduction of this digit with the given function.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public final <B> Digit<V,B> map(F<A,B> f,
+                                Measured<V,B> m)
        +
        Maps a function across the elements of this digit, measuring with the given measurement.
        +
        +
        Parameters:
        +
        f - A function to map across the elements of this digit.
        +
        m - A measuring for the function's domain (destination type).
        +
        Returns:
        +
        A new digit with the same structure as this digit, but with all elements transformed + with the given function and measured with the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<One<V,A>,B> one,
+                            F<Two<V,A>,B> two,
+                            F<Three<V,A>,B> three,
+                            F<Four<V,A>,B> four)
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        Returns the sum of the measurements of this digit according to the monoid.
        +
        +
        Returns:
        +
        the sum of the measurements of this digit according to the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        toTree

        +
        public final FingerTree<V,A> toTree()
        +
        Returns the tree representation of this digit.
        +
        +
        Returns:
        +
        the tree representation of this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Empty.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Empty.html new file mode 100644 index 0000000..b546e1e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Empty.html @@ -0,0 +1,666 @@ + + + + + +Empty (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Empty<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Empty<V,A>
+extends FingerTree<V,A>
    +
    The empty tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A a)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns zero.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        Zero.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the empty tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/FingerTree.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/FingerTree.html new file mode 100644 index 0000000..1b885ce --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/FingerTree.html @@ -0,0 +1,869 @@ + + + + + +FingerTree (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class FingerTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.FingerTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    V - The monoidal type with which to annotate nodes.
    +
    A - The type of the tree's elements.
    +
    +
    +
    Direct Known Subclasses:
    +
    Deep, Empty, Single
    +
    +
    +
    +
    public abstract class FingerTree<V,A>
+extends java.lang.Object
    +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. +

    + This class serves as a datastructure construction kit, rather than a datastructure in its own right. By supplying + a monoid, a measurement function, insertion, deletion, and so forth, any purely functional datastructure can be + emulated. See Seq for an example. +

    + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract FingerTree<V,A>append(FingerTree<V,A> t) +
      Appends one finger tree to another.
      +
      abstract FingerTree<V,A>cons(A a) +
      Adds the given element to this tree as the first element.
      +
      static <V,A> FingerTree<V,A>empty(Monoid<V> m, + F<A,V> f) +
      Creates an empty finger tree with elements of type A and node annotations + of type V.
      +
      static <A> FingerTree<java.lang.Integer,A>emptyIntAddition() 
      static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>>emptyIntMax() +
      Returns a finger tree which combines the integer node annotations with the + maximum function.
      +
      <B> FingerTree<V,A>filter(F<A,java.lang.Boolean> f) 
      abstract <B> BfoldLeft(F<B,F<A,B>> f, + B z) +
      Folds the tree to the left with the given function and the given initial element.
      +
      <B> BfoldLeft(F2<B,A,B> f, + B z) 
      abstract <B> BfoldRight(F<A,F<B,B>> f, + B z) +
      Folds the tree to the right with the given function and the given initial element.
      +
      <B> BfoldRight(F2<A,B,B> f, + B z) 
      abstract Ahead() +
      The first element of this tree.
      +
      Option<A>headOption() 
      abstract FingerTree<V,A>init() +
      The tree without the last element.
      +
      booleanisEmpty() +
      Indicates whether this tree is empty.
      +
      abstract Alast() +
      The last element of this tree.
      +
      abstract intlength() 
      abstract P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      abstract <B> FingerTree<V,B>map(F<A,B> f, + Measured<V,B> m) +
      Maps the given function across this tree, measuring with the given Measured instance.
      +
      abstract <B> Bmatch(F<Empty<V,A>,B> empty, + F<Single<V,A>,B> single, + F<Deep<V,A>,B> deep) +
      Provides pattern matching on trees.
      +
      abstract Vmeasure() +
      Returns the sum of this tree's annotations.
      +
      Measured<V,A>measured() 
      static <V,A> Measured<V,A>measured(Monoid<V> monoid, + F<A,V> measure) +
      Constructs a Measured instance for the element type, given a monoid and a measuring function.
      +
      static <V,A> MakeTree<V,A>mkTree(Measured<V,A> m) +
      Returns a builder of trees and tree components that annotates them using the given Measured instance.
      +
      abstract AreduceLeft(F<A,F<A,A>> f) +
      Folds the tree to the left with the given function.
      +
      abstract AreduceRight(F<A,F<A,A>> f) +
      Folds the tree to the right with the given function.
      +
      abstract FingerTree<V,A>snoc(A a) +
      Adds the given element to this tree as the last element.
      +
      P2<FingerTree<V,A>,FingerTree<V,A>>split(F<V,java.lang.Boolean> predicate) +
      Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
      +
      P3<FingerTree<V,A>,A,FingerTree<V,A>>split1(F<V,java.lang.Boolean> predicate) +
      Like split, but returns the element where pred first holds separately.
      +
      abstract FingerTree<V,A>tail() +
      The tree without the first element.
      +
      abstract Stream<A>toStream() 
      <B> Buncons(B nil, + F2<A,FingerTree<V,A>,B> cons) +
      Performs a reduction on this finger tree using the given arguments.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public final <B> B foldRight(F2<A,B,B> f,
+                             B z)
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public abstract A reduceRight(F<A,F<A,A>> f)
        +
        Folds the tree to the right with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public final <B> B foldLeft(F2<B,A,B> f,
+                            B z)
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public abstract A reduceLeft(F<A,F<A,A>> f)
        +
        Folds the tree to the left with the given function.
        +
        +
        Parameters:
        +
        f - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public abstract <B> FingerTree<V,B> map(F<A,B> f,
+                                        Measured<V,B> m)
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Parameters:
        +
        f - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public final <B> FingerTree<V,A> filter(F<A,java.lang.Boolean> f)
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public abstract V measure()
        +
        Returns the sum of this tree's annotations.
        +
        +
        Returns:
        +
        the sum of this tree's annotations.
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public final boolean isEmpty()
        +
        Indicates whether this tree is empty.
        +
        +
        Returns:
        +
        true if this tree is the empty tree, otherwise false.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public final Measured<V,A> measured()
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Empty<V,A>,B> empty,
+                            F<Single<V,A>,B> single,
+                            F<Deep<V,A>,B> deep)
        +
        Provides pattern matching on trees. This is the Church encoding of the FingerTree datatype.
        +
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> monoid,
+                                           F<A,V> measure)
        +
        Constructs a Measured instance for the element type, given a monoid and a measuring function.
        +
        +
        Parameters:
        +
        monoid - A monoid for the measures.
        +
        measure - A function with which to measure element values.
        +
        Returns:
        +
        A Measured instance for the given element type, that uses the given monoid and measuring function.
        +
        +
        • +
      + + + +
        +
      • +

        mkTree

        +
        public static <V,A> MakeTree<V,A> mkTree(Measured<V,A> m)
        +
        Returns a builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        Parameters:
        +
        m - A Measured instance with which to annotate trees, digits, and nodes.
        +
        Returns:
        +
        A builder of trees and tree components that annotates them using the given Measured instance.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public abstract FingerTree<V,A> cons(A a)
        +
        Adds the given element to this tree as the first element.
        +
        +
        Parameters:
        +
        a - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public abstract FingerTree<V,A> snoc(A a)
        +
        Adds the given element to this tree as the last element.
        +
        +
        Parameters:
        +
        a - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public abstract A head()
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption()
        +
        • +
      + + + + + +
        +
      • +

        uncons

        +
        public final <B> B uncons(B nil,
+                          F2<A,FingerTree<V,A>,B> cons)
        +
        Performs a reduction on this finger tree using the given arguments.
        +
        +
        Parameters:
        +
        nil - The value to return if this finger tree is empty.
        +
        cons - The function to apply to the head and tail of this finger tree if it is not empty.
        +
        Returns:
        +
        A reduction on this finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public abstract A last()
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public abstract FingerTree<V,A> tail()
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public abstract FingerTree<V,A> init()
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public abstract FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Appends one finger tree to another.
        +
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        split

        +
        public final P2<FingerTree<V,A>,FingerTree<V,A>> split(F<V,java.lang.Boolean> predicate)
        +
        Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true. This is a O(log(n)) operation.
        +
        +
        Returns:
        +
        Pair: the subtree containing elements before the point where pred first holds and the subtree + containing element at and after the point where pred first holds. Empty if pred never holds.
        +
        +
        • +
      + + + +
        +
      • +

        split1

        +
        public final P3<FingerTree<V,A>,A,FingerTree<V,A>> split1(F<V,java.lang.Boolean> predicate)
        +
        Like split, but returns the element where pred first holds separately. + + Throws an error if the tree is empty.
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        emptyIntAddition

        +
        public static <A> FingerTree<java.lang.Integer,A> emptyIntAddition()
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static <V,A> FingerTree<V,A> empty(Monoid<V> m,
+                                          F<A,V> f)
        +
        Creates an empty finger tree with elements of type A and node annotations + of type V.
        +
        +
        Parameters:
        +
        m - A monoid to combine node annotations
        +
        f - Function to convert node element to annotation.
        +
        Returns:
        +
        An empty finger tree.
        +
        +
        • +
      + + + +
        +
      • +

        emptyIntMax

        +
        public static <A> FingerTree<java.lang.Integer,P2<java.lang.Integer,A>> emptyIntMax()
        +
        Returns a finger tree which combines the integer node annotations with the + maximum function. A priority queue with integer priorities.
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Four.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Four.html new file mode 100644 index 0000000..850e378 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Four.html @@ -0,0 +1,418 @@ + + + + + +Four (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Four<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Four<V,A>
+extends Digit<V,A>
    +
    A four-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V4<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V4<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/MakeTree.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/MakeTree.html new file mode 100644 index 0000000..395a68d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/MakeTree.html @@ -0,0 +1,543 @@ + + + + + +MakeTree (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class MakeTree<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class MakeTree<V,A>
+extends java.lang.Object
    +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public FingerTree<V,A> empty()
        +
        Constructs an empty tree.
        +
        +
        Returns:
        +
        The empty tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public FingerTree<V,A> single(A a)
        +
        Constructs a singleton tree.
        +
        +
        Parameters:
        +
        a - A single element for the tree.
        +
        Returns:
        +
        A tree with the given value as the single element.
        +
        +
        • +
      + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree. This structure consists of two digits, of 1 to 4 elements each, on the left and right, + with the rest of the tree in the middle.
        +
        +
        Parameters:
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle.
        +
        +
        • +
      + + + + + +
        +
      • +

        deep

        +
        public FingerTree<V,A> deep(V v,
+                            Digit<V,A> prefix,
+                            FingerTree<V,Node<V,A>> middle,
+                            Digit<V,A> suffix)
        +
        Constructs a deep tree with the given annotation value.
        +
        +
        Parameters:
        +
        v - The value with which to annotate this tree.
        +
        prefix - The leftmost elements of the tree.
        +
        middle - The subtree, which is a Finger Tree of 2-3 nodes.
        +
        suffix - The rightmost elements of the tree.
        +
        Returns:
        +
        A new finger tree with the given prefix, suffix, and middle, and annotated with the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        one

        +
        public One<V,A> one(A a)
        +
        A digit of one element.
        +
        +
        Parameters:
        +
        a - The element of the digit.
        +
        Returns:
        +
        A digit of the given element.
        +
        +
        • +
      + + + + + +
        +
      • +

        two

        +
        public Two<V,A> two(A a,
+                    A b)
        +
        A digit of two elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        three

        +
        public Three<V,A> three(A a,
+                        A b,
+                        A c)
        +
        A digit of three elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        four

        +
        public Four<V,A> four(A a,
+                      A b,
+                      A c,
+                      A d)
        +
        A digit of four elements.
        +
        +
        Parameters:
        +
        a - The first element of the digit.
        +
        b - The second element of the digit.
        +
        c - The third element of the digit.
        +
        d - The fifth element of the digit.
        +
        Returns:
        +
        A digit of the given elements.
        +
        +
        • +
      + + + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(A a,
+                        A b)
        +
        A binary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The right child of the node.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(A a,
+                        A b,
+                        A c)
        +
        A trinary tree node.
        +
        +
        Parameters:
        +
        a - The left child of the node.
        +
        b - The middle child of the node.
        +
        c - The right child of the node.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node2

        +
        public Node2<V,A> node2(V2<A> v)
        +
        A binary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new binary tree node.
        +
        +
        • +
      + + + +
        +
      • +

        node3

        +
        public Node3<V,A> node3(V3<A> v)
        +
        A trinary tree node
        +
        +
        Parameters:
        +
        v - A vector of the node's elements.
        +
        Returns:
        +
        A new trinary tree node.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Measured.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Measured.html new file mode 100644 index 0000000..22e1c24 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Measured.html @@ -0,0 +1,389 @@ + + + + + +Measured (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Measured<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Measured<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Measured<V,A>
+extends java.lang.Object
    +
    Determines how the elements of a tree are measured and how measures are summed. Consists of a monoid and a + measuring function. Different instances of this class will result in different behaviours for the tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        measured

        +
        public static <V,A> Measured<V,A> measured(Monoid<V> m,
+                                           F<A,V> measure)
        +
        • +
      + + + +
        +
      • +

        monoid

        +
        public Monoid<V> monoid()
        +
        Returns the monoid used to sum measures.
        +
        +
        Returns:
        +
        the monoid used to sum measures.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public F<A,V> measure()
        +
        Returns the measuring function.
        +
        +
        Returns:
        +
        the measuring function.
        +
        +
        • +
      + + + + + +
        +
      • +

        measure

        +
        public V measure(A a)
        +
        Measures a given element.
        +
        +
        Parameters:
        +
        a - An element to measure.
        +
        Returns:
        +
        the element's measurement.
        +
        +
        • +
      + + + + + +
        +
      • +

        sum

        +
        public V sum(V a,
+             V b)
        +
        Sums the given measurements with the monoid.
        +
        +
        Parameters:
        +
        a - A measurement to add to another.
        +
        b - A measurement to add to another.
        +
        Returns:
        +
        The sum of the two measurements.
        +
        +
        • +
      + + + +
        +
      • +

        zero

        +
        public V zero()
        +
        Returns the identity measurement for the monoid.
        +
        +
        Returns:
        +
        the identity measurement for the monoid.
        +
        +
        • +
      + + + +
        +
      • +

        nodeMeasured

        +
        public Measured<V,Node<V,A>> nodeMeasured()
        +
        A measured instance for nodes.
        +
        +
        Returns:
        +
        A measured instance for nodes.
        +
        +
        • +
      + + + +
        +
      • +

        digitMeasured

        +
        public Measured<V,Digit<V,A>> digitMeasured()
        +
        A measured instance for digits.
        +
        +
        Returns:
        +
        A measured instance for digits.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Node.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node.html new file mode 100644 index 0000000..70c78fa --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node.html @@ -0,0 +1,398 @@ + + + + + +Node (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node<V,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.fingertrees.Node<V,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    Node2, Node3
    +
    +
    +
    +
    public abstract class Node<V,A>
+extends java.lang.Object
    +
    An inner node of the 2-3 tree.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public abstract <B> B foldRight(F<A,F<B,B>> f,
+                                B z)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public abstract <B> B foldLeft(F<B,F<A,B>> f,
+                               B z)
        +
        • +
      + + + +
        +
      • +

        foldLeft_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldLeft_(F<B,F<A,B>> bff)
        +
        • +
      + + + +
        +
      • +

        foldRight_

        +
        public static <V,A,B> F<B,F<Node<V,A>,B>> foldRight_(F<A,F<B,B>> aff)
        +
        • +
      + + + + + + + +
        +
      • +

        liftM

        +
        public static <V,A,B> F<Node<V,A>,Node<V,B>> liftM(F<A,B> f,
+                                                   Measured<V,B> m)
        +
        • +
      + + + +
        +
      • +

        toDigit

        +
        public abstract Digit<V,A> toDigit()
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public final V measure()
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public abstract P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                               int i)
        +
        • +
      + + + +
        +
      • +

        match

        +
        public abstract <B> B match(F<Node2<V,A>,B> n2,
+                            F<Node3<V,A>,B> n3)
        +
        • +
      + + + +
        +
      • +

        length

        +
        public abstract int length()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public abstract Stream<A> toStream()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Node2.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node2.html new file mode 100644 index 0000000..917f460 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node2.html @@ -0,0 +1,395 @@ + + + + + +Node2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node2<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node2<V,A>
+extends Node<V,A>
    +
    A two-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V2<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Node3.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node3.html new file mode 100644 index 0000000..e391db2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Node3.html @@ -0,0 +1,395 @@ + + + + + +Node3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Node3<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Node3<V,A>
+extends Node<V,A>
    +
    A three-element inner tree node.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        +
        Specified by:
        +
        foldRight in class Node<V,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        +
        Specified by:
        +
        foldLeft in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Node<V,A>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Node<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toVector

        +
        public V3<A> toVector()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/One.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/One.html new file mode 100644 index 0000000..eb1d53a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/One.html @@ -0,0 +1,418 @@ + + + + + +One (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class One<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class One<V,A>
+extends Digit<V,A>
    +
    A single-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      Avalue() +
      Returns the single element in this digit.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element in this digit.
        +
        +
        Returns:
        +
        the single element in this digit.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Single.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Single.html new file mode 100644 index 0000000..f5bbd9b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Single.html @@ -0,0 +1,686 @@ + + + + + +Single (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Single<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Single<V,A>
+extends FingerTree<V,A>
    +
    A tree with a single element.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        reduceRight

        +
        public A reduceRight(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the right with the given function.
        +
        +
        Specified by:
        +
        reduceRight in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function and the given initial element.
        +
        +
        Specified by:
        +
        foldLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold the tree.
        +
        z - An initial element to apply to the fold.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the left.
        +
        +
        • +
      + + + +
        +
      • +

        reduceLeft

        +
        public A reduceLeft(F<A,F<A,A>> aff)
        +
        Description copied from class: FingerTree
        +
        Folds the tree to the left with the given function.
        +
        +
        Specified by:
        +
        reduceLeft in class FingerTree<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold the tree.
        +
        Returns:
        +
        A reduction of this tree by applying the given function, associating to the right.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> FingerTree<V,B> map(F<A,B> abf,
+                               Measured<V,B> m)
        +
        Description copied from class: FingerTree
        +
        Maps the given function across this tree, measuring with the given Measured instance.
        +
        +
        Specified by:
        +
        map in class FingerTree<V,A>
        +
        Parameters:
        +
        abf - A function to map across the values of this tree.
        +
        m - A measuring with which to annotate the tree.
        +
        Returns:
        +
        A new tree with the same structure as this tree, with each element transformed by the given function, + and nodes annotated according to the given measuring.
        +
        +
        • +
      + + + +
        +
      • +

        measure

        +
        public V measure()
        +
        Returns the annotation of this tree's single element.
        +
        +
        Specified by:
        +
        measure in class FingerTree<V,A>
        +
        Returns:
        +
        the annotation of this tree's single element.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<Empty<V,A>,B> empty,
+                   F<Single<V,A>,B> single,
+                   F<Deep<V,A>,B> deep)
        +
        Pattern matching on the structure of this tree. Matches the singleton tree.
        +
        +
        Specified by:
        +
        match in class FingerTree<V,A>
        +
        Parameters:
        +
        empty - The function to apply to this empty tree.
        +
        single - A function to apply if this tree contains a single element.
        +
        deep - A function to apply if this tree contains more than one element.
        +
        Returns:
        +
        The result of the function that matches this tree structurally, applied to this tree.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public FingerTree<V,A> cons(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the first element.
        +
        +
        Specified by:
        +
        cons in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the front of this tree.
        +
        Returns:
        +
        A new tree with the given element at the front.
        +
        +
        • +
      + + + + + +
        +
      • +

        snoc

        +
        public FingerTree<V,A> snoc(A b)
        +
        Description copied from class: FingerTree
        +
        Adds the given element to this tree as the last element.
        +
        +
        Specified by:
        +
        snoc in class FingerTree<V,A>
        +
        Parameters:
        +
        b - The element to add to the end of this tree.
        +
        Returns:
        +
        A new tree with the given element at the end.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public A head()
        +
        Description copied from class: FingerTree
        +
        The first element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        head in class FingerTree<V,A>
        +
        Returns:
        +
        The first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        last

        +
        public A last()
        +
        Description copied from class: FingerTree
        +
        The last element of this tree. This is an O(1) operation.
        +
        +
        Specified by:
        +
        last in class FingerTree<V,A>
        +
        Returns:
        +
        The last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public FingerTree<V,A> tail()
        +
        Description copied from class: FingerTree
        +
        The tree without the first element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        tail in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the first element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public FingerTree<V,A> init()
        +
        Description copied from class: FingerTree
        +
        The tree without the last element. This is an O(1) operation.
        +
        +
        Specified by:
        +
        init in class FingerTree<V,A>
        +
        Returns:
        +
        The tree without the last element if this tree is nonempty, otherwise throws an error.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public FingerTree<V,A> append(FingerTree<V,A> t)
        +
        Description copied from class: FingerTree
        +
        Appends one finger tree to another.
        +
        +
        Specified by:
        +
        append in class FingerTree<V,A>
        +
        Parameters:
        +
        t - A finger tree to append to this one.
        +
        Returns:
        +
        A new finger tree which is a concatenation of this tree and the given tree.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class FingerTree<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        Returns the single element of this tree.
        +
        +
        Returns:
        +
        the single element of this tree.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Three.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Three.html new file mode 100644 index 0000000..c75910b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Three.html @@ -0,0 +1,418 @@ + + + + + +Three (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Three<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Three<V,A>
+extends Digit<V,A>
    +
    A three-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V3<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V3<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/Two.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/Two.html new file mode 100644 index 0000000..761ebde --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/Two.html @@ -0,0 +1,418 @@ + + + + + +Two (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.fingertrees
+

Class Two<V,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Two<V,A>
+extends Digit<V,A>
    +
    A two-element prefix or suffix of a finger tree.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B> BfoldLeft(F<B,F<A,B>> bff, + B z) +
      Folds this digit to the left using the given function and the given initial value.
      +
      <B> BfoldRight(F<A,F<B,B>> aff, + B z) +
      Folds this digit to the right using the given function and the given initial value.
      +
      intlength() 
      P2<java.lang.Integer,A>lookup(F<V,java.lang.Integer> o, + int i) 
      <B> Bmatch(F<One<V,A>,B> one, + F<Two<V,A>,B> two, + F<Three<V,A>,B> three, + F<Four<V,A>,B> four) +
      Structural pattern matching on digits.
      +
      Stream<A>toStream() 
      java.lang.StringtoString() 
      V2<A>values() +
      Returns the elements of this digit as a vector.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        foldRight

        +
        public <B> B foldRight(F<A,F<B,B>> aff,
+                       B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the right using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldRight in class Digit<V,A>
        +
        Parameters:
        +
        aff - A function with which to fold this digit.
        +
        z - An initial value to apply at the rightmost end of the fold.
        +
        Returns:
        +
        The right reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F<B,F<A,B>> bff,
+                      B z)
        +
        Description copied from class: Digit
        +
        Folds this digit to the left using the given function and the given initial value.
        +
        +
        Specified by:
        +
        foldLeft in class Digit<V,A>
        +
        Parameters:
        +
        bff - A function with which to fold this digit.
        +
        z - An initial value to apply at the leftmost end of the fold.
        +
        Returns:
        +
        The left reduction of this digit with the given function and the given initial value.
        +
        +
        • +
      + + + +
        +
      • +

        match

        +
        public <B> B match(F<One<V,A>,B> one,
+                   F<Two<V,A>,B> two,
+                   F<Three<V,A>,B> three,
+                   F<Four<V,A>,B> four)
        +
        Description copied from class: Digit
        +
        Structural pattern matching on digits. Applies the function that matches the structure of this digit.
        +
        +
        Specified by:
        +
        match in class Digit<V,A>
        +
        Parameters:
        +
        one - A function to apply to this digit if it's One.
        +
        two - A function to apply to this digit if it's Two.
        +
        three - A function to apply to this digit if it's Three.
        +
        four - A function to apply to this digit if it's Four.
        +
        Returns:
        +
        The result of applying the function matching this Digit.
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public V2<A> values()
        +
        Returns the elements of this digit as a vector.
        +
        +
        Returns:
        +
        the elements of this digit as a vector.
        +
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public P2<java.lang.Integer,A> lookup(F<V,java.lang.Integer> o,
+                                      int i)
        +
        +
        Specified by:
        +
        lookup in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        +
        Specified by:
        +
        length in class Digit<V,A>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Digit<V,A>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/package-frame.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-frame.html new file mode 100644 index 0000000..bb618b9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-frame.html @@ -0,0 +1,32 @@ + + + + + +fj.data.fingertrees (core 5.0 API) + + + + +

fj.data.fingertrees

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/package-summary.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-summary.html new file mode 100644 index 0000000..9469a00 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-summary.html @@ -0,0 +1,235 @@ + + + + + +fj.data.fingertrees (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.fingertrees

+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Deep<V,A> +
    A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
    +
    Digit<V,A> +
    A digit is a vector of 1-4 elements.
    +
    Empty<V,A> +
    The empty tree.
    +
    FingerTree<V,A> +
    Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
    +
    Four<V,A> +
    A four-element prefix or suffix of a finger tree.
    +
    MakeTree<V,A> +
    A builder of trees and tree components, supplied with a particular monoid and measuring function.
    +
    Measured<V,A> +
    Determines how the elements of a tree are measured and how measures are summed.
    +
    Node<V,A> +
    An inner node of the 2-3 tree.
    +
    Node2<V,A> +
    A two-element inner tree node.
    +
    Node3<V,A> +
    A three-element inner tree node.
    +
    One<V,A> +
    A single-element prefix or suffix of a finger tree.
    +
    Single<V,A> +
    A tree with a single element.
    +
    Three<V,A> +
    A three-element prefix or suffix of a finger tree.
    +
    Two<V,A> +
    A two-element prefix or suffix of a finger tree.
    +
    +
    • +
+ + + +

Package fj.data.fingertrees Description

+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time. Concatenation and splitting time is O(log n) in the size of the smaller piece. + A general purpose data structure that can serve as a sequence, priority queue, search tree, priority search queue + and more. + + Based on "Finger trees: a simple general-purpose data structure", by Ralf Hinze and Ross Paterson.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/fingertrees/package-tree.html b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-tree.html new file mode 100644 index 0000000..81ea295 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/fingertrees/package-tree.html @@ -0,0 +1,156 @@ + + + + + +fj.data.fingertrees Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.fingertrees

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.fingertrees.Digit<V,A> +
        +
      • fj.data.fingertrees.Four<V,A>
        • +
      • fj.data.fingertrees.One<V,A>
        • +
      • fj.data.fingertrees.Three<V,A>
        • +
      • fj.data.fingertrees.Two<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.FingerTree<V,A> +
        +
      • fj.data.fingertrees.Deep<V,A>
        • +
      • fj.data.fingertrees.Empty<V,A>
        • +
      • fj.data.fingertrees.Single<V,A>
        • +
      +
      • +
    • fj.data.fingertrees.MakeTree<V,A>
      • +
    • fj.data.fingertrees.Measured<V,A>
      • +
    • fj.data.fingertrees.Node<V,A> +
        +
      • fj.data.fingertrees.Node2<V,A>
        • +
      • fj.data.fingertrees.Node3<V,A>
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/BitSet.html b/javadoc/5.0/functionaljava/fj/data/hamt/BitSet.html new file mode 100644 index 0000000..9c061af --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/BitSet.html @@ -0,0 +1,808 @@ + + + + + +BitSet (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class BitSet

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.BitSet
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BitSet
+extends java.lang.Object
    +
    A sequence of bits representing a value. The most significant bit (the + bit with the highest value) is the leftmost bit and has the highest index. + For example, the BitSet("1011") represents the decimal number 11 and has + indices [3, 0] inclusive where the bit with the lowest value has the lowest + index and is the rightmost bit.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static BitSet empty()
        +
        • +
      + + + +
        +
      • +

        longBitSet

        +
        public static BitSet longBitSet(long l)
        +
        • +
      + + + +
        +
      • +

        listBitSet

        +
        public static BitSet listBitSet(List<java.lang.Boolean> list)
        +
        • +
      + + + +
        +
      • +

        streamBitSet

        +
        public static BitSet streamBitSet(Stream<java.lang.Boolean> s)
        +
        • +
      + + + +
        +
      • +

        stringBitSet

        +
        public static BitSet stringBitSet(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        isSet

        +
        public boolean isSet(int index)
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public BitSet set(int index,
+                  boolean b)
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public BitSet clear(int index)
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        shiftRight

        +
        public BitSet shiftRight(int n)
        +
        • +
      + + + +
        +
      • +

        shiftLeft

        +
        public BitSet shiftLeft(int n)
        +
        • +
      + + + +
        +
      • +

        bitsUsed

        +
        public int bitsUsed()
        +
        • +
      + + + +
        +
      • +

        bitsOn

        +
        public int bitsOn()
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<java.lang.Boolean> toStream()
        +
        Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        bitsToRight

        +
        public int bitsToRight(int index)
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<java.lang.Boolean> toList()
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public <A> A foldRight(F2<java.lang.Boolean,A,A> f,
+                       A acc)
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <A> A foldLeft(F2<A,java.lang.Boolean,A> f,
+                      A acc)
        +
        • +
      + + + + + + + +
        +
      • +

        not

        +
        public BitSet not()
        +
        • +
      + + + +
        +
      • +

        takeLower

        +
        public BitSet takeLower(int n)
        +
        • +
      + + + +
        +
      • +

        takeUpper

        +
        public BitSet takeUpper(int n)
        +
        • +
      + + + +
        +
      • +

        range

        +
        public BitSet range(int highIndex,
+                    int lowIndex)
        +
        Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g. "101101".range(1, 4) == "0110"
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(char c)
        +
        • +
      + + + +
        +
      • +

        toBoolean

        +
        public static boolean toBoolean(int i)
        +
        • +
      + + + +
        +
      • +

        toInt

        +
        public static int toInt(boolean b)
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/HashArrayMappedTrie.html b/javadoc/5.0/functionaljava/fj/data/hamt/HashArrayMappedTrie.html new file mode 100644 index 0000000..f7c3c09 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/HashArrayMappedTrie.html @@ -0,0 +1,608 @@ + + + + + +HashArrayMappedTrie (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class HashArrayMappedTrie<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.HashArrayMappedTrie<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HashArrayMappedTrie<K,V>
+extends java.lang.Object
    +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie. It is a refined version of the more general notion of + a hash tree. + + Based on "Ideal Hash Trees" by Phil Bagwell, available from + http://lampwww.epfl.ch/papers/idealhashtrees.pdf
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        SIZE

        +
        public static final int SIZE
        +
        • +
      + + + + + + + +
        +
      • +

        MAX_INDEX

        +
        public static final int MAX_INDEX
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        emptyKeyInteger

        +
        public static <V> HashArrayMappedTrie<java.lang.Integer,V> emptyKeyInteger()
        +
        Create and empty trie keyed by integer.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns if the trie is empty.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k)
        +
        Returns an optional value for the given key k.
        +
        • +
      + + + + + +
        +
      • +

        find

        +
        public Option<V> find(K k,
+                      int lowIndex,
+                      int highIndex)
        +
        Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
        +
        • +
      + + + + + + + + + + + + + +
        +
      • +

        toStream

        +
        public Stream<P2<K,V>> toStream()
        +
        Returns a stream of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList(Ord<K> o)
        +
        Returns the list of key-value pairs, ordered by key.
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public List<P2<K,V>> toList()
        +
        Returns a list of key-value pairs.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + + + +
        +
      • +

        foldLeftOnNode

        +
        public <B> B foldLeftOnNode(F2<B,Node<K,V>,B> f,
+                            B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      F2<B,HashArrayMappedTrie<K,V>,B> g,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + + + +
        +
      • +

        foldLeft

        +
        public <B> B foldLeft(F2<B,P2<K,V>,B> f,
+                      B b)
        +
        Performs a left-fold reduction across this trie.
        +
        • +
      + + + +
        +
      • +

        getBitSet

        +
        public BitSet getBitSet()
        +
        • +
      + + + +
        +
      • +

        getSeq

        +
        public Seq<Node<K,V>> getSeq()
        +
        • +
      + + + +
        +
      • +

        length

        +
        public int length()
        +
        Returns the number of elements in the trie.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/Node.html b/javadoc/5.0/functionaljava/fj/data/hamt/Node.html new file mode 100644 index 0000000..d23f3b7 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/Node.html @@ -0,0 +1,355 @@ + + + + + +Node (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hamt
+

Class Node<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hamt.Node<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Node<K,V>
+extends java.lang.Object
    +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/package-frame.html b/javadoc/5.0/functionaljava/fj/data/hamt/package-frame.html new file mode 100644 index 0000000..8524307 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/package-frame.html @@ -0,0 +1,21 @@ + + + + + +fj.data.hamt (core 5.0 API) + + + + +

fj.data.hamt

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/package-summary.html b/javadoc/5.0/functionaljava/fj/data/hamt/package-summary.html new file mode 100644 index 0000000..12b771c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/package-summary.html @@ -0,0 +1,156 @@ + + + + + +fj.data.hamt (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hamt

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BitSet +
    A sequence of bits representing a value.
    +
    HashArrayMappedTrie<K,V> +
    A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
    +
    Node<K,V> +
    A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hamt/package-tree.html b/javadoc/5.0/functionaljava/fj/data/hamt/package-tree.html new file mode 100644 index 0000000..1494850 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hamt/package-tree.html @@ -0,0 +1,136 @@ + + + + + +fj.data.hamt Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hamt

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.Apply.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.Apply.html new file mode 100644 index 0000000..320d934 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.Apply.html @@ -0,0 +1,391 @@ + + + + + +HList.Apply (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HList.Apply<F$,A,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.Apply<F$,A,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    F$ - The type of the function to apply.
    +
    A - The domain of the function.
    +
    R - The function's codomain.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public abstract static class HList.Apply<F$,A,R>
+extends java.lang.Object
    +
    Type-level function application operators.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Apply

        +
        public Apply()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        apply

        +
        public abstract R apply(F$ f,
+                        A a)
        +
        • +
      + + + +
        +
      • +

        f

        +
        public static <X,Y> HList.Apply<F<X,Y>,X,Y> f()
        +
        Function application operator.
        +
        +
        Returns:
        +
        an operator that applies a given function to a given argument.
        +
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <X> HList.Apply<Unit,X,X> id()
        +
        Identity operator
        +
        +
        Returns:
        +
        An operator that returns its second argument no matter which function is being applied.
        +
        +
        • +
      + + + +
        +
      • +

        comp

        +
        public static <X,Y,Z> HList.Apply<Unit,P2<F<X,Y>,F<Y,Z>>,F<X,Z>> comp()
        +
        A function application operator for function composition.
        +
        +
        Type Parameters:
        +
        X - The domain.
        +
        Y - The type through which to compose.
        +
        Z - The codomain.
        +
        Returns:
        +
        an operator that composes functions.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.Apply<Unit,P2<E,L>,HList.HCons<E,L>> cons()
        +
        An operator for the construction of heterogeneous lists.
        +
        +
        Returns:
        +
        an operator that constructs heterogeneous lists.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <A,B,C> HList.Apply<HList.HAppend<A,B,C>,P2<A,B>,C> append()
        +
        A function application operator for concatenating heterogeneous lists.
        +
        +
        Type Parameters:
        +
        A - The type of the list to which to append.
        +
        B - The type of the list to append.
        +
        C - The type of the concatenated list.
        +
        Returns:
        +
        an operator that concatenates heterogeneous lists.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.HAppend.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HAppend.html new file mode 100644 index 0000000..25265b1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HAppend.html @@ -0,0 +1,303 @@ + + + + + +HList.HAppend (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HAppend<A,B,C>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HAppend<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The type of the first list.
    +
    B - The type of the second list.
    +
    C - The type of the combined list.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HAppend<A,B,C>
+extends java.lang.Object
    +
    The concatenation of two heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        append

        +
        public C append(A a,
+                B b)
        +
        Append a given heterogeneous list to another.
        +
        +
        Parameters:
        +
        a - a heterogeneous list to be appended to.
        +
        b - a heterogeneous list to append to another.
        +
        Returns:
        +
        a new heterogeneous list consisting of the second argument appended to the first.
        +
        +
        • +
      + + + +
        +
      • +

        append

        +
        public static <L extends HList<L>> HList.HAppend<HList.HNil,L,L> append()
        +
        Returns a method for concatenating lists to the empty list.
        +
        +
        Returns:
        +
        a method for concatenating lists to the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        append

        +
        public static <X,A extends HList<A>,B,C extends HList<C>,H extends HList.HAppend<A,B,C>> HList.HAppend<HList.HCons<X,A>,B,HList.HCons<X,C>> append(H h)
        +
        Returns a method for appending lists to a nonempty heterogeneous list.
        +
        +
        Parameters:
        +
        h - a method for appending lists to the tail of the given nonempty list.
        +
        Returns:
        +
        a method for appending lists to a nonempty heterogeneous list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.HCons.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HCons.html new file mode 100644 index 0000000..e594d20 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HCons.html @@ -0,0 +1,323 @@ + + + + + +HList.HCons (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HCons<E,L extends HList<L>>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HCons<E,L extends HList<L>>
+extends HList<HList.HCons<E,L>>
    +
    The nonempty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.HFoldr.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HFoldr.html new file mode 100644 index 0000000..423de4c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HFoldr.html @@ -0,0 +1,322 @@ + + + + + +HList.HFoldr (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HFoldr<G,V,L,R>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList.HFoldr<G,V,L,R>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    G - The type of the function with which to fold.
    +
    V - The type of the value to be substituted for the empty list.
    +
    L - The type of the heterogeneous list to be folded.
    +
    R - The return type of the fold.
    +
    +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HFoldr<G,V,L,R>
+extends java.lang.Object
    +
    The catamorphism over heterogeneous lists.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hFoldr

        +
        public static <G,V> HList.HFoldr<G,V,HList.HNil,V> hFoldr()
        +
        A fold instance for the empty list.
        +
        +
        Type Parameters:
        +
        G - The type of the function with which to fold.
        +
        V - The type of value that this fold returns.
        +
        Returns:
        +
        a fold instance for the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        hFoldr

        +
        public static <E,G,V,L extends HList<L>,R,RR,H extends HList.HFoldr<G,V,L,R>,PP extends HList.Apply<G,P2<E,R>,RR>> HList.HFoldr<G,V,HList.HCons<E,L>,RR> hFoldr(PP p,
+                                                                                                                                                                H h)
        +
        A fold instance for a non-empty heterogeneous list
        +
        +
        Type Parameters:
        +
        E - The type of the head of the list.
        +
        G - The type of function to apply to the head of the list and the fold of its tail.
        +
        V - The type of value to substitute for the empty list.
        +
        L - The type of the tail of the list.
        +
        R - The type of the fold of the tail of the list.
        +
        RR - The return type of the fold.
        +
        H - The type of the fold instance for the tail of the list.
        +
        PP - The type of the given function application operator.
        +
        Parameters:
        +
        p - An operator that applies a function on the head of the list and the fold of its tail.
        +
        h - A fold instance for the tail of the list.
        +
        Returns:
        +
        A fold instance for a non-empty heterogeneous list.
        +
        +
        • +
      + + + + + +
        +
      • +

        foldRight

        +
        public R foldRight(G f,
+                   V v,
+                   L l)
        +
        Folds a non-empty heterogeneous list.
        +
        +
        Parameters:
        +
        f - A function with which to fold.
        +
        v - The value to substitute for the empty list.
        +
        l - The heterogeneous list to be folded.
        +
        Returns:
        +
        a value obtained by folding the given list with the given function.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.HNil.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HNil.html new file mode 100644 index 0000000..cfb55d3 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.HNil.html @@ -0,0 +1,297 @@ + + + + + +HList.HNil (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList.HNil

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HList<A extends HList<A>>
    +
    +
    +
    +
    public static final class HList.HNil
+extends HList<HList.HNil>
    +
    The empty list
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HList.html b/javadoc/5.0/functionaljava/fj/data/hlist/HList.html new file mode 100644 index 0000000..6eda2fe --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HList.html @@ -0,0 +1,383 @@ + + + + + +HList (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HList<A extends HList<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HList<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - The specific type of the list, as a subtype of HList
    +
    +
    +
    Direct Known Subclasses:
    +
    HList.HCons, HList.HNil
    +
    +
    +
    +
    public abstract class HList<A extends HList<A>>
+extends java.lang.Object
    +
    Type-safe heterogeneous lists.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class HList.Apply<F$,A,R> +
      Type-level function application operators.
      +
      static class HList.HAppend<A,B,C> +
      The concatenation of two heterogeneous lists.
      +
      static class HList.HCons<E,L extends HList<L>> +
      The nonempty list
      +
      static class HList.HFoldr<G,V,L,R> +
      The catamorphism over heterogeneous lists.
      +
      static class HList.HNil +
      The empty list
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        extend

        +
        public abstract <E> HList.HCons<E,A> extend(E e)
        +
        Extends (cons) this list by prepending the given element, returning a new list.
        +
        +
        Parameters:
        +
        e - an element to prepend to this list.
        +
        Returns:
        +
        a new heterogeneous list, consisting of the given element prepended to this list.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        nil

        +
        public static HList.HNil nil()
        +
        Returns the empty list.
        +
        +
        Returns:
        +
        the empty list.
        +
        +
        • +
      + + + + + +
        +
      • +

        cons

        +
        public static <E,L extends HList<L>> HList.HCons<E,L> cons(E e,
+                                                           L l)
        +
        Returns a heterogeneous list consisting of an element and another list.
        +
        +
        Parameters:
        +
        e - an element to put in a list.
        +
        l - the rest of the list.
        +
        Returns:
        +
        a heterogeneous list consisting of an element and another list.
        +
        +
        • +
      + + + + + +
        +
      • +

        single

        +
        public static <E> HList.HCons<E,HList.HNil> single(E e)
        +
        Returns a heterogeneous list consisting of a single element.
        +
        +
        Parameters:
        +
        e - an element to put in a list
        +
        Returns:
        +
        a heterogeneous list consisting of a single element.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAdd.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAdd.html new file mode 100644 index 0000000..3a71885 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAdd.html @@ -0,0 +1,297 @@ + + + + + +HPre.HAdd (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAdd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>>
+extends java.lang.Object
    +
    Type-level integer arithmetic
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAnd.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAnd.html new file mode 100644 index 0000000..5cdbfb9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HAnd.html @@ -0,0 +1,305 @@ + + + + + +HPre.HAnd (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HAnd<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A and B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean conjunction. A value of this type represents evidence that AB -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HBool.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HBool.html new file mode 100644 index 0000000..d0defa8 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HBool.html @@ -0,0 +1,203 @@ + + + + + +HPre.HBool (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HBool

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HBool
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HFalse, HPre.HTrue
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HBool
+extends java.lang.Object
    +
    A type-level Boolean
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HCond.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HCond.html new file mode 100644 index 0000000..9cafc3c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HCond.html @@ -0,0 +1,284 @@ + + + + + +HPre.HCond (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HCond<T,X,Y,Z>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HCond<T,X,Y,Z>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - A boolean
    +
    X - The type of Z if T is true.
    +
    Y - The type of Z if T is false.
    +
    Z - A type that is either X or Z, depending on T.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HCond<T,X,Y,Z>
+extends java.lang.Object
    +
    A type-level conditional. The type of the last parameter is implied by the first three.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HEq.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HEq.html new file mode 100644 index 0000000..9330a2e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HEq.html @@ -0,0 +1,322 @@ + + + + + +HPre.HEq (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HEq<X,Y,B extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HEq<X,Y,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HEq<X,Y,B extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level equality. Represents evidence for X and Y being equal, or counterevidence against.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HFalse.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HFalse.html new file mode 100644 index 0000000..6645647 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HFalse.html @@ -0,0 +1,204 @@ + + + + + +HPre.HFalse (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HFalse

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HFalse
+extends HPre.HBool
    +
    Boolean false
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HNat.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HNat.html new file mode 100644 index 0000000..bdd3703 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HNat.html @@ -0,0 +1,331 @@ + + + + + +HPre.HNat (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HNat<A extends HPre.HNat<A>>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HNat<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    HPre.HSucc, HPre.HZero
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public abstract static class HPre.HNat<A extends HPre.HNat<A>>
+extends java.lang.Object
    +
    Type-level natural numbers.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HNat

        +
        public HNat()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HOr.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HOr.html new file mode 100644 index 0000000..5909b16 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HOr.html @@ -0,0 +1,305 @@ + + + + + +HPre.HOr (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre.HOr<A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    A - A boolean
    +
    B - A boolean
    +
    C - The logical implication of A or B
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool>
+extends java.lang.Object
    +
    Type-level boolean disjunction. A value of this type represents evidence that A+B -> C
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HSucc.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HSucc.html new file mode 100644 index 0000000..38e0455 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HSucc.html @@ -0,0 +1,276 @@ + + + + + +HPre.HSucc (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HSucc<N extends HPre.HNat<N>>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    N - The predecessor of this number.
    +
    +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HSucc<N extends HPre.HNat<N>>
+extends HPre.HNat<HPre.HSucc<N>>
    +
    A natural number N + 1
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HTrue.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HTrue.html new file mode 100644 index 0000000..e34cd7e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HTrue.html @@ -0,0 +1,204 @@ + + + + + +HPre.HTrue (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HTrue

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static class HPre.HTrue
+extends HPre.HBool
    +
    Boolean true
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HZero.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HZero.html new file mode 100644 index 0000000..5ce7c76 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.HZero.html @@ -0,0 +1,272 @@ + + + + + +HPre.HZero (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre.HZero

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    HPre
    +
    +
    +
    +
    public static final class HPre.HZero
+extends HPre.HNat<HPre.HZero>
    +
    Type-level zero
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/HPre.html b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.html new file mode 100644 index 0000000..d38f3da --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/HPre.html @@ -0,0 +1,343 @@ + + + + + +HPre (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.hlist
+

Class HPre

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.hlist.HPre
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class HPre
+extends java.lang.Object
    +
    A basic prelude of values lifted into the type system.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hTrue

        +
        public static HPre.HTrue hTrue()
        +
        Returns a boolean value whose type represents truth.
        +
        +
        Returns:
        +
        a boolean value whose type represents truth.
        +
        +
        • +
      + + + +
        +
      • +

        hFalse

        +
        public static HPre.HFalse hFalse()
        +
        Returns a boolean value whose type represents falsehood.
        +
        +
        Returns:
        +
        a boolean value whose type represents falsehood.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/package-frame.html b/javadoc/5.0/functionaljava/fj/data/hlist/package-frame.html new file mode 100644 index 0000000..37a2011 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/package-frame.html @@ -0,0 +1,36 @@ + + + + + +fj.data.hlist (core 5.0 API) + + + + +

fj.data.hlist

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/package-summary.html b/javadoc/5.0/functionaljava/fj/data/hlist/package-summary.html new file mode 100644 index 0000000..84fc86d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/package-summary.html @@ -0,0 +1,252 @@ + + + + + +fj.data.hlist (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.hlist

+
+
Type-safe, extensible, heterogeneous lists
+
+

See: Description

+
+
+ + + + +

Package fj.data.hlist Description

+
Type-safe, extensible, heterogeneous lists
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/hlist/package-tree.html b/javadoc/5.0/functionaljava/fj/data/hlist/package-tree.html new file mode 100644 index 0000000..cce0c83 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/hlist/package-tree.html @@ -0,0 +1,160 @@ + + + + + +fj.data.hlist Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.hlist

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Fold.html b/javadoc/5.0/functionaljava/fj/data/optic/Fold.html new file mode 100644 index 0000000..64864a6 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Fold.html @@ -0,0 +1,523 @@ + + + + + +Fold (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Fold<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Fold<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Fold
    +
    A - the target of a Fold
    +
    +
    +
    +
    public abstract class Fold<S,A>
+extends java.lang.Object
    +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target. + + Fold is on the top of the Optic hierarchy which means that Getter, PTraversal, POptional, + PLens, PPrism and PIso are valid Fold
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fold

        +
        public Fold()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> m,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a Fold matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a Fold
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public final <S1> Fold<Either<S,S1>,A> sum(Fold<S1,A> other)
        +
        join two Fold with the same target
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <B> Fold<S,B> composeFold(Fold<A,B> other)
        +
        compose a Fold with a Fold
        +
        • +
      + + + +
        +
      • +

        composeGetter

        +
        public final <C> Fold<S,C> composeGetter(Getter<A,C> other)
        +
        compose a Fold with a Getter
        +
        • +
      + + + + + + + +
        +
      • +

        composePrism

        +
        public final <B,C,D> Fold<S,C> composePrism(PPrism<A,B,C,D> other)
        +
        compose a Fold with a PPrism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public final <B,C,D> Fold<S,C> composeLens(PLens<A,B,C,D> other)
        +
        compose a Fold with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <B,C,D> Fold<S,C> composeIso(PIso<A,B,C,D> other)
        +
        compose a Fold with a PIso
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <A> Fold<A,A> id()
        +
        • +
      + + + +
        +
      • +

        codiagonal

        +
        public static <A> Fold<Either<A,A>,A> codiagonal()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Getter.html b/javadoc/5.0/functionaljava/fj/data/optic/Getter.html new file mode 100644 index 0000000..b6dc862 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Getter.html @@ -0,0 +1,456 @@ + + + + + +Getter (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class Getter<S,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.Getter<S,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a Getter
    +
    A - the target of a Getter
    +
    +
    +
    +
    public abstract class Getter<S,A>
+extends java.lang.Object
    +
    A Getter can be seen as a glorified get method between a type S and a type A. + + A Getter is also a valid Fold
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Iso.html b/javadoc/5.0/functionaljava/fj/data/optic/Iso.html new file mode 100644 index 0000000..389aea7 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Iso.html @@ -0,0 +1,623 @@ + + + + + +Iso (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Iso<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Iso<S,A>
+extends PIso<S,S,A,A>
    +
    PIso when S = T and A = B
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Iso

        +
        public Iso(PIso<S,S,A,A> pIso)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public A get(S s)
        +
        Description copied from class: PIso
        +
        get the target of a PIso
        +
        +
        Specified by:
        +
        get in class PIso<S,S,A,A>
        +
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public S reverseGet(A a)
        +
        Description copied from class: PIso
        +
        get the modified source of a PIso
        +
        +
        Specified by:
        +
        reverseGet in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Iso<A,S> reverse()
        +
        Description copied from class: PIso
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        +
        Specified by:
        +
        reverse in class PIso<S,S,A,A>
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public <S1,A1> Iso<P2<S,S1>,P2<A,A1>> product(Iso<S1,A1> other)
        +
        pair two disjoint Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composePrism

        +
        public <C> Prism<S,C> composePrism(Prism<A,C> other)
        +
        compose an Iso with a Prism
        +
        • +
      + + + +
        +
      • +

        composeLens

        +
        public <C> Lens<S,C> composeLens(Lens<A,C> other)
        +
        compose an Iso with a Lens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public <C> Iso<S,C> composeIso(Iso<A,C> other)
        +
        compose an Iso with an Iso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        iso

        +
        public static <S,A> Iso<S,A> iso(F<S,A> get,
+                                 F<A,S> reverseGet)
        +
        create an Iso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        id

        +
        public static <S> Iso<S,S> id()
        +
        create an Iso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        
+  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Lens.html b/javadoc/5.0/functionaljava/fj/data/optic/Lens.html new file mode 100644 index 0000000..25b4923 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Lens.html @@ -0,0 +1,769 @@ + + + + + +Lens (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Lens<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Lens<S,A>
+extends PLens<S,S,A,A>
    +
    PLens with a monomorphic set function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Optional.html b/javadoc/5.0/functionaljava/fj/data/optic/Optional.html new file mode 100644 index 0000000..ebe75d2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Optional.html @@ -0,0 +1,816 @@ + + + + + +Optional (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Optional<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Optional<S,A>
+extends POptional<S,S,A,A>
    +
    POptional restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/PIso.html b/javadoc/5.0/functionaljava/fj/data/optic/PIso.html new file mode 100644 index 0000000..de7b824 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/PIso.html @@ -0,0 +1,843 @@ + + + + + +PIso (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PIso<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PIso<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PIso
    +
    T - the modified source of a PIso
    +
    A - the target of a PIso
    +
    B - the modified target of a PIso
    +
    +
    +
    Direct Known Subclasses:
    +
    Iso
    +
    +
    +
    +
    public abstract class PIso<S,T,A,B>
+extends java.lang.Object
    +
    A PIso defines an isomorphism between types S, A and B, T: + + 
    
+              get                           reverse.get
+     -------------------->             -------------------->
+   S                       A         T                       B
+     <--------------------             <--------------------
+       reverse.reverseGet                   reverseGet
+
    + + In addition, if f and g forms an isomorphism between A and B, i.e. if f . g = id and g . f = id, then a PIso + defines an isomorphism between S and T: + + 
    
+     S           T                                   S           T
+     |           |                                   |           |
+     |           |                                   |           |
+ get |           | reverseGet     reverse.reverseGet |           | reverse.get
+     |           |                                   |           |
+     |     f     |                                   |     g     |
+     A --------> B                                   A <-------- B
+
    + + A PIso is also a valid Getter, Fold, PLens, PPrism, POptional, + PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PIso
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PIso
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public abstract PIso<B,A,T,S> reverse()
        +
        reverse a PIso: the source becomes the target and the target becomes the source
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PIso with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PIso with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PIso with a value
        +
        • +
      + + + +
        +
      • +

        product

        +
        public final <S1,T1,A1,B1> PIso<P2<S,S1>,P2<T,T1>,P2<A,A1>,P2<B,B1>> product(PIso<S1,T1,A1,B1> other)
        +
        pair two disjoint PIso
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PIso with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PIso with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PIso<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PIso with a PIso
        +
        • +
      + + + +
        +
      • +

        asFold

        +
        public final Fold<S,A> asFold()
        +
        view a PIso as a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pIso

        +
        public static <S,T,A,B> PIso<S,T,A,B> pIso(F<S,A> get,
+                                           F<B,T> reverseGet)
        +
        create a PIso using a pair of functions: one to get the target and one to get the source.
        +
        • +
      + + + +
        +
      • +

        pId

        +
        public static <S,T> PIso<S,T,S,T> pId()
        +
        create a PIso between any type and itself. id is the zero element of optics composition, for all optics o of type O + (e.g. Lens, Iso, Prism, ...): + + 
        
+  o composeIso Iso.id == o
+  Iso.id composeO o == o
+
        + + (replace composeO by composeLens, composeIso, composePrism, ...)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/PLens.html b/javadoc/5.0/functionaljava/fj/data/optic/PLens.html new file mode 100644 index 0000000..f89493e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/PLens.html @@ -0,0 +1,729 @@ + + + + + +PLens (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PLens<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PLens<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PLens
    +
    T - the modified source of a PLens
    +
    A - the target of a PLens
    +
    B - the modified target of a PLens
    +
    +
    +
    Direct Known Subclasses:
    +
    Lens
    +
    +
    +
    +
    public abstract class PLens<S,T,A,B>
+extends java.lang.Object
    +
    A PLens can be seen as a pair of functions:
      +
    • get: S => A i.e. from an S, we can extract an A
      • +
    • set: (B, S) => T i.e. if we replace an A by a B in an S, we obtain a T
      • +
    +

    + A PLens could also be defined as a weaker PIso where set requires an additional parameter than reverseGet.

    +

    + PLens stands for Polymorphic Lens as it set and modify methods change a type A to B and S to T. Lens + is a PLens restricted to monomoprhic updates.

    +

    + A PLens is also a valid Getter, Fold, POptional, PTraversal and PSetter

    +

    + Typically a PLens or Lens can be defined between a Product (e.g. case class, tuple, HList) and one of it is + component.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public abstract A get(S s)
        +
        get the target of a PLens
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public abstract F<S,T> set(B b)
        +
        set polymorphically the target of a PLens using a function
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public abstract <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PLens with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public abstract F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PLens using a function
        +
        • +
      + + + + + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PLens with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeLens

        +
        public final <C,D> PLens<S,T,C,D> composeLens(PLens<A,B,C,D> other)
        +
        compose a PLens with a PLens
        +
        • +
      + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PLens<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PLens with an PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PLens<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pLens

        +
        public static <S,T,A,B> PLens<S,T,A,B> pLens(F<S,A> get,
+                                             F<B,F<S,T>> set)
        +
        create a PLens using a pair of functions: one to get the target, one to set the target.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/POptional.html b/javadoc/5.0/functionaljava/fj/data/optic/POptional.html new file mode 100644 index 0000000..5d99dc8 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/POptional.html @@ -0,0 +1,789 @@ + + + + + +POptional (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class POptional<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.POptional<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a POptional
    +
    T - the modified source of a POptional
    +
    A - the target of a POptional
    +
    B - the modified target of a POptional
    +
    +
    +
    Direct Known Subclasses:
    +
    Optional
    +
    +
    +
    +
    public abstract class POptional<S,T,A,B>
+extends java.lang.Object
    +
    A POptional can be seen as a pair of functions:
      +
    • getOrModify: S => T \/ A
      • +
    • set : (B, S) => T
      • +
    +

    + A POptional could also be defined as a weaker PLens and weaker PPrism

    +

    + POptional stands for Polymorphic Optional as it set and modify methods change a type A to B and S to T. + Optional is a POptional restricted to monomoprhic updates: type Optional[S, A] = POptional[S, S, A, A]

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/PPrism.html b/javadoc/5.0/functionaljava/fj/data/optic/PPrism.html new file mode 100644 index 0000000..b9c597f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/PPrism.html @@ -0,0 +1,801 @@ + + + + + +PPrism (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PPrism<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PPrism<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PPrism
    +
    T - the modified source of a PPrism
    +
    A - the target of a PPrism
    +
    B - the modified target of a PPrism
    +
    +
    +
    Direct Known Subclasses:
    +
    Prism
    +
    +
    +
    +
    public abstract class PPrism<S,T,A,B>
+extends java.lang.Object
    +
    A PPrism can be seen as a pair of functions:
      +
    • getOrModify: S => T \/ A
      • +
    • reverseGet : B => T
      • +
    +

    + A PPrism could also be defined as a weaker PIso where get can fail.

    +

    + Typically a PPrism or Prism encodes the relation between a Sum or CoProduct type (e.g. sealed trait) and one + of it is element.

    + + PPrism stands for Polymorphic Prism as it set and modify methods change a type A to B and S to T. + Prism is a PPrism where the type of target cannot be modified. + + A PPrism is also a valid Fold, POptional, PTraversal and PSetter
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        getOrModify

        +
        public abstract Either<T,A> getOrModify(S s)
        +
        get the target of a PPrism or modify the source in case there is no target
        +
        • +
      + + + + + +
        +
      • +

        reverseGet

        +
        public abstract T reverseGet(B b)
        +
        get the modified source of a PPrism
        +
        • +
      + + + + + +
        +
      • +

        getOption

        +
        public abstract Option<A> getOption(S s)
        +
        get the target of a PPrism or nothing if there is no target
        +
        • +
      + + + +
        +
      • +

        modifyFunctionF

        +
        public final <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public final <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public final F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public final F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public final F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public final F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public final F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public final F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public final F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyValidationF

        +
        public final <E> F<S,Validation<E,T>> modifyValidationF(F<A,Validation<E,B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyV2F

        +
        public final F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PPrism with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function
        +
        • +
      + + + +
        +
      • +

        modifyOption

        +
        public final F<S,Option<T>> modifyOption(F<A,B> f)
        +
        modify polymorphically the target of a PPrism with a function. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PPrism with a value
        +
        • +
      + + + + + +
        +
      • +

        setOption

        +
        public final F<S,Option<T>> setOption(B b)
        +
        set polymorphically the target of a PPrism with a value. return empty if the PPrism is not matching
        +
        • +
      + + + + + +
        +
      • +

        isMatching

        +
        public final boolean isMatching(S s)
        +
        check if a PPrism has a target
        +
        • +
      + + + +
        +
      • +

        re

        +
        public final Getter<B,T> re()
        +
        create a Getter from the modified target to the modified source of a PPrism
        +
        • +
      + + + +
        +
      • +

        composeFold

        +
        public final <C> Fold<S,C> composeFold(Fold<A,C> other)
        +
        compose a PPrism with a Fold
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        composeIso

        +
        public final <C,D> PPrism<S,T,C,D> composeIso(PIso<A,B,C,D> other)
        +
        compose a PPrism with a PIso
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PPrism<S,T,S,T> pId()
        +
        • +
      + + + +
        +
      • +

        pPrism

        +
        public static <S,T,A,B> PPrism<S,T,A,B> pPrism(F<S,Either<T,A>> getOrModify,
+                                               F<B,T> reverseGet)
        +
        create a PPrism using the canonical functions: getOrModify and reverseGet
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/PSetter.html b/javadoc/5.0/functionaljava/fj/data/optic/PSetter.html new file mode 100644 index 0000000..3564adb --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/PSetter.html @@ -0,0 +1,425 @@ + + + + + +PSetter (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.optic
+

Class PSetter<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PSetter<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PSetter
    +
    T - the modified source of a PSetter
    +
    A - the target of a PSetter
    +
    B - the modified target of a PSetter
    +
    +
    +
    Direct Known Subclasses:
    +
    Setter
    +
    +
    +
    +
    public abstract class PSetter<S,T,A,B>
+extends java.lang.Object
    +
    A PSetter is a generalisation of Functor map:
      +
    • map: (A => B) => F[A] => F[B]
      • +
    • modify: (A => B) => S => T
      • +
    +

    + PSetter stands for Polymorphic Setter as it set and modify methods change a type A to B and S to T.

    +

    + PTraversal, POptional, PPrism, PLens and PIso are valid PSetter

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/PTraversal.html b/javadoc/5.0/functionaljava/fj/data/optic/PTraversal.html new file mode 100644 index 0000000..2f646e9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/PTraversal.html @@ -0,0 +1,907 @@ + + + + + +PTraversal (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class PTraversal<S,T,A,B>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.optic.PTraversal<S,T,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    S - the source of a PTraversal
    +
    T - the modified source of a PTraversal
    +
    A - the target of a PTraversal
    +
    B - the modified target of a PTraversal
    +
    +
    +
    Direct Known Subclasses:
    +
    Traversal
    +
    +
    +
    +
    public abstract class PTraversal<S,T,A,B>
+extends java.lang.Object
    +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite. +

    + PTraversal stands for Polymorphic Traversal as it set and modify methods change a type A to B and S to T. + Traversal is a PTraversal restricted to monomoprhic updates.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PTraversal

        +
        public PTraversal()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        modifyFunctionF

        +
        public abstract <C> F<S,F<C,T>> modifyFunctionF(F<A,F<C,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyEitherF

        +
        public abstract <L> F<S,Either<L,T>> modifyEitherF(F<A,Either<L,B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyIOF

        +
        public abstract F<S,IO<T>> modifyIOF(F<A,IO<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyTrampolineF

        +
        public abstract F<S,Trampoline<T>> modifyTrampolineF(F<A,Trampoline<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyPromiseF

        +
        public abstract F<S,Promise<T>> modifyPromiseF(F<A,Promise<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyListF

        +
        public abstract F<S,List<T>> modifyListF(F<A,List<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyOptionF

        +
        public abstract F<S,Option<T>> modifyOptionF(F<A,Option<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyStreamF

        +
        public abstract F<S,Stream<T>> modifyStreamF(F<A,Stream<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        modifyP1F

        +
        public abstract F<S,P1<T>> modifyP1F(F<A,P1<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + + + + + +
        +
      • +

        modifyV2F

        +
        public abstract F<S,V2<T>> modifyV2F(F<A,V2<B>> f)
        +
        modify polymorphically the target of a PTraversal with an Applicative function
        +
        • +
      + + + +
        +
      • +

        foldMap

        +
        public abstract <M> F<S,M> foldMap(Monoid<M> monoid,
+                                   F<A,M> f)
        +
        map each target to a Monoid and combine the results
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public final F<S,A> fold(Monoid<A> m)
        +
        combine all targets using a target's Monoid
        +
        • +
      + + + + + +
        +
      • +

        getAll

        +
        public final List<A> getAll(S s)
        +
        get all the targets of a PTraversal
        +
        • +
      + + + +
        +
      • +

        find

        +
        public final F<S,Option<A>> find(F<A,java.lang.Boolean> p)
        +
        find the first target of a PTraversal matching the predicate
        +
        • +
      + + + + + +
        +
      • +

        headOption

        +
        public final Option<A> headOption(S s)
        +
        get the first target of a PTraversal
        +
        • +
      + + + +
        +
      • +

        exist

        +
        public final F<S,java.lang.Boolean> exist(F<A,java.lang.Boolean> p)
        +
        check if at least one target satisfies the predicate
        +
        • +
      + + + +
        +
      • +

        all

        +
        public final F<S,java.lang.Boolean> all(F<A,java.lang.Boolean> p)
        +
        check if all targets satisfy the predicate
        +
        • +
      + + + +
        +
      • +

        modify

        +
        public final F<S,T> modify(F<A,B> f)
        +
        modify polymorphically the target of a PTraversal with a function
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public final F<S,T> set(B b)
        +
        set polymorphically the target of a PTraversal with a value
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        pId

        +
        public static <S,T> PTraversal<S,T,S,T> pId()
        +
        • +
      + + + + + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F3<B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F4<B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F5<B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F6<B,B,B,B,B,S,T> set)
        +
        • +
      + + + +
        +
      • +

        pTraversal

        +
        public static <S,T,A,B> PTraversal<S,T,A,B> pTraversal(F<S,A> get1,
+                                                       F<S,A> get2,
+                                                       F<S,A> get3,
+                                                       F<S,A> get4,
+                                                       F<S,A> get5,
+                                                       F<S,A> get6,
+                                                       F7<B,B,B,B,B,B,S,T> set)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Prism.html b/javadoc/5.0/functionaljava/fj/data/optic/Prism.html new file mode 100644 index 0000000..2162882 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Prism.html @@ -0,0 +1,521 @@ + + + + + +Prism (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Prism<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Prism<S,A>
+extends PPrism<S,S,A,A>
    +
    PPrism restricted to monomorphic update
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Setter.html b/javadoc/5.0/functionaljava/fj/data/optic/Setter.html new file mode 100644 index 0000000..1be75b2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Setter.html @@ -0,0 +1,418 @@ + + + + + +Setter (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Setter<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Setter<S,A>
+extends PSetter<S,S,A,A>
    +
    PSetter with a monomorphic modify function
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/Traversal.html b/javadoc/5.0/functionaljava/fj/data/optic/Traversal.html new file mode 100644 index 0000000..a087650 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/Traversal.html @@ -0,0 +1,722 @@ + + + + + +Traversal (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.data.optic
+

Class Traversal<S,A>

+
+
+ +
+
    +
  • +
    +
    +
    public final class Traversal<S,A>
+extends PTraversal<S,S,A,A>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/package-frame.html b/javadoc/5.0/functionaljava/fj/data/optic/package-frame.html new file mode 100644 index 0000000..c74717a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/package-frame.html @@ -0,0 +1,32 @@ + + + + + +fj.data.optic (core 5.0 API) + + + + +

fj.data.optic

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/package-summary.html b/javadoc/5.0/functionaljava/fj/data/optic/package-summary.html new file mode 100644 index 0000000..c224185 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/package-summary.html @@ -0,0 +1,246 @@ + + + + + +fj.data.optic (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.optic

+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Fold<S,A> +
    A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
    +
    Getter<S,A> +
    A Getter can be seen as a glorified get method between a type S and a type A.
    +
    Iso<S,A> +
    PIso when S = T and A = B
    +
    Lens<S,A> +
    PLens with a monomorphic set function
    +
    Optional<S,A> +
    POptional restricted to monomorphic update
    +
    PIso<S,T,A,B> +
    A PIso defines an isomorphism between types S, A and B, T:
    +
    PLens<S,T,A,B> +
    A PLens can be seen as a pair of functions: + get: S => A i.e.
    +
    POptional<S,T,A,B> +
    A POptional can be seen as a pair of functions: + getOrModify: S => T \/ A + set : (B, S) => T +
    +
    PPrism<S,T,A,B> +
    A PPrism can be seen as a pair of functions: + getOrModify: S => T \/ A + reverseGet : B => T +
    +
    Prism<S,A> +
    PPrism restricted to monomorphic update
    +
    PSetter<S,T,A,B> +
    A PSetter is a generalisation of Functor map: + map: (A => B) => F[A] => F[B] + modify: (A => B) => S => T +
    +
    PTraversal<S,T,A,B> +
    A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
    +
    Setter<S,A> +
    PSetter with a monomorphic modify function
    +
    Traversal<S,A> 
    +
    • +
+ + + +

Package fj.data.optic Description

+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library. See the Monocle Github + page for an overview of the package.
+
+
See Also:
+
Monocle
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/optic/package-tree.html b/javadoc/5.0/functionaljava/fj/data/optic/package-tree.html new file mode 100644 index 0000000..b70459c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/optic/package-tree.html @@ -0,0 +1,165 @@ + + + + + +fj.data.optic Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.optic

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.optic.Fold<S,A>
      • +
    • fj.data.optic.Getter<S,A>
      • +
    • fj.data.optic.PIso<S,T,A,B> +
        +
      • fj.data.optic.Iso<S,A>
        • +
      +
      • +
    • fj.data.optic.PLens<S,T,A,B> +
        +
      • fj.data.optic.Lens<S,A>
        • +
      +
      • +
    • fj.data.optic.POptional<S,T,A,B> + +
      • +
    • fj.data.optic.PPrism<S,T,A,B> +
        +
      • fj.data.optic.Prism<S,A>
        • +
      +
      • +
    • fj.data.optic.PSetter<S,T,A,B> + +
      • +
    • fj.data.optic.PTraversal<S,T,A,B> + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/package-frame.html b/javadoc/5.0/functionaljava/fj/data/package-frame.html new file mode 100644 index 0000000..53dad3f --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/package-frame.html @@ -0,0 +1,69 @@ + + + + + +fj.data (core 5.0 API) + + + + +

fj.data

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/package-summary.html b/javadoc/5.0/functionaljava/fj/data/package-summary.html new file mode 100644 index 0000000..fa7fc9c --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/package-summary.html @@ -0,0 +1,424 @@ + + + + + +fj.data (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data

+
+
Common algebraic data types.
+
+

See: Description

+
+
+ + + + +

Package fj.data Description

+
Common algebraic data types.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/package-tree.html b/javadoc/5.0/functionaljava/fj/data/package-tree.html new file mode 100644 index 0000000..f0b9d22 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/package-tree.html @@ -0,0 +1,199 @@ + + + + + +fj.data Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+
    +
  • fj.function.Try0<A,Z> +
      +
    • fj.data.IO<A> + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V.html b/javadoc/5.0/functionaljava/fj/data/vector/V.html new file mode 100644 index 0000000..e10e778 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V.html @@ -0,0 +1,546 @@ + + + + + +V (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class V
+extends java.lang.Object
    +
    Functions across vectors.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> V2<A>v(A a1, + A a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(A a1, + A a2, + A a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(A a1, + A a2, + A a3, + A a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(A a1, + A a2, + A a3, + A a4, + A a5) +
      Puts elements in a vector-5.
      +
      static <A> V2<A>v(F0<A> a1, + F0<A> a2) +
      Puts elements in a vector-2.
      +
      static <A> V3<A>v(P1<A> a1, + F0<A> a2, + F0<A> a3) +
      Puts elements in a vector-3.
      +
      static <A> V4<A>v(P1<A> a1, + P1<A> a2, + F0<A> a3, + F0<A> a4) +
      Puts elements in a vector-4.
      +
      static <A> V5<A>v(P1<A> a1, + P1<A> a2, + P1<A> a3, + F0<A> a4, + F0<A> a5) +
      Puts elements in a vector-5.
      +
      static <A> F2<A,A,V2<A>>v2() +
      Returns a function that puts elements in a vector-2.
      +
      static <A> F3<A,A,A,V3<A>>v3() +
      Returns a function that puts elements in a vector-3.
      +
      static <A> F4<A,A,A,A,V4<A>>v4() +
      Returns a function that puts elements in a vector-4.
      +
      static <A> F5<A,A,A,A,A,V5<A>>v5() +
      Returns a function that puts elements in a vector-5.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(A a1,
+                          A a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V2<A> v(F0<A> a1,
+                          F0<A> a2)
        +
        Puts elements in a vector-2.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        Returns:
        +
        The vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        v2

        +
        public static <A> F2<A,A,V2<A>> v2()
        +
        Returns a function that puts elements in a vector-2.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-2.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(A a1,
+                          A a2,
+                          A a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V3<A> v(P1<A> a1,
+                          F0<A> a2,
+                          F0<A> a3)
        +
        Puts elements in a vector-3.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        Returns:
        +
        The vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        v3

        +
        public static <A> F3<A,A,A,V3<A>> v3()
        +
        Returns a function that puts elements in a vector-3.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-3.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V4<A> v(P1<A> a1,
+                          P1<A> a2,
+                          F0<A> a3,
+                          F0<A> a4)
        +
        Puts elements in a vector-4.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        Returns:
        +
        The vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        v4

        +
        public static <A> F4<A,A,A,A,V4<A>> v4()
        +
        Returns a function that puts elements in a vector-4.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-4.
        +
        +
        • +
      + + + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(A a1,
+                          A a2,
+                          A a3,
+                          A a4,
+                          A a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v

        +
        public static <A> V5<A> v(P1<A> a1,
+                          P1<A> a2,
+                          P1<A> a3,
+                          F0<A> a4,
+                          F0<A> a5)
        +
        Puts elements in a vector-5.
        +
        +
        Parameters:
        +
        a1 - An element to put in a vector.
        +
        a2 - An element to put in a vector.
        +
        a3 - An element to put in a vector.
        +
        a4 - An element to put in a vector.
        +
        a5 - An element to put in a vector.
        +
        Returns:
        +
        The vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        v5

        +
        public static <A> F5<A,A,A,A,A,V5<A>> v5()
        +
        Returns a function that puts elements in a vector-5.
        +
        +
        Returns:
        +
        A function that puts elements in a vector-5.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V2.html b/javadoc/5.0/functionaljava/fj/data/vector/V2.html new file mode 100644 index 0000000..b193fb8 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V2.html @@ -0,0 +1,646 @@ + + + + + +V2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V2<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V2<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V2<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-2.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V2<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V2<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      <B> V2<B>apply(V2<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Return the first element of this vector as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V2<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V2<A>,P2<A,A>>p_() +
      Returns a function that transforms a vector-2 to the equivalent product-2.
      +
      P2<A,A>p() +
      Returns a homogeneous product-2 equivalent to this vector.
      +
      static <A> V2<A>p(P2<A,A> p) +
      Creates a vector-2 from a homogeneous product-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V2<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-2 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V2<V2<A>>vzip(V2<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V2<P2<A,B>>zip(V2<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V2<C>zipWith(F<A,F<B,C>> f, + V2<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V2<A> p(P2<A,A> p)
        +
        Creates a vector-2 from a homogeneous product-2.
        +
        +
        Parameters:
        +
        p - The product-2 from which to create a vector.
        +
        Returns:
        +
        A new vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V2<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V2<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P2<A,A> p()
        +
        Returns a homogeneous product-2 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-2 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V2<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-2 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V2<A>,P2<A,A>> p_()
        +
        Returns a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        Returns:
        +
        a function that transforms a vector-2 to the equivalent product-2.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V2<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V2<B> apply(V2<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V2<C> zipWith(F<A,F<B,C>> f,
+                           V2<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V2<P2<A,B>> zip(V2<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V2<V2<A>> vzip(V2<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Return the first element of this vector as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector as a product-1.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V3.html b/javadoc/5.0/functionaljava/fj/data/vector/V3.html new file mode 100644 index 0000000..08c47a3 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V3.html @@ -0,0 +1,731 @@ + + + + + +V3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V3<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V3<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V3<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-3.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V3<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V3<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V3<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      <B> V3<B>apply(V3<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V3<A>cons(P1<A> head, + V2<A> tail) +
      Creates a vector-3 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V3<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V3<A>,P3<A,A,A>>p_() +
      Returns a function that transforms a vector-3 to the equivalent product-3.
      +
      P3<A,A,A>p() +
      Returns a homogeneous product-3 equivalent to this vector.
      +
      static <A> V3<A>p(P3<A,A,A> p) +
      Creates a vector-3 from a homogeneous product-3.
      +
      V2<A>tail() +
      Returns all but the first element of this vector, as a vector-2.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V3<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-3 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V3<V2<A>>vzip(V3<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V3<P2<A,B>>zip(V3<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V3<C>zipWith(F<A,F<B,C>> f, + V3<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V3<A> p(P3<A,A,A> p)
        +
        Creates a vector-3 from a homogeneous product-3.
        +
        +
        Parameters:
        +
        p - The product-3 from which to create a vector.
        +
        Returns:
        +
        A new vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V3<A> cons(P1<A> head,
+                             V2<A> tail)
        +
        Creates a vector-3 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V2<A> tail()
        +
        Returns all but the first element of this vector, as a vector-2.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-2.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P3<A,A,A> p()
        +
        Returns a homogeneous product-3 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-3 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V3<B> apply(V3<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V3<C> zipWith(F<A,F<B,C>> f,
+                           V3<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V3<P2<A,B>> zip(V3<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V3<V2<A>> vzip(V3<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V3<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V3<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-3 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V3<A>,P3<A,A,A>> p_()
        +
        Returns a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        Returns:
        +
        a function that transforms a vector-3 to the equivalent product-3.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V3<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V3<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V3<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V4.html b/javadoc/5.0/functionaljava/fj/data/vector/V4.html new file mode 100644 index 0000000..2fd59bc --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V4.html @@ -0,0 +1,771 @@ + + + + + +V4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V4<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V4<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V4<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-4.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V4<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V4<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V4<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V4<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      <B> V4<B>apply(V4<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V4<A>cons(P1<A> head, + V3<A> tail) +
      Creates a vector-4 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V4<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V4<A>,P4<A,A,A,A>>p_() +
      Returns a function that transforms a vector-4 to the equivalent product-4.
      +
      P4<A,A,A,A>p() +
      Returns a homogeneous product-4 equivalent to this vector.
      +
      static <A> V4<A>p(P4<A,A,A,A> p) +
      Creates a vector-4 from a homogeneous product-4.
      +
      V3<A>tail() +
      Returns all but the first element of this vector, as a vector-3.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V4<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-4 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V4<V2<A>>vzip(V4<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V4<P2<A,B>>zip(V4<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V4<C>zipWith(F<A,F<B,C>> f, + V4<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V4<A> p(P4<A,A,A,A> p)
        +
        Creates a vector-4 from a homogeneous product-4.
        +
        +
        Parameters:
        +
        p - The product-4 from which to create a vector.
        +
        Returns:
        +
        A new vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V4<A> cons(P1<A> head,
+                             V3<A> tail)
        +
        Creates a vector-4 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V3<A> tail()
        +
        Returns all but the first element of this vector, as a vector-3.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-3.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P4<A,A,A,A> p()
        +
        Returns a homogeneous product-4 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-4 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V4<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V4<B> apply(V4<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V4<C> zipWith(F<A,F<B,C>> f,
+                           V4<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V4<P2<A,B>> zip(V4<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V4<V2<A>> vzip(V4<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V4<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-4 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V4<A>,P4<A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        Returns:
        +
        a function that transforms a vector-4 to the equivalent product-4.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V4<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V4<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V4<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V4<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V5.html b/javadoc/5.0/functionaljava/fj/data/vector/V5.html new file mode 100644 index 0000000..4103ae7 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V5.html @@ -0,0 +1,811 @@ + + + + + +V5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V5<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V5<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V5<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-5.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V5<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V5<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V5<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V5<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V5<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      <B> V5<B>apply(V5<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V5<A>cons(P1<A> head, + V4<A> tail) +
      Creates a vector-5 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V5<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V5<A>,P5<A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-5 to the equivalent product-5.
      +
      P5<A,A,A,A,A>p() +
      Returns a homogeneous product-5 equivalent to this vector.
      +
      static <A> V5<A>p(P5<A,A,A,A,A> p) +
      Creates a vector-5 from a homogeneous product-5.
      +
      V4<A>tail() +
      Returns all but the first element of this vector, as a vector-4.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V5<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-5 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V5<V2<A>>vzip(V5<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V5<P2<A,B>>zip(V5<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V5<C>zipWith(F<A,F<B,C>> f, + V5<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V5<A> p(P5<A,A,A,A,A> p)
        +
        Creates a vector-5 from a homogeneous product-5.
        +
        +
        Parameters:
        +
        p - The product-5 from which to create a vector.
        +
        Returns:
        +
        A new vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V5<A> cons(P1<A> head,
+                             V4<A> tail)
        +
        Creates a vector-5 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V4<A> tail()
        +
        Returns all but the first element of this vector, as a vector-4.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-4.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P5<A,A,A,A,A> p()
        +
        Returns a homogeneous product-5 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-5 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V5<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V5<B> apply(V5<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V5<C> zipWith(F<A,F<B,C>> f,
+                           V5<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V5<P2<A,B>> zip(V5<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V5<V2<A>> vzip(V5<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V5<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-5 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V5<A>,P5<A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        Returns:
        +
        a function that transforms a vector-5 to the equivalent product-5.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V5<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V5<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V5<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V5<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V5<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V6.html b/javadoc/5.0/functionaljava/fj/data/vector/V6.html new file mode 100644 index 0000000..41b0d9b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V6.html @@ -0,0 +1,851 @@ + + + + + +V6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V6<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V6<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V6<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-6.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V6<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V6<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V6<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V6<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V6<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V6<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      <B> V6<B>apply(V6<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V6<A>cons(P1<A> head, + V5<A> tail) +
      Creates a vector-6 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V6<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V6<A>,P6<A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-6 to the equivalent product-6.
      +
      P6<A,A,A,A,A,A>p() +
      Returns a homogeneous product-6 equivalent to this vector.
      +
      static <A> V6<A>p(P6<A,A,A,A,A,A> p) +
      Creates a vector-6 from a homogeneous product-6.
      +
      V5<A>tail() +
      Returns all but the first element of this vector, as a vector-5.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V6<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-6 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V6<V2<A>>vzip(V6<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V6<P2<A,B>>zip(V6<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V6<C>zipWith(F<A,F<B,C>> f, + V6<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V6<A> p(P6<A,A,A,A,A,A> p)
        +
        Creates a vector-6 from a homogeneous product-6.
        +
        +
        Parameters:
        +
        p - The product-6 from which to create a vector.
        +
        Returns:
        +
        A new vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V6<A> cons(P1<A> head,
+                             V5<A> tail)
        +
        Creates a vector-6 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V5<A> tail()
        +
        Returns all but the first element of this vector, as a vector-5.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-5.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P6<A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-6 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-6 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V6<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V6<B> apply(V6<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V6<C> zipWith(F<A,F<B,C>> f,
+                           V6<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V6<P2<A,B>> zip(V6<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V6<V2<A>> vzip(V6<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V6<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-6 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V6<A>,P6<A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        Returns:
        +
        a function that transforms a vector-6 to the equivalent product-6.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V6<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V6<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V6<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V6<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V6<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V6<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V7.html b/javadoc/5.0/functionaljava/fj/data/vector/V7.html new file mode 100644 index 0000000..bd0a8a9 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V7.html @@ -0,0 +1,891 @@ + + + + + +V7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V7<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V7<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V7<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-7.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V7<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V7<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V7<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V7<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V7<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V7<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V7<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      <B> V7<B>apply(V7<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V7<A>cons(P1<A> head, + V6<A> tail) +
      Creates a vector-7 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V7<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V7<A>,P7<A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-7 to the equivalent product-7.
      +
      P7<A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-7 equivalent to this vector.
      +
      static <A> V7<A>p(P7<A,A,A,A,A,A,A> p) +
      Creates a vector-7 from a homogeneous product-7.
      +
      V6<A>tail() +
      Returns all but the first element of this vector, as a vector-6.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V7<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-7 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V7<V2<A>>vzip(V7<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V7<P2<A,B>>zip(V7<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V7<C>zipWith(F<A,F<B,C>> f, + V7<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V7<A> p(P7<A,A,A,A,A,A,A> p)
        +
        Creates a vector-7 from a homogeneous product-7.
        +
        +
        Parameters:
        +
        p - The product-7 from which to create a vector.
        +
        Returns:
        +
        A new vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V7<A> cons(P1<A> head,
+                             V6<A> tail)
        +
        Creates a vector-7 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V6<A> tail()
        +
        Returns all but the first element of this vector, as a vector-6.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-6.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P7<A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-7 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-7 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V7<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V7<B> apply(V7<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V7<C> zipWith(F<A,F<B,C>> f,
+                           V7<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V7<P2<A,B>> zip(V7<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V7<V2<A>> vzip(V7<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V7<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-7 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V7<A>,P7<A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        Returns:
        +
        a function that transforms a vector-7 to the equivalent product-7.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V7<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V7<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V7<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V7<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V7<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V7<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V7<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/V8.html b/javadoc/5.0/functionaljava/fj/data/vector/V8.html new file mode 100644 index 0000000..fcd65e1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/V8.html @@ -0,0 +1,931 @@ + + + + + +V8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.data.vector
+

Class V8<A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.data.vector.V8<A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class V8<A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A vector-8.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<V8<A>,A>__1() +
      A first-class function to get the first element of a vector.
      +
      static <A> F<V8<A>,A>__2() +
      A first-class function to get the second element of a vector.
      +
      static <A> F<V8<A>,A>__3() +
      A first-class function to get the third element of a vector.
      +
      static <A> F<V8<A>,A>__4() +
      A first-class function to get the fourth element of a vector.
      +
      static <A> F<V8<A>,A>__5() +
      A first-class function to get the fifth element of a vector.
      +
      static <A> F<V8<A>,A>__6() +
      A first-class function to get the sixth element of a vector.
      +
      static <A> F<V8<A>,A>__7() +
      A first-class function to get the seventh element of a vector.
      +
      static <A> F<V8<A>,A>__8() +
      A first-class function to get the eighth element of a vector.
      +
      A_1() +
      Returns the first element of this vector.
      +
      A_2() +
      Returns the second element of this vector.
      +
      A_3() +
      Returns the third element of this vector.
      +
      A_4() +
      Returns the fourth element of this vector.
      +
      A_5() +
      Returns the fifth element of this vector.
      +
      A_6() +
      Returns the sixth element of this vector.
      +
      A_7() +
      Returns the seventh element of this vector.
      +
      A_8() +
      Returns the eighth element of this vector.
      +
      <B> V8<B>apply(V8<F<A,B>> vf) +
      Performs function application within a vector (applicative functor pattern).
      +
      static <A> V8<A>cons(P1<A> head, + V7<A> tail) +
      Creates a vector-8 from a head and a tail.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      P1<A>head() +
      Returns the first element of this vector, as a product-1.
      +
      java.util.Iterator<A>iterator() +
      Returns an iterator for the elements of this vector.
      +
      <B> V8<B>map(F<A,B> f) +
      Maps the given function across this vector.
      +
      static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>>p_() +
      Returns a function that transforms a vector-8 to the equivalent product-8.
      +
      P8<A,A,A,A,A,A,A,A>p() +
      Returns a homogeneous product-8 equivalent to this vector.
      +
      static <A> V8<A>p(P8<A,A,A,A,A,A,A,A> p) +
      Creates a vector-8 from a homogeneous product-8.
      +
      V7<A>tail() +
      Returns all but the first element of this vector, as a vector-7.
      +
      Array<A>toArray() +
      Returns an array with the elements of this vector.
      +
      NonEmptyList<A>toNonEmptyList() +
      Returns a nonempty list with the elements of this vector.
      +
      static <A> F<V8<A>,Stream<A>>toStream_() +
      Returns a function that transforms a vector-8 to a stream of its elements.
      +
      Stream<A>toStream() +
      Returns a stream of the elements of this vector.
      +
      V8<V2<A>>vzip(V8<A> bs) +
      Zips this vector with the given vector to produce a vector of vectors.
      +
      <B> V8<P2<A,B>>zip(V8<B> bs) +
      Zips this vector with the given vector to produce a vector of pairs.
      +
      <B,C> V8<C>zipWith(F<A,F<B,C>> f, + V8<B> bs) +
      Zips this vector with the given vector using the given function to produce a new vector.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public static <A> V8<A> p(P8<A,A,A,A,A,A,A,A> p)
        +
        Creates a vector-8 from a homogeneous product-8.
        +
        +
        Parameters:
        +
        p - The product-8 from which to create a vector.
        +
        Returns:
        +
        A new vector-8.
        +
        +
        • +
      + + + +
        +
      • +

        cons

        +
        public static <A> V8<A> cons(P1<A> head,
+                             V7<A> tail)
        +
        Creates a vector-8 from a head and a tail.
        +
        +
        Parameters:
        +
        head - The value to put as the first element of the vector.
        +
        tail - The vector representing all but the first element of the new vector.
        +
        Returns:
        +
        The new vector.
        +
        +
        • +
      + + + +
        +
      • +

        _1

        +
        public A _1()
        +
        Returns the first element of this vector.
        +
        +
        Returns:
        +
        the first element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _2

        +
        public A _2()
        +
        Returns the second element of this vector.
        +
        +
        Returns:
        +
        the second element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _3

        +
        public A _3()
        +
        Returns the third element of this vector.
        +
        +
        Returns:
        +
        the third element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _4

        +
        public A _4()
        +
        Returns the fourth element of this vector.
        +
        +
        Returns:
        +
        the fourth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _5

        +
        public A _5()
        +
        Returns the fifth element of this vector.
        +
        +
        Returns:
        +
        the fifth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _6

        +
        public A _6()
        +
        Returns the sixth element of this vector.
        +
        +
        Returns:
        +
        the sixth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _7

        +
        public A _7()
        +
        Returns the seventh element of this vector.
        +
        +
        Returns:
        +
        the seventh element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        _8

        +
        public A _8()
        +
        Returns the eighth element of this vector.
        +
        +
        Returns:
        +
        the eighth element of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public V7<A> tail()
        +
        Returns all but the first element of this vector, as a vector-7.
        +
        +
        Returns:
        +
        all but the first element of this vector, as a vector-7.
        +
        +
        • +
      + + + +
        +
      • +

        head

        +
        public P1<A> head()
        +
        Returns the first element of this vector, as a product-1.
        +
        +
        Returns:
        +
        the first element of this vector, as a product-1.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator for the elements of this vector.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        an iterator for the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        p

        +
        public P8<A,A,A,A,A,A,A,A> p()
        +
        Returns a homogeneous product-8 equivalent to this vector.
        +
        +
        Returns:
        +
        a homogeneous product-8 equivalent to this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toNonEmptyList

        +
        public NonEmptyList<A> toNonEmptyList()
        +
        Returns a nonempty list with the elements of this vector.
        +
        +
        Returns:
        +
        a nonempty list with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toStream

        +
        public Stream<A> toStream()
        +
        Returns a stream of the elements of this vector.
        +
        +
        Returns:
        +
        a stream of the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public Array<A> toArray()
        +
        Returns an array with the elements of this vector.
        +
        +
        Returns:
        +
        an array with the elements of this vector.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> V8<B> map(F<A,B> f)
        +
        Maps the given function across this vector.
        +
        +
        Parameters:
        +
        f - The function to map across this vector.
        +
        Returns:
        +
        A new vector after the given function has been applied to each element.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> V8<B> apply(V8<F<A,B>> vf)
        +
        Performs function application within a vector (applicative functor pattern).
        +
        +
        Parameters:
        +
        vf - The vector of functions to apply.
        +
        Returns:
        +
        A new vector after zipping the given vector of functions over this vector.
        +
        +
        • +
      + + + +
        +
      • +

        zipWith

        +
        public <B,C> V8<C> zipWith(F<A,F<B,C>> f,
+                           V8<B> bs)
        +
        Zips this vector with the given vector using the given function to produce a new vector.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        f - The function to zip this vector and the given vector with.
        +
        Returns:
        +
        A new vector with the results of the function.
        +
        +
        • +
      + + + +
        +
      • +

        zip

        +
        public <B> V8<P2<A,B>> zip(V8<B> bs)
        +
        Zips this vector with the given vector to produce a vector of pairs.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector with a length the same as the shortest of this vector and the given + vector.
        +
        +
        • +
      + + + +
        +
      • +

        vzip

        +
        public V8<V2<A>> vzip(V8<A> bs)
        +
        Zips this vector with the given vector to produce a vector of vectors.
        +
        +
        Parameters:
        +
        bs - The vector to zip this vector with.
        +
        Returns:
        +
        A new vector of vectors.
        +
        +
        • +
      + + + +
        +
      • +

        toStream_

        +
        public static <A> F<V8<A>,Stream<A>> toStream_()
        +
        Returns a function that transforms a vector-8 to a stream of its elements.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to a stream of its elements.
        +
        +
        • +
      + + + +
        +
      • +

        p_

        +
        public static <A> F<V8<A>,P8<A,A,A,A,A,A,A,A>> p_()
        +
        Returns a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        Returns:
        +
        a function that transforms a vector-8 to the equivalent product-8.
        +
        +
        • +
      + + + +
        +
      • +

        __1

        +
        public static <A> F<V8<A>,A> __1()
        +
        A first-class function to get the first element of a vector.
        +
        +
        Returns:
        +
        a function that gets the first element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __2

        +
        public static <A> F<V8<A>,A> __2()
        +
        A first-class function to get the second element of a vector.
        +
        +
        Returns:
        +
        a function that gets the second element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __3

        +
        public static <A> F<V8<A>,A> __3()
        +
        A first-class function to get the third element of a vector.
        +
        +
        Returns:
        +
        a function that gets the third element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __4

        +
        public static <A> F<V8<A>,A> __4()
        +
        A first-class function to get the fourth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fourth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __5

        +
        public static <A> F<V8<A>,A> __5()
        +
        A first-class function to get the fifth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the fifth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __6

        +
        public static <A> F<V8<A>,A> __6()
        +
        A first-class function to get the sixth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the sixth element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __7

        +
        public static <A> F<V8<A>,A> __7()
        +
        A first-class function to get the seventh element of a vector.
        +
        +
        Returns:
        +
        a function that gets the seventh element of a given vector.
        +
        +
        • +
      + + + +
        +
      • +

        __8

        +
        public static <A> F<V8<A>,A> __8()
        +
        A first-class function to get the eighth element of a vector.
        +
        +
        Returns:
        +
        a function that gets the eighth element of a given vector.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/package-frame.html b/javadoc/5.0/functionaljava/fj/data/vector/package-frame.html new file mode 100644 index 0000000..a20d60a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/package-frame.html @@ -0,0 +1,26 @@ + + + + + +fj.data.vector (core 5.0 API) + + + + +

fj.data.vector

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/package-summary.html b/javadoc/5.0/functionaljava/fj/data/vector/package-summary.html new file mode 100644 index 0000000..70fa591 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/package-summary.html @@ -0,0 +1,192 @@ + + + + + +fj.data.vector (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.data.vector

+
+
Fixed-length vectors
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    V +
    Functions across vectors.
    +
    V2<A> +
    A vector-2.
    +
    V3<A> +
    A vector-3.
    +
    V4<A> +
    A vector-4.
    +
    V5<A> +
    A vector-5.
    +
    V6<A> +
    A vector-6.
    +
    V7<A> +
    A vector-7.
    +
    V8<A> +
    A vector-8.
    +
    +
    • +
+ + + +

Package fj.data.vector Description

+
Fixed-length vectors
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/data/vector/package-tree.html b/javadoc/5.0/functionaljava/fj/data/vector/package-tree.html new file mode 100644 index 0000000..d9684f0 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/data/vector/package-tree.html @@ -0,0 +1,141 @@ + + + + + +fj.data.vector Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.data.vector

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • fj.data.vector.V
      • +
    • fj.data.vector.V2<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V3<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V4<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V5<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V6<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V7<A> (implements java.lang.Iterable<T>)
      • +
    • fj.data.vector.V8<A> (implements java.lang.Iterable<T>)
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/BigIntegers.html b/javadoc/5.0/functionaljava/fj/function/BigIntegers.html new file mode 100644 index 0000000..d721d24 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/BigIntegers.html @@ -0,0 +1,401 @@ + + + + + +BigIntegers (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class BigIntegers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.BigIntegers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class BigIntegers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.math.BigInteger,java.math.BigInteger>abs +
      Absolute value.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>add +
      Curried Integer addition.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>multiply +
      Curried Integer multiplication.
      +
      static F<java.math.BigInteger,java.math.BigInteger>negate +
      Negation.
      +
      static F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>>power +
      Power.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>remainder +
      Remainder.
      +
      static F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.math.BigIntegerproduct(List<java.math.BigInteger> ints) +
      Returns the product of a list of big integers.
      +
      static java.math.BigIntegersum(List<java.math.BigInteger> ints) +
      Sums a list of big integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.math.BigInteger,java.math.BigInteger> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.math.BigInteger,F<java.math.BigInteger,java.math.BigInteger>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.math.BigInteger,F<java.lang.Integer,java.math.BigInteger>> power
        +
        Power.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static java.math.BigInteger sum(List<java.math.BigInteger> ints)
        +
        Sums a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to sum.
        +
        Returns:
        +
        The sum of the big integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static java.math.BigInteger product(List<java.math.BigInteger> ints)
        +
        Returns the product of a list of big integers.
        +
        +
        Parameters:
        +
        ints - A list of big integers to multiply together.
        +
        Returns:
        +
        The product of the big integers in the list.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Booleans.html b/javadoc/5.0/functionaljava/fj/function/Booleans.html new file mode 100644 index 0000000..669ff2b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Booleans.html @@ -0,0 +1,774 @@ + + + + + +Booleans (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Booleans

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Booleans
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Booleans
+extends java.lang.Object
    +
    Curried logical functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>and +
      Curried form of logical "and" (conjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>if_ +
      Curried form of logical "if" (reverse material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>iff +
      Curried form of logical "if and only if" (biconditional, equivalence).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>implies +
      Curried form of logical "only if" (material implication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nif +
      Curried form of logical "not if" (reverse nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nimp +
      Curried form of logical "not implies" (nonimplication).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>nor +
      Curried form of logical "not or".
      +
      static F<java.lang.Boolean,java.lang.Boolean>not +
      Logical negation.
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>or +
      Curried form of logical "inclusive or" (disjunction).
      +
      static F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>>xor +
      Curried form of logical xor (nonequivalence).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A> F<A,java.lang.Boolean>and(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using conjunction
      +
      static booleanand(List<java.lang.Boolean> l) +
      Returns true if all the elements of the given list are true.
      +
      static booleanand(Stream<java.lang.Boolean> l) +
      Returns true if all the elements of the given stream are true.
      +
      static <A> F<A,java.lang.Boolean>andAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>andAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns composed predicate
      +
      static <A> F<java.lang.Boolean,F<A,F<A,A>>>cond() +
      Curried form of conditional.
      +
      static <A,B> F<B,java.lang.Boolean>contramap(F<B,A> f, + F<A,java.lang.Boolean> p) +
      maps given function to the predicate function
      +
      static <A,B> F<B,java.lang.Boolean>is(F<B,A> f, + F<A,java.lang.Boolean> p) +
      alias for contramap
      +
      static <A,B> F<B,java.lang.Boolean>isnot(F<B,A> f, + F<A,java.lang.Boolean> p) +
      returns inverse of contramap
      +
      static <A> F<A,java.lang.Boolean>not(F<A,java.lang.Boolean> p) +
      Negates the given predicate.
      +
      static <A> F<A,java.lang.Boolean>or(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      returns composed predicate using disjunction
      +
      static booleanor(List<java.lang.Boolean> l) +
      Returns true if any element of the given list is true.
      +
      static booleanor(Stream<java.lang.Boolean> l) +
      Returns true if any element of the given stream is true.
      +
      static <A> F<A,java.lang.Boolean>orAll(List<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given List of predicates
      +
      static <A> F<A,java.lang.Boolean>orAll(Stream<F<A,java.lang.Boolean>> l) +
      Returns a composed predicate of given Stream of predicates
      +
      static <A> F<A,java.lang.Boolean>xor(F<A,java.lang.Boolean> p1, + F<A,java.lang.Boolean> p2) +
      composes the given predicate using exclusive disjunction
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        or

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> or
        +
        Curried form of logical "inclusive or" (disjunction).
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> and
        +
        Curried form of logical "and" (conjunction).
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> xor
        +
        Curried form of logical xor (nonequivalence).
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static final F<java.lang.Boolean,java.lang.Boolean> not
        +
        Logical negation.
        +
        • +
      + + + +
        +
      • +

        implies

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> implies
        +
        Curried form of logical "only if" (material implication).
        +
        • +
      + + + +
        +
      • +

        if_

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> if_
        +
        Curried form of logical "if" (reverse material implication).
        +
        • +
      + + + +
        +
      • +

        iff

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> iff
        +
        Curried form of logical "if and only if" (biconditional, equivalence).
        +
        • +
      + + + +
        +
      • +

        nimp

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nimp
        +
        Curried form of logical "not implies" (nonimplication).
        +
        • +
      + + + +
        +
      • +

        nif

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nif
        +
        Curried form of logical "not if" (reverse nonimplication).
        +
        • +
      + + + +
        +
      • +

        nor

        +
        public static final F<java.lang.Boolean,F<java.lang.Boolean,java.lang.Boolean>> nor
        +
        Curried form of logical "not or".
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public static boolean and(List<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given list are true.
        +
        +
        Parameters:
        +
        l - A list to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given list are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        public static <A,B> F<B,java.lang.Boolean> contramap(F<B,A> f,
+                                                     F<A,java.lang.Boolean> p)
        +
        maps given function to the predicate function
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        is

        +
        public static <A,B> F<B,java.lang.Boolean> is(F<B,A> f,
+                                              F<A,java.lang.Boolean> p)
        +
        alias for contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        isnot

        +
        public static <A,B> F<B,java.lang.Boolean> isnot(F<B,A> f,
+                                                 F<A,java.lang.Boolean> p)
        +
        returns inverse of contramap
        +
        +
        Parameters:
        +
        p - predicate to be mapped over
        +
        f - function
        +
        Returns:
        +
        predicate function
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static <A> F<A,java.lang.Boolean> and(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using conjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        xor

        +
        public static <A> F<A,java.lang.Boolean> xor(F<A,java.lang.Boolean> p1,
+                                             F<A,java.lang.Boolean> p2)
        +
        composes the given predicate using exclusive disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static <A> F<A,java.lang.Boolean> or(F<A,java.lang.Boolean> p1,
+                                            F<A,java.lang.Boolean> p2)
        +
        returns composed predicate using disjunction
        +
        +
        Parameters:
        +
        p1 - first predicate
        +
        p2 - second predicate
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        and

        +
        public static boolean and(Stream<java.lang.Boolean> l)
        +
        Returns true if all the elements of the given stream are true.
        +
        +
        Parameters:
        +
        l - A stream to check for all the elements being true.
        +
        Returns:
        +
        true if all the elements of the given stream are true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns composed predicate
        +
        +
        Parameters:
        +
        l - A stream of predicates
        +
        Returns:
        +
        composed predicate
        +
        +
        • +
      + + + +
        +
      • +

        andAll

        +
        public static <A> F<A,java.lang.Boolean> andAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(List<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given List of predicates
        +
        +
        Parameters:
        +
        l - A list of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        orAll

        +
        public static <A> F<A,java.lang.Boolean> orAll(Stream<F<A,java.lang.Boolean>> l)
        +
        Returns a composed predicate of given Stream of predicates
        +
        +
        Parameters:
        +
        l - A stream of predicate functions
        +
        Returns:
        +
        composed predicate function
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(List<java.lang.Boolean> l)
        +
        Returns true if any element of the given list is true.
        +
        +
        Parameters:
        +
        l - A list to check for any element being true.
        +
        Returns:
        +
        true if any element of the given list is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public static boolean or(Stream<java.lang.Boolean> l)
        +
        Returns true if any element of the given stream is true.
        +
        +
        Parameters:
        +
        l - A stream to check for any element being true.
        +
        Returns:
        +
        true if any element of the given stream is true. False otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public static <A> F<A,java.lang.Boolean> not(F<A,java.lang.Boolean> p)
        +
        Negates the given predicate.
        +
        +
        Parameters:
        +
        p - A predicate to negate.
        +
        Returns:
        +
        The negation of the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        cond

        +
        public static <A> F<java.lang.Boolean,F<A,F<A,A>>> cond()
        +
        Curried form of conditional. If the first argument is true, returns the second argument, + otherwise the third argument.
        +
        +
        Returns:
        +
        A function that returns its second argument if the first argument is true, otherwise the third argument.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Characters.html b/javadoc/5.0/functionaljava/fj/function/Characters.html new file mode 100644 index 0000000..f764471 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Characters.html @@ -0,0 +1,562 @@ + + + + + +Characters (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Characters

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Characters
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Characters
+extends java.lang.Object
    +
    First-class functions on Characters.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>>digit 
      static F<java.lang.Character,java.lang.Byte>getDirectionality 
      static F<java.lang.Character,java.lang.Integer>getNumericValue 
      static F<java.lang.Character,java.lang.Integer>getType 
      static F<java.lang.Character,java.lang.Boolean>isDefined 
      static F<java.lang.Character,java.lang.Boolean>isDigit 
      static F<java.lang.Character,java.lang.Boolean>isIdentifierIgnorable 
      static F<java.lang.Character,java.lang.Boolean>isISOControl 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isJavaIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isLetter 
      static F<java.lang.Character,java.lang.Boolean>isLetterOrDigit 
      static F<java.lang.Character,java.lang.Boolean>isLowerCase 
      static F<java.lang.Character,java.lang.Boolean>isMirrored 
      static F<java.lang.Character,java.lang.Boolean>isNewLine 
      static F<java.lang.Character,java.lang.Boolean>isSpaceChar 
      static F<java.lang.Character,java.lang.Boolean>isTitleCase 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierPart 
      static F<java.lang.Character,java.lang.Boolean>isUnicodeIdentifierStart 
      static F<java.lang.Character,java.lang.Boolean>isUpperCase 
      static F<java.lang.Character,java.lang.Boolean>isWhitespace 
      static F<java.lang.Character,java.lang.Character>reverseBytes 
      static F<java.lang.Character,java.lang.Character>toLowerCase 
      static F<java.lang.Character,java.lang.String>toString 
      static F<java.lang.Character,java.lang.Character>toTitleCase 
      static F<java.lang.Character,java.lang.Character>toUpperCase 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        toString

        +
        public static final F<java.lang.Character,java.lang.String> toString
        +
        • +
      + + + +
        +
      • +

        isLowerCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLowerCase
        +
        • +
      + + + +
        +
      • +

        isUpperCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUpperCase
        +
        • +
      + + + +
        +
      • +

        isTitleCase

        +
        public static final F<java.lang.Character,java.lang.Boolean> isTitleCase
        +
        • +
      + + + +
        +
      • +

        isDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDigit
        +
        • +
      + + + +
        +
      • +

        isDefined

        +
        public static final F<java.lang.Character,java.lang.Boolean> isDefined
        +
        • +
      + + + +
        +
      • +

        isLetter

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetter
        +
        • +
      + + + +
        +
      • +

        isLetterOrDigit

        +
        public static final F<java.lang.Character,java.lang.Boolean> isLetterOrDigit
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isJavaIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isJavaIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierStart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierStart
        +
        • +
      + + + +
        +
      • +

        isUnicodeIdentifierPart

        +
        public static final F<java.lang.Character,java.lang.Boolean> isUnicodeIdentifierPart
        +
        • +
      + + + +
        +
      • +

        isIdentifierIgnorable

        +
        public static final F<java.lang.Character,java.lang.Boolean> isIdentifierIgnorable
        +
        • +
      + + + +
        +
      • +

        toLowerCase

        +
        public static final F<java.lang.Character,java.lang.Character> toLowerCase
        +
        • +
      + + + +
        +
      • +

        toUpperCase

        +
        public static final F<java.lang.Character,java.lang.Character> toUpperCase
        +
        • +
      + + + +
        +
      • +

        toTitleCase

        +
        public static final F<java.lang.Character,java.lang.Character> toTitleCase
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static final F<java.lang.Character,F<java.lang.Integer,java.lang.Integer>> digit
        +
        • +
      + + + +
        +
      • +

        getNumericValue

        +
        public static final F<java.lang.Character,java.lang.Integer> getNumericValue
        +
        • +
      + + + +
        +
      • +

        isSpaceChar

        +
        public static final F<java.lang.Character,java.lang.Boolean> isSpaceChar
        +
        • +
      + + + +
        +
      • +

        isWhitespace

        +
        public static final F<java.lang.Character,java.lang.Boolean> isWhitespace
        +
        • +
      + + + +
        +
      • +

        isISOControl

        +
        public static final F<java.lang.Character,java.lang.Boolean> isISOControl
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public static final F<java.lang.Character,java.lang.Integer> getType
        +
        • +
      + + + +
        +
      • +

        getDirectionality

        +
        public static final F<java.lang.Character,java.lang.Byte> getDirectionality
        +
        • +
      + + + +
        +
      • +

        isMirrored

        +
        public static final F<java.lang.Character,java.lang.Boolean> isMirrored
        +
        • +
      + + + +
        +
      • +

        reverseBytes

        +
        public static final F<java.lang.Character,java.lang.Character> reverseBytes
        +
        • +
      + + + +
        +
      • +

        isNewLine

        +
        public static final F<java.lang.Character,java.lang.Boolean> isNewLine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Doubles.html b/javadoc/5.0/functionaljava/fj/function/Doubles.html new file mode 100644 index 0000000..f822050 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Doubles.html @@ -0,0 +1,501 @@ + + + + + +Doubles (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Doubles

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Doubles
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Doubles
+extends java.lang.Object
    +
    Curried functions over Doubles.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Double,java.lang.Double>abs +
      Absolute value.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>add +
      Curried Double addition.
      +
      static F<java.lang.Double,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Double,java.lang.Boolean>gteZero +
      A function that returns true if the given double is greater than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>gtZero +
      A function that returns true if the given double is greater than zero.
      +
      static F<java.lang.Double,java.lang.Boolean>lteZero +
      A function that returns true if the given double is less than or equal to zero.
      +
      static F<java.lang.Double,java.lang.Boolean>ltZero +
      A function that returns true if the given double is less than zero.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>multiply +
      Curried Double multiplication.
      +
      static F<java.lang.Double,java.lang.Double>negate +
      Negation.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>power +
      Power.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>remainder +
      Remainder.
      +
      static F<java.lang.Double,F<java.lang.Double,java.lang.Double>>subtract +
      Curried Double subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Double>>fromString() +
      A function that converts strings to doubles.
      +
      static doubleproduct(List<java.lang.Double> doubles) +
      Returns the product of a list of doubles.
      +
      static doublesum(List<java.lang.Double> doubles) +
      Sums a list of doubles.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> add
        +
        Curried Double addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> multiply
        +
        Curried Double multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> subtract
        +
        Curried Double subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Double,java.lang.Double> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Double,java.lang.Double> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Double,F<java.lang.Double,java.lang.Double>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Double,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gtZero
        +
        A function that returns true if the given double is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> gteZero
        +
        A function that returns true if the given double is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> ltZero
        +
        A function that returns true if the given double is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Double,java.lang.Boolean> lteZero
        +
        A function that returns true if the given double is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static double sum(List<java.lang.Double> doubles)
        +
        Sums a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to sum.
        +
        Returns:
        +
        The sum of the doubless in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static double product(List<java.lang.Double> doubles)
        +
        Returns the product of a list of doubles.
        +
        +
        Parameters:
        +
        doubles - A list of doubles to multiply together.
        +
        Returns:
        +
        The product of the doubles in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Double>> fromString()
        +
        A function that converts strings to doubles.
        +
        +
        Returns:
        +
        A function that converts strings to doubles.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect0.html b/javadoc/5.0/functionaljava/fj/function/Effect0.html new file mode 100644 index 0000000..9094df1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect0.html @@ -0,0 +1,270 @@ + + + + + +Effect0 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect0

+
+
+
+
    +
  • +
    +
    +
    public interface Effect0
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
        +
        • +
      + + + +
        +
      • +

        toF0

        +
        default F0<Unit> toF0()
        +
        • +
      + + + +
        +
      • +

        toTryEffect0

        +
        default <E extends java.lang.Exception> TryEffect0<E> toTryEffect0()
        +
        • +
      + + + +
        +
      • +

        toTry0

        +
        default <E extends java.lang.Exception> Try0<Unit,E> toTry0()
        +
        • +
      + + + +
        +
      • +

        toP1

        +
        default P1<Unit> toP1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect1.html b/javadoc/5.0/functionaljava/fj/function/Effect1.html new file mode 100644 index 0000000..017da95 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect1.html @@ -0,0 +1,413 @@ + + + + + +Effect1 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect1<A>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.Consumer<A>
    +
    +
    +
    +
    public interface Effect1<A>
+extends java.util.function.Consumer<A>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a)
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        default void accept(A a)
        +
        +
        Specified by:
        +
        accept in interface java.util.function.Consumer<A>
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        default <C> F<A,C> bind(F<Unit,F<A,C>> g)
        +
        • +
      + + + + + +
        +
      • +

        apply

        +
        default void apply(A a)
        +
        • +
      + + + +
        +
      • +

        contramap

        +
        default <C> Effect1<C> contramap(F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        map

        +
        default <C> F<A,C> map(F<Unit,C> f)
        +
        • +
      + + + +
        +
      • +

        andThen

        +
        default <B> F<A,B> andThen(F<Unit,B> f)
        +
        • +
      + + + +
        +
      • +

        o

        +
        default <C> Effect1<C> o(F<C,A> f)
        +
        • +
      + + + +
        +
      • +

        toF

        +
        default F<A,Unit> toF()
        +
        • +
      + + + +
        +
      • +

        toTryEffect1

        +
        default <Z extends java.lang.Exception> TryEffect1<A,Z> toTryEffect1()
        +
        • +
      + + + +
        +
      • +

        toTry1

        +
        default <Z extends java.lang.Exception> Try1<A,Unit,Z> toTry1()
        +
        • +
      + + + + + + + +
        +
      • +

        dimap

        +
        default <C,D> F<C,D> dimap(F<C,A> f,
+                           F<Unit,D> g)
        +
        • +
      + + + + + +
        +
      • +

        partial

        +
        default P1<Unit> partial(A a)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect2.html b/javadoc/5.0/functionaljava/fj/function/Effect2.html new file mode 100644 index 0000000..b7ab4cc --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect2.html @@ -0,0 +1,268 @@ + + + + + +Effect2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect2<A,B>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.function.BiConsumer<A,B>
    +
    +
    +
    +
    public interface Effect2<A,B>
+extends java.util.function.BiConsumer<A,B>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b)
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        default void accept(A a,
+                    B b)
        +
        +
        Specified by:
        +
        accept in interface java.util.function.BiConsumer<A,B>
        +
        +
        • +
      + + + +
        +
      • +

        toF2

        +
        default F2<A,B,Unit> toF2()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect3.html b/javadoc/5.0/functionaljava/fj/function/Effect3.html new file mode 100644 index 0000000..960a864 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect3.html @@ -0,0 +1,224 @@ + + + + + +Effect3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect3<A,B,C>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect3<A,B,C>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect4.html b/javadoc/5.0/functionaljava/fj/function/Effect4.html new file mode 100644 index 0000000..8b9796d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect4.html @@ -0,0 +1,226 @@ + + + + + +Effect4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect4<A,B,C,D>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect4<A,B,C,D>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect5.html b/javadoc/5.0/functionaljava/fj/function/Effect5.html new file mode 100644 index 0000000..f50324e --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect5.html @@ -0,0 +1,228 @@ + + + + + +Effect5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect5<A,B,C,D,E>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect5<A,B,C,D,E>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect6.html b/javadoc/5.0/functionaljava/fj/function/Effect6.html new file mode 100644 index 0000000..abd7f8a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect6.html @@ -0,0 +1,230 @@ + + + + + +Effect6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect6<A,B,C,D,E,F>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect6<A,B,C,D,E,F>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect7.html b/javadoc/5.0/functionaljava/fj/function/Effect7.html new file mode 100644 index 0000000..600b836 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect7.html @@ -0,0 +1,232 @@ + + + + + +Effect7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect7<A,B,C,D,E,F,G>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect7<A,B,C,D,E,F,G>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Effect8.html b/javadoc/5.0/functionaljava/fj/function/Effect8.html new file mode 100644 index 0000000..f5149bc --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Effect8.html @@ -0,0 +1,234 @@ + + + + + +Effect8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Effect8<A,B,C,D,E,F,G,H>

+
+
+
+
    +
  • +
    +
    +
    public interface Effect8<A,B,C,D,E,F,G,H>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Integers.html b/javadoc/5.0/functionaljava/fj/function/Integers.html new file mode 100644 index 0000000..6b212ca --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Integers.html @@ -0,0 +1,501 @@ + + + + + +Integers (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Integers

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Integers
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Integers
+extends java.lang.Object
    +
    Curried functions over Integers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Integer,java.lang.Integer>abs +
      Absolute value.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>add +
      Curried Integer addition.
      +
      static F<java.lang.Integer,java.lang.Boolean>even +
      Evenness.
      +
      static F<java.lang.Integer,java.lang.Boolean>gteZero +
      A function that returns true if the given integer is greater than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>gtZero +
      A function that returns true if the given integer is greater than zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>lteZero +
      A function that returns true if the given integer is less than or equal to zero.
      +
      static F<java.lang.Integer,java.lang.Boolean>ltZero +
      A function that returns true if the given integer is less than zero.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>multiply +
      Curried Integer multiplication.
      +
      static F<java.lang.Integer,java.lang.Integer>negate +
      Negation.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>power +
      Power.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>remainder +
      Remainder.
      +
      static F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>>subtract +
      Curried Integer subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Integer>>fromString() +
      A function that converts strings to integers.
      +
      static intproduct(List<java.lang.Integer> ints) +
      Returns the product of a list of integers.
      +
      static intsum(List<java.lang.Integer> ints) +
      Sums a list of integers.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> add
        +
        Curried Integer addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> multiply
        +
        Curried Integer multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> subtract
        +
        Curried Integer subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Integer,java.lang.Integer> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Integer,java.lang.Integer> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> remainder
        +
        Remainder.
        +
        • +
      + + + +
        +
      • +

        power

        +
        public static final F<java.lang.Integer,F<java.lang.Integer,java.lang.Integer>> power
        +
        Power.
        +
        • +
      + + + +
        +
      • +

        even

        +
        public static final F<java.lang.Integer,java.lang.Boolean> even
        +
        Evenness.
        +
        • +
      + + + +
        +
      • +

        gtZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gtZero
        +
        A function that returns true if the given integer is greater than zero.
        +
        • +
      + + + +
        +
      • +

        gteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> gteZero
        +
        A function that returns true if the given integer is greater than or equal to zero.
        +
        • +
      + + + +
        +
      • +

        ltZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> ltZero
        +
        A function that returns true if the given integer is less than zero.
        +
        • +
      + + + +
        +
      • +

        lteZero

        +
        public static final F<java.lang.Integer,java.lang.Boolean> lteZero
        +
        A function that returns true if the given integer is less than or equal to zero.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static int sum(List<java.lang.Integer> ints)
        +
        Sums a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to sum.
        +
        Returns:
        +
        The sum of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static int product(List<java.lang.Integer> ints)
        +
        Returns the product of a list of integers.
        +
        +
        Parameters:
        +
        ints - A list of integers to multiply together.
        +
        Returns:
        +
        The product of the integers in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Integer>> fromString()
        +
        A function that converts strings to integers.
        +
        +
        Returns:
        +
        A function that converts strings to integers.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Longs.html b/javadoc/5.0/functionaljava/fj/function/Longs.html new file mode 100644 index 0000000..340c477 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Longs.html @@ -0,0 +1,405 @@ + + + + + +Longs (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Longs

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Longs
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Longs
+extends java.lang.Object
    +
    Curried functions over Longs.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.Long,java.lang.Long>abs +
      Absolute value.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>add +
      Curried Long addition.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>multiply +
      Curried Long multiplication.
      +
      static F<java.lang.Long,java.lang.Long>negate +
      Negation.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>remainder +
      Remainder.
      +
      static F<java.lang.Long,F<java.lang.Long,java.lang.Long>>subtract +
      Curried Long subtraction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,Option<java.lang.Long>>fromString() +
      A function that converts strings to integers.
      +
      static longproduct(List<java.lang.Long> longs) +
      Returns the product of a list of integers.
      +
      static longsum(List<java.lang.Long> longs) +
      Sums a list of longs.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        add

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> add
        +
        Curried Long addition.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> multiply
        +
        Curried Long multiplication.
        +
        • +
      + + + +
        +
      • +

        subtract

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> subtract
        +
        Curried Long subtraction.
        +
        • +
      + + + +
        +
      • +

        negate

        +
        public static final F<java.lang.Long,java.lang.Long> negate
        +
        Negation.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public static final F<java.lang.Long,java.lang.Long> abs
        +
        Absolute value.
        +
        • +
      + + + +
        +
      • +

        remainder

        +
        public static final F<java.lang.Long,F<java.lang.Long,java.lang.Long>> remainder
        +
        Remainder.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public static long sum(List<java.lang.Long> longs)
        +
        Sums a list of longs.
        +
        +
        Parameters:
        +
        longs - A list of longs to sum.
        +
        Returns:
        +
        The sum of the longs in the list.
        +
        +
        • +
      + + + +
        +
      • +

        product

        +
        public static long product(List<java.lang.Long> longs)
        +
        Returns the product of a list of integers.
        +
        +
        Parameters:
        +
        longs - A list of longs to multiply together.
        +
        Returns:
        +
        The product of the longs in the list.
        +
        +
        • +
      + + + +
        +
      • +

        fromString

        +
        public static F<java.lang.String,Option<java.lang.Long>> fromString()
        +
        A function that converts strings to integers.
        +
        +
        Returns:
        +
        A function that converts strings to integers.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Strings.html b/javadoc/5.0/functionaljava/fj/function/Strings.html new file mode 100644 index 0000000..ce6c037 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Strings.html @@ -0,0 +1,479 @@ + + + + + +Strings (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
fj.function
+

Class Strings

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Strings
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Strings
+extends java.lang.Object
    +
    Curried string functions.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>contains +
      A curried version of String.contains(CharSequence).
      +
      static F<java.lang.String,java.lang.Boolean>isEmpty +
      A curried version of String.isEmpty().
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrBlank +
      This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
      +
      static F<java.lang.String,java.lang.Boolean>isNotNullOrEmpty +
      This function checks if a given String is neither null nor empty.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrBlank +
      This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
      +
      static F<java.lang.String,java.lang.Boolean>isNullOrEmpty +
      This function checks if a given String is null or empty (String.isEmpty()).
      +
      static F<java.lang.String,java.lang.Integer>length +
      A curried version of String.length().
      +
      static java.lang.StringlineSeparator 
      static F<java.lang.String,F<java.lang.String,java.lang.Boolean>>matches +
      A curried version of String.matches(String).
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static F<java.lang.String,List<java.lang.String>>lines() 
      static List<java.lang.String>lines(java.lang.String s) 
      static F<java.lang.String,java.lang.String>reverse() 
      static F<List<java.lang.String>,java.lang.String>unlines() 
      static java.lang.Stringunlines(List<java.lang.String> list) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        lineSeparator

        +
        public static final java.lang.String lineSeparator
        +
        • +
      + + + +
        +
      • +

        isNotNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrEmpty
        +
        This function checks if a given String is neither null nor empty.
        +
        +
        See Also:
        +
        isNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrEmpty
        +
        This function checks if a given String is null or empty (String.isEmpty()).
        +
        +
        See Also:
        +
        isNotNullOrEmpty
        +
        +
        • +
      + + + +
        +
      • +

        isNotNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNotNullOrBlank
        +
        This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
        +
        +
        See Also:
        +
        isNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isNullOrBlank

        +
        public static final F<java.lang.String,java.lang.Boolean> isNullOrBlank
        +
        This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
        +
        +
        See Also:
        +
        isNotNullOrBlank, +Character.isWhitespace(char), +Characters.isWhitespace
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public static final F<java.lang.String,java.lang.Boolean> isEmpty
        +
        A curried version of String.isEmpty().
        +
        • +
      + + + +
        +
      • +

        length

        +
        public static final F<java.lang.String,java.lang.Integer> length
        +
        A curried version of String.length().
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> contains
        +
        A curried version of String.contains(CharSequence). + The function returns true if the second argument contains the first.
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public static final F<java.lang.String,F<java.lang.String,java.lang.Boolean>> matches
        +
        A curried version of String.matches(String). + The function returns true if the second argument matches the first.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        lines

        +
        public static List<java.lang.String> lines(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        lines

        +
        public static F<java.lang.String,List<java.lang.String>> lines()
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static java.lang.String unlines(List<java.lang.String> list)
        +
        • +
      + + + +
        +
      • +

        unlines

        +
        public static F<List<java.lang.String>,java.lang.String> unlines()
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public static F<java.lang.String,java.lang.String> reverse()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try0.html b/javadoc/5.0/functionaljava/fj/function/Try0.html new file mode 100644 index 0000000..28a85b8 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try0.html @@ -0,0 +1,286 @@ + + + + + +Try0 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try0<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    IO<A>, SafeIO<A>
    +
    +
    +
    +
    public interface Try0<A,Z extends java.lang.Exception>
    +
    A product of A which may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to a P1.
    +
    +
    See Also:
    +
    Try.f(Try0)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        A f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      + + + + + + + +
        +
      • +

        toTryEffect0

        +
        default TryEffect0<Z> toTryEffect0()
        +
        • +
      + + + +
        +
      • +

        toEffect0

        +
        default Effect0 toEffect0()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try1.html b/javadoc/5.0/functionaljava/fj/function/Try1.html new file mode 100644 index 0000000..c6a11ee --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try1.html @@ -0,0 +1,232 @@ + + + + + +Try1 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try1<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try1<A,B,Z extends java.lang.Exception>
    +
    A transformation function from A to B that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F.
    +
    +
    See Also:
    +
    Try.f(Try1)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        B f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try2.html b/javadoc/5.0/functionaljava/fj/function/Try2.html new file mode 100644 index 0000000..d9172ea --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try2.html @@ -0,0 +1,234 @@ + + + + + +Try2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try2<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try2<A,B,C,Z extends java.lang.Exception>
    +
    A transformation function of arity-2 from A and B to C that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F2.
    +
    +
    See Also:
    +
    Try.f(Try2)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        C f(A a,
+    B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try3.html b/javadoc/5.0/functionaljava/fj/function/Try3.html new file mode 100644 index 0000000..f26ea60 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try3.html @@ -0,0 +1,236 @@ + + + + + +Try3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try3<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try3<A,B,C,D,Z extends java.lang.Exception>
    +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F3.
    +
    +
    See Also:
    +
    Try.f(Try3)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        D f(A a,
+    B b,
+    C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try4.html b/javadoc/5.0/functionaljava/fj/function/Try4.html new file mode 100644 index 0000000..980347a --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try4.html @@ -0,0 +1,238 @@ + + + + + +Try4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try4<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try4<A,B,C,D,E,Z extends java.lang.Exception>
    +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F4.
    +
    +
    See Also:
    +
    Try.f(Try4)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        E f(A a,
+    B b,
+    C c,
+    D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try5.html b/javadoc/5.0/functionaljava/fj/function/Try5.html new file mode 100644 index 0000000..d648950 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try5.html @@ -0,0 +1,240 @@ + + + + + +Try5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try5<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F5.
    +
    +
    See Also:
    +
    Try.f(Try5)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        F f(A a,
+    B b,
+    C c,
+    D d,
+    E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try6.html b/javadoc/5.0/functionaljava/fj/function/Try6.html new file mode 100644 index 0000000..30f2cf1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try6.html @@ -0,0 +1,242 @@ + + + + + +Try6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F6.
    +
    +
    See Also:
    +
    Try.f(Try6)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        G f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try7.html b/javadoc/5.0/functionaljava/fj/function/Try7.html new file mode 100644 index 0000000..7e86503 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try7.html @@ -0,0 +1,244 @@ + + + + + +Try7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F7.
    +
    +
    See Also:
    +
    Try.f(Try7)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        H f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Try8.html b/javadoc/5.0/functionaljava/fj/function/Try8.html new file mode 100644 index 0000000..915b703 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Try8.html @@ -0,0 +1,246 @@ + + + + + +Try8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception>
    +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception. + + Used to instantiate a lambda that may throw an Exception before converting to an F8.
    +
    +
    See Also:
    +
    Try.f(Try8)
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        I f(A a,
+    B b,
+    C c,
+    D d,
+    E e,
+    F f,
+    G g,
+    H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect0.html b/javadoc/5.0/functionaljava/fj/function/TryEffect0.html new file mode 100644 index 0000000..4d180cb --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect0.html @@ -0,0 +1,275 @@ + + + + + +TryEffect0 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect0<Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect0<Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        f

        +
        void f()
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      + + + + + + + +
        +
      • +

        toTry0

        +
        default Try0<Unit,Z> toTry0()
        +
        • +
      + + + +
        +
      • +

        toEffect0

        +
        default Effect0 toEffect0()
        +
        • +
      + + + +
        +
      • +

        toP1

        +
        default P1<Unit> toP1()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect1.html b/javadoc/5.0/functionaljava/fj/function/TryEffect1.html new file mode 100644 index 0000000..8d425fe --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect1.html @@ -0,0 +1,225 @@ + + + + + +TryEffect1 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect1<A,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect1<A,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect2.html b/javadoc/5.0/functionaljava/fj/function/TryEffect2.html new file mode 100644 index 0000000..265c665 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect2.html @@ -0,0 +1,227 @@ + + + + + +TryEffect2 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect2<A,B,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect2<A,B,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect3.html b/javadoc/5.0/functionaljava/fj/function/TryEffect3.html new file mode 100644 index 0000000..4976419 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect3.html @@ -0,0 +1,229 @@ + + + + + +TryEffect3 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect3<A,B,C,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect3<A,B,C,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect4.html b/javadoc/5.0/functionaljava/fj/function/TryEffect4.html new file mode 100644 index 0000000..a418963 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect4.html @@ -0,0 +1,231 @@ + + + + + +TryEffect4 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect4<A,B,C,D,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect5.html b/javadoc/5.0/functionaljava/fj/function/TryEffect5.html new file mode 100644 index 0000000..57fa4b2 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect5.html @@ -0,0 +1,233 @@ + + + + + +TryEffect5 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect5<A,B,C,D,E,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect6.html b/javadoc/5.0/functionaljava/fj/function/TryEffect6.html new file mode 100644 index 0000000..fd80b56 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect6.html @@ -0,0 +1,235 @@ + + + + + +TryEffect6 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect7.html b/javadoc/5.0/functionaljava/fj/function/TryEffect7.html new file mode 100644 index 0000000..975597d --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect7.html @@ -0,0 +1,237 @@ + + + + + +TryEffect7 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/TryEffect8.html b/javadoc/5.0/functionaljava/fj/function/TryEffect8.html new file mode 100644 index 0000000..dc13436 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/TryEffect8.html @@ -0,0 +1,239 @@ + + + + + +TryEffect8 (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>

+
+
+
+
    +
  • +
    +
    +
    public interface TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        f

        +
        void f(A a,
+       B b,
+       C c,
+       D d,
+       E e,
+       F f,
+       G g,
+       H h)
+throws Z extends java.lang.Exception
        +
        +
        Throws:
        +
        Z extends java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/Visitor.html b/javadoc/5.0/functionaljava/fj/function/Visitor.html new file mode 100644 index 0000000..bbfcb45 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/Visitor.html @@ -0,0 +1,392 @@ + + + + + +Visitor (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.function
+

Class Visitor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.function.Visitor
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Visitor
+extends java.lang.Object
    +
    The essence of the visitor design pattern expressed polymorphically.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,B> F<B,F<A,B>>association(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <A,B> F<P1<B>,F<A,B>>associationLazy(List<P2<A,B>> x, + Equal<A> eq) +
      Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
      +
      static <X> XfindFirst(List<Option<X>> values, + F0<X> def) +
      Returns the first value available in the given list of optional values.
      +
      static <X> XnullablefindFirst(List<X> values, + F0<X> def) +
      Returns the first non-null value in the given list of optional values.
      +
      static <A,B> BnullableVisitor(List<F<A,B>> visitors, + F0<B> def, + A value) +
      Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
      +
      static <A,B> Bvisitor(List<F<A,Option<B>>> visitors, + F0<B> def, + A value) +
      Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        findFirst

        +
        public static <X> X findFirst(List<Option<X>> values,
+                              F0<X> def)
        +
        Returns the first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The optional values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first value available in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + +
        +
      • +

        nullablefindFirst

        +
        public static <X> X nullablefindFirst(List<X> values,
+                                      F0<X> def)
        +
        Returns the first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        Parameters:
        +
        values - The potentially null values to search.
        +
        def - The default value if no value is found in the list.
        +
        Returns:
        +
        The first non-null value in the given list of optional values. If none is found return the given default value.
        +
        +
        • +
      + + + + + +
        +
      • +

        visitor

        +
        public static <A,B> B visitor(List<F<A,Option<B>>> visitors,
+                              F0<B> def,
+                              A value)
        +
        Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply.
        +
        def - The default if none of the visitors yield a value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + + + +
        +
      • +

        nullableVisitor

        +
        public static <A,B> B nullableVisitor(List<F<A,B>> visitors,
+                                      F0<B> def,
+                                      A value)
        +
        Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
        +
        +
        Parameters:
        +
        visitors - The list of visitors to apply looking for a non-null.
        +
        def - The default if none of the visitors yield a non-null value.
        +
        value - The value to apply to the visitors.
        +
        Returns:
        +
        The first value found in the list of visitors after application of the given value, otherwise returns the + given default.
        +
        +
        • +
      + + + +
        +
      • +

        association

        +
        public static <A,B> F<B,F<A,B>> association(List<P2<A,B>> x,
+                                            Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      + + + +
        +
      • +

        associationLazy

        +
        public static <A,B> F<P1<B>,F<A,B>> associationLazy(List<P2<A,B>> x,
+                                                    Equal<A> eq)
        +
        Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
        +
        +
        Parameters:
        +
        x - The association list.
        +
        eq - The equality for the association list keys.
        +
        Returns:
        +
        A function that can be applied to a default value (there is no association) and an associated key.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/package-frame.html b/javadoc/5.0/functionaljava/fj/function/package-frame.html new file mode 100644 index 0000000..38b9dc7 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/package-frame.html @@ -0,0 +1,56 @@ + + + + + +fj.function (core 5.0 API) + + + + +

fj.function

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/function/package-summary.html b/javadoc/5.0/functionaljava/fj/function/package-summary.html new file mode 100644 index 0000000..70759c6 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/package-summary.html @@ -0,0 +1,329 @@ + + + + + +fj.function (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.function

+
+
A prelude of commonly used first-class functions
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Effect0 
    Effect1<A> 
    Effect2<A,B> 
    Effect3<A,B,C> 
    Effect4<A,B,C,D> 
    Effect5<A,B,C,D,E> 
    Effect6<A,B,C,D,E,F> 
    Effect7<A,B,C,D,E,F,G> 
    Effect8<A,B,C,D,E,F,G,H> 
    Try0<A,Z extends java.lang.Exception> +
    A product of A which may throw an Exception.
    +
    Try1<A,B,Z extends java.lang.Exception> +
    A transformation function from A to B that may throw an Exception.
    +
    Try2<A,B,C,Z extends java.lang.Exception> +
    A transformation function of arity-2 from A and B to C that may throw an Exception.
    +
    Try3<A,B,C,D,Z extends java.lang.Exception> +
    A transformation function of arity-3 from A, B and C to D that may throw an Exception.
    +
    Try4<A,B,C,D,E,Z extends java.lang.Exception> +
    A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
    +
    Try5<A,B,C,D,E,F,Z extends java.lang.Exception> +
    A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
    +
    Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> +
    A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
    +
    Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> +
    A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
    +
    Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> +
    A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
    +
    TryEffect0<Z extends java.lang.Exception> 
    TryEffect1<A,Z extends java.lang.Exception> 
    TryEffect2<A,B,Z extends java.lang.Exception> 
    TryEffect3<A,B,C,Z extends java.lang.Exception> 
    TryEffect4<A,B,C,D,Z extends java.lang.Exception> 
    TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> 
    TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> 
    TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> 
    TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> 
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    BigIntegers +
    Curried functions over Integers.
    +
    Booleans +
    Curried logical functions.
    +
    Characters +
    First-class functions on Characters.
    +
    Doubles +
    Curried functions over Doubles.
    +
    Integers +
    Curried functions over Integers.
    +
    Longs +
    Curried functions over Longs.
    +
    Strings +
    Curried string functions.
    +
    Visitor +
    The essence of the visitor design pattern expressed polymorphically.
    +
    +
    • +
+ + + +

Package fj.function Description

+
A prelude of commonly used first-class functions
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/function/package-tree.html b/javadoc/5.0/functionaljava/fj/function/package-tree.html new file mode 100644 index 0000000..18581c7 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/function/package-tree.html @@ -0,0 +1,179 @@ + + + + + +fj.function Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.function

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+
    +
  • java.util.function.BiConsumer<T,U> + +
    • +
  • java.util.function.Consumer<T> + +
    • +
  • fj.function.Effect0
    • +
  • fj.function.Effect3<A,B,C>
    • +
  • fj.function.Effect4<A,B,C,D>
    • +
  • fj.function.Effect5<A,B,C,D,E>
    • +
  • fj.function.Effect6<A,B,C,D,E,F>
    • +
  • fj.function.Effect7<A,B,C,D,E,F,G>
    • +
  • fj.function.Effect8<A,B,C,D,E,F,G,H>
    • +
  • fj.function.Try0<A,Z>
    • +
  • fj.function.Try1<A,B,Z>
    • +
  • fj.function.Try2<A,B,C,Z>
    • +
  • fj.function.Try3<A,B,C,D,Z>
    • +
  • fj.function.Try4<A,B,C,D,E,Z>
    • +
  • fj.function.Try5<A,B,C,D,E,F,Z>
    • +
  • fj.function.Try6<A,B,C,D,E,F,G,Z>
    • +
  • fj.function.Try7<A,B,C,D,E,F,G,H,Z>
    • +
  • fj.function.Try8<A,B,C,D,E,F,G,H,I,Z>
    • +
  • fj.function.TryEffect0<Z>
    • +
  • fj.function.TryEffect1<A,Z>
    • +
  • fj.function.TryEffect2<A,B,Z>
    • +
  • fj.function.TryEffect3<A,B,C,Z>
    • +
  • fj.function.TryEffect4<A,B,C,D,Z>
    • +
  • fj.function.TryEffect5<A,B,C,D,E,Z>
    • +
  • fj.function.TryEffect6<A,B,C,D,E,F,Z>
    • +
  • fj.function.TryEffect7<A,B,C,D,E,F,G,Z>
    • +
  • fj.function.TryEffect8<A,B,C,D,E,F,G,H,Z>
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/package-frame.html b/javadoc/5.0/functionaljava/fj/package-frame.html new file mode 100644 index 0000000..d2766f6 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/package-frame.html @@ -0,0 +1,72 @@ + + + + + +fj (core 5.0 API) + + + + +

fj

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/package-summary.html b/javadoc/5.0/functionaljava/fj/package-summary.html new file mode 100644 index 0000000..354f0ed --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/package-summary.html @@ -0,0 +1,454 @@ + + + + + +fj (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj

+
+
Types that set the premise for the existence of Functional Java.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Bounded.Definition<A> +
    Minimal definition of Bounded
    +
    Equal.AltDefinition<A> +
    Primitives functions of Equal: alternative minimal definition and overridable methods.
    +
    Equal.Definition<A> +
    Primitives functions of Equal: minimal definition and overridable methods.
    +
    F<A,B> +
    A transformation or function from A to B.
    +
    F0<A> 
    F2<A,B,C> +
    A transformation function of arity-2 from A and B to C.
    +
    F3<A,B,C,D> +
    A transformation function of arity-3 from A, B and C to + D.
    +
    F4<A,B,C,D,E> +
    A transformation function of arity-4 from A, B, C and + D to E.
    +
    F5<A,B,C,D,E,F$> +
    A transformation function of arity-5 from A, B, C, + D and E to F$.
    +
    F6<A,B,C,D,E,F$,G> +
    A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
    +
    F7<A,B,C,D,E,F$,G,H> +
    A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
    +
    F8<A,B,C,D,E,F$,G,H,I> +
    A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
    +
    Monoid.AltDefinition<A> +
    Primitives functions of Monoid: alternative minimal definition and overridable methods.
    +
    Monoid.Definition<A> +
    Primitives functions of Monoid: minimal definition and overridable methods.
    +
    Ord.AltDefinition<A> +
    Primitives functions of Ord: alternative minimal definition and overridable methods.
    +
    Ord.Definition<A> +
    Primitives functions of Ord: minimal definition and overridable methods.
    +
    Semigroup.AltDefinition<A> +
    Primitives functions of Semigroup: alternative minimal definition and overridable methods.
    +
    Semigroup.Definition<A> +
    Primitives functions of Semigroup: minimal definition and overridable methods.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Bottom +
    Represents the bottom _|_ value.
    +
    Bounded<A> +
    The Bounded class is used to name the upper and lower limits of a type.
    +
    Class<T> +
    A wrapper for a Class that provides additional methods.
    +
    Effect +
    Represents a side-effect.
    +
    Equal<A> +
    Tests for equality between two objects.
    +
    Function +
    Transformations on functions.
    +
    Hash<A> +
    Produces a hash code for an object which should attempt uniqueness.
    +
    LcgRng +
    https://en.wikipedia.org/wiki/Linear_congruential_generator
    +
    Monoid<A> +
    A monoid abstraction to be defined across types of the given type argument.
    +
    Ord<A> +
    Tests for ordering between two objects.
    +
    P +
    Functions across products.
    +
    P1<A> 
    P2<A,B> +
    A product-2.
    +
    P2.Optic +
    Optic factory methods for a P2
    +
    P3<A,B,C> +
    A product-3.
    +
    P4<A,B,C,D> +
    A product-4.
    +
    P5<A,B,C,D,E> +
    A product-5.
    +
    P6<A,B,C,D,E,F> +
    A product-6.
    +
    P7<A,B,C,D,E,F,G> +
    A product-7.
    +
    P8<A,B,C,D,E,F,G,H> +
    A product-8.
    +
    Primitive +
    Functions that convert between Java primitive types.
    +
    Rng 
    Semigroup<A> +
    Implementations must satisfy the law of associativity: + + Associativity; forall x.
    +
    Show<A> +
    Renders an object for display.
    +
    Try 
    TryEffect 
    Unit +
    The unit type which has only one value.
    +
    Void +
    A logically uninhabited data type.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    Digit +
    The digits zero to nine.
    +
    Ordering +
    The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
    +
    +
    • +
+ + + +

Package fj Description

+
Types that set the premise for the existence of Functional Java.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/package-tree.html b/javadoc/5.0/functionaljava/fj/package-tree.html new file mode 100644 index 0000000..c5887fa --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/package-tree.html @@ -0,0 +1,227 @@ + + + + + +fj Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/Parser.CharsParser.html b/javadoc/5.0/functionaljava/fj/parser/Parser.CharsParser.html new file mode 100644 index 0000000..cee5091 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/Parser.CharsParser.html @@ -0,0 +1,1502 @@ + + + + + +Parser.CharsParser (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.CharsParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.CharsParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.CharsParser
+extends java.lang.Object
    +
    Parsers that accept Stream<Character> input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alpha(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>alphaNum(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an alpha-numeric character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(E missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> e) +
      Returns a parser that produces a character if one is available or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>character(F0<E> missing, + F<java.lang.Character,E> sat, + char c) +
      Returns a parser that produces the given character or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(E missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + F<java.lang.Character,E> sat, + Stream<java.lang.Character> cs) +
      Returns a parser that produces the given stream of characters or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E>characters(F0<E> missing, + int n) +
      Returns a parser that produces the given number of characters, or fails with the given error.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>defined(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a defined character.
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,Digit,E>digit(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a digit (0 to 9).
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>highSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a high-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>identifierIgnorable(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an identifier-ignorable character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>isoControl(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces an ISO control character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>javaIdentifierStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a Java identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lower(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a lower-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>lowSurrogate(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a low-surrogate character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>mirrored(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a mirrored character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>space(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(E missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.String,E>string(F0<E> missing, + F<java.lang.Character,E> sat, + java.lang.String s) +
      Returns a parser that produces the given string or fails otherwise.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>titleCase(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a title-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferPart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier part character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>unicodeIdentiferStart(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a unicode identifier start character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>upper(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a upper-case character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(E missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E>whitespace(F0<E> missing, + F<java.lang.Character,E> sat) +
      Returns a parser that produces a white-space character.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E e)
        +
        Returns a parser that produces a character if one is available or fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with if a character is unavailable.
        +
        Returns:
        +
        A parser that produces a character if one is available or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        character

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> character(E missing,
+                                                                                      F<java.lang.Character,E> sat,
+                                                                                      char c)
        +
        Returns a parser that produces the given character or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if no character is available.
        +
        sat - The error if the produced character is not the one given.
        +
        c - The character to produce in the parser.
        +
        Returns:
        +
        A parser that produces the given character or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               int n)
        +
        Returns a parser that produces the given number of characters, or fails with the given error.
        +
        +
        Parameters:
        +
        missing - The error if the given number of characters is unavailable.
        +
        n - The number of characters to produce in the parse result.
        +
        Returns:
        +
        A parser that produces the given number of characters, or fails with the given error.
        +
        +
        • +
      + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        characters

        +
        public static <E> Parser<Stream<java.lang.Character>,Stream<java.lang.Character>,E> characters(E missing,
+                                                                                               F<java.lang.Character,E> sat,
+                                                                                               Stream<java.lang.Character> cs)
        +
        Returns a parser that produces the given stream of characters or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given stream of characters.
        +
        cs - The stream of characters to produce.
        +
        Returns:
        +
        A parser that produces the given stream of characters or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(F0<E> missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        string

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.String,E> string(E missing,
+                                                                                F<java.lang.Character,E> sat,
+                                                                                java.lang.String s)
        +
        Returns a parser that produces the given string or fails otherwise.
        +
        +
        Parameters:
        +
        missing - The error if the producing stream could not supply more characters.
        +
        sat - The error if a character was produced that is not the given string.
        +
        s - The string to produce.
        +
        Returns:
        +
        A parser that produces the given string or fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(F0<E> missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + + + +
        +
      • +

        digit

        +
        public static <E> Parser<Stream<java.lang.Character>,Digit,E> digit(E missing,
+                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a digit (0 to 9).
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a digit with.
        +
        sat - The error if the produced character is not a digit.
        +
        Returns:
        +
        A parser that produces a digit (0 to 9).
        +
        +
        • +
      + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lower

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lower(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a lower-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a lower-case character with.
        +
        sat - The error if the produced character is not a lower-case character.
        +
        Returns:
        +
        A parser that produces a lower-case character.
        +
        See Also:
        +
        Character.isLowerCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        upper

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> upper(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a upper-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a upper-case character with.
        +
        sat - The error if the produced character is not a upper-case character.
        +
        Returns:
        +
        A parser that produces a upper-case character.
        +
        See Also:
        +
        Character.isUpperCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(F0<E> missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        defined

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> defined(E missing,
+                                                                                    F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a defined character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a defined character with.
        +
        sat - The error if the produced character is not a defined character.
        +
        Returns:
        +
        A parser that produces a defined character.
        +
        See Also:
        +
        Character.isDefined(char)
        +
        +
        • +
      + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(F0<E> missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        highSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> highSurrogate(E missing,
+                                                                                          F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a high-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a high-surrogate character with.
        +
        sat - The error if the produced character is not a high-surrogate character.
        +
        Returns:
        +
        A parser that produces a high-surrogate character.
        +
        See Also:
        +
        Character.isHighSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        identifierIgnorable

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> identifierIgnorable(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an identifier-ignorable character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an identifier-ignorable character with.
        +
        sat - The error if the produced character is not an identifier-ignorable character.
        +
        Returns:
        +
        A parser that produces an identifier-ignorable character.
        +
        See Also:
        +
        Character.isIdentifierIgnorable(char)
        +
        +
        • +
      + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        isoControl

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> isoControl(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an ISO control character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an ISO control character with.
        +
        sat - The error if the produced character is not an ISO control character.
        +
        Returns:
        +
        A parser that produces an ISO control character.
        +
        See Also:
        +
        Character.isISOControl(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(F0<E> missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierPart(E missing,
+                                                                                               F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier part character with.
        +
        sat - The error if the produced character is not a Java identifier part character.
        +
        Returns:
        +
        A parser that produces a Java identifier part character.
        +
        See Also:
        +
        Character.isJavaIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(F0<E> missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        javaIdentifierStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> javaIdentifierStart(E missing,
+                                                                                                F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a Java identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a Java identifier start character with.
        +
        sat - The error if the produced character is not a Java identifier start character.
        +
        Returns:
        +
        A parser that produces a Java identifier start character.
        +
        See Also:
        +
        Character.isJavaIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alpha

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alpha(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha character with.
        +
        sat - The error if the produced character is not an alpha character.
        +
        Returns:
        +
        A parser that produces an alpha character.
        +
        See Also:
        +
        Character.isLetter(char)
        +
        +
        • +
      + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        alphaNum

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> alphaNum(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces an alpha-numeric character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce an alpha-numeric character with.
        +
        sat - The error if the produced character is not an alpha-numeric character.
        +
        Returns:
        +
        A parser that produces an alpha-numeric character.
        +
        See Also:
        +
        Character.isLetterOrDigit(char)
        +
        +
        • +
      + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(F0<E> missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        lowSurrogate

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> lowSurrogate(E missing,
+                                                                                         F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a low-surrogate character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a low-surrogate character with.
        +
        sat - The error if the produced character is not a low-surrogate character.
        +
        Returns:
        +
        A parser that produces a low-surrogate character.
        +
        See Also:
        +
        Character.isLowSurrogate(char)
        +
        +
        • +
      + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(F0<E> missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        mirrored

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> mirrored(E missing,
+                                                                                     F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a mirrored character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a mirrored character with.
        +
        sat - The error if the produced character is not a mirrored character.
        +
        Returns:
        +
        A parser that produces a mirrored character.
        +
        See Also:
        +
        Character.isMirrored(char)
        +
        +
        • +
      + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(F0<E> missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        space

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> space(E missing,
+                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a space character with.
        +
        sat - The error if the produced character is not a space character.
        +
        Returns:
        +
        A parser that produces a space character.
        +
        See Also:
        +
        Character.isSpace(char)
        +
        +
        • +
      + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(F0<E> missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        titleCase

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> titleCase(E missing,
+                                                                                      F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a title-case character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a title-case character with.
        +
        sat - The error if the produced character is not a title-case character.
        +
        Returns:
        +
        A parser that produces a title-case character.
        +
        See Also:
        +
        Character.isTitleCase(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(F0<E> missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferPart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferPart(E missing,
+                                                                                                 F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier part character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier part character with.
        +
        sat - The error if the produced character is not a unicode identifier part character.
        +
        Returns:
        +
        A parser that produces a unicode identifier part character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierPart(char)
        +
        +
        • +
      + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(F0<E> missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        unicodeIdentiferStart

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> unicodeIdentiferStart(E missing,
+                                                                                                  F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a unicode identifier start character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a unicode identifier start character with.
        +
        sat - The error if the produced character is not a unicode identifier start character.
        +
        Returns:
        +
        A parser that produces a unicode identifier start character.
        +
        See Also:
        +
        Character.isUnicodeIdentifierStart(char)
        +
        +
        • +
      + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(F0<E> missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      + + + + + +
        +
      • +

        whitespace

        +
        public static <E> Parser<Stream<java.lang.Character>,java.lang.Character,E> whitespace(E missing,
+                                                                                       F<java.lang.Character,E> sat)
        +
        Returns a parser that produces a white-space character.
        +
        +
        Parameters:
        +
        missing - The error if there is no character on the stream to produce a white-space character with.
        +
        sat - The error if the produced character is not a white-space character.
        +
        Returns:
        +
        A parser that produces a white-space character.
        +
        See Also:
        +
        Character.isWhitespace(char)
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/Parser.StreamParser.html b/javadoc/5.0/functionaljava/fj/parser/Parser.StreamParser.html new file mode 100644 index 0000000..675216b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/Parser.StreamParser.html @@ -0,0 +1,330 @@ + + + + + +Parser.StreamParser (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser.StreamParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser.StreamParser
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Parser<I,A,E>
    +
    +
    +
    +
    public static final class Parser.StreamParser
+extends java.lang.Object
    +
    Parsers that accept Stream input.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <I,E> Parser<Stream<I>,I,E>element(E e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>element(F0<E> e) +
      Returns a parser that produces an element from the stream if it is available and fails otherwise.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(E missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      static <I,E> Parser<Stream<I>,I,E>satisfy(F0<E> missing, + F<I,E> sat, + F<I,java.lang.Boolean> f) +
      Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(F0<E> e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + + + +
        +
      • +

        element

        +
        public static <I,E> Parser<Stream<I>,I,E> element(E e)
        +
        Returns a parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        Parameters:
        +
        e - The error to fail with if no element is available.
        +
        Returns:
        +
        A parser that produces an element from the stream if it is available and fails otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(F0<E> missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      + + + + + +
        +
      • +

        satisfy

        +
        public static <I,E> Parser<Stream<I>,I,E> satisfy(E missing,
+                                                  F<I,E> sat,
+                                                  F<I,java.lang.Boolean> f)
        +
        Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        Parameters:
        +
        missing - The error if no element is available.
        +
        sat - The error if the element does not satisfy the predicate.
        +
        f - The predicate that the element should satisfy.
        +
        Returns:
        +
        A parser that produces an element from the stream that satisfies the given predicate, or fails.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/Parser.html b/javadoc/5.0/functionaljava/fj/parser/Parser.html new file mode 100644 index 0000000..db3dc4b --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/Parser.html @@ -0,0 +1,948 @@ + + + + + +Parser (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Parser<I,A,E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Parser<I,A,E>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class Parser<I,A,E>
+extends java.lang.Object
    +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        parse

        +
        public Validation<E,Result<I,A>> parse(I i)
        +
        Parses the input to produce a result or error.
        +
        +
        Parameters:
        +
        i - The input to parse.
        +
        Returns:
        +
        A parse result with the remaining input or an error.
        +
        +
        • +
      + + + +
        +
      • +

        xmap

        +
        public <Z> Parser<Z,A,E> xmap(F<I,Z> f,
+                              F<Z,I> g)
        +
        Maps the parse input type through an invariant functor.
        +
        +
        Parameters:
        +
        f - The function to covariant map.
        +
        g - The function to contra-variant map.
        +
        Returns:
        +
        A parser with the new input type.
        +
        +
        • +
      + + + +
        +
      • +

        map

        +
        public <B> Parser<I,B,E> map(F<A,B> f)
        +
        Maps the given result type across this parser.
        +
        +
        Parameters:
        +
        f - The function to map.
        +
        Returns:
        +
        A parser with the new result type.
        +
        +
        • +
      + + + + + +
        +
      • +

        filter

        +
        public Parser<I,A,E> filter(F<A,java.lang.Boolean> f,
+                            E e)
        +
        Returns a parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        Parameters:
        +
        f - The predicate to filter on.
        +
        e - The error to in the event that the predicate is not met.
        +
        Returns:
        +
        A parser that fails with the given error if the result value does not meet the given predicate.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B> Parser<I,B,E> bind(F<A,Parser<I,B,E>> f)
        +
        Binds the given function across the parser with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of this parser.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C> Parser<I,C,E> bind(Parser<I,B,E> pb,
+                                F<A,F<B,C>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D> Parser<I,D,E> bind(Parser<I,B,E> pb,
+                                  Parser<I,C,E> pc,
+                                  F<A,F<B,F<C,D>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$> Parser<I,E$,E> bind(Parser<I,B,E> pb,
+                                      Parser<I,C,E> pc,
+                                      Parser<I,D,E> pd,
+                                      F<A,F<B,F<C,F<D,E$>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$> Parser<I,F$,E> bind(Parser<I,B,E> pb,
+                                         Parser<I,C,E> pc,
+                                         Parser<I,D,E> pd,
+                                         Parser<I,E$,E> pe,
+                                         F<A,F<B,F<C,F<D,F<E$,F$>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G> Parser<I,G,E> bind(Parser<I,B,E> pb,
+                                          Parser<I,C,E> pc,
+                                          Parser<I,D,E> pd,
+                                          Parser<I,E$,E> pe,
+                                          Parser<I,F$,E> pf,
+                                          F<A,F<B,F<C,F<D,F<E$,F<F$,G>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H> Parser<I,H,E> bind(Parser<I,B,E> pb,
+                                            Parser<I,C,E> pc,
+                                            Parser<I,D,E> pd,
+                                            Parser<I,E$,E> pe,
+                                            Parser<I,F$,E> pf,
+                                            Parser<I,G,E> pg,
+                                            F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,H>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public <B,C,D,E$,F$,G,H,I$> Parser<I,I$,E> bind(Parser<I,B,E> pb,
+                                                Parser<I,C,E> pc,
+                                                Parser<I,D,E> pd,
+                                                Parser<I,E$,E> pe,
+                                                Parser<I,F$,E> pf,
+                                                Parser<I,G,E> pg,
+                                                Parser<I,H,E> ph,
+                                                F<A,F<B,F<C,F<D,F<E$,F<F$,F<G,F<H,I$>>>>>>>> f)
        +
        Binds the given function across the parsers with a final join.
        +
        +
        Parameters:
        +
        f - The function to apply to the element of the parsers.
        +
        pb - A given parser to bind the given function with.
        +
        pc - A given parser to bind the given function with.
        +
        pd - A given parser to bind the given function with.
        +
        pe - A given parser to bind the given function with.
        +
        pf - A given parser to bind the given function with.
        +
        pg - A given parser to bind the given function with.
        +
        ph - A given parser to bind the given function with.
        +
        Returns:
        +
        A new parser after performing the map, then final join.
        +
        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public <B> Parser<I,B,E> sequence(Parser<I,B,E> p)
        +
        Binds anonymously, ignoring the result value.
        +
        +
        Parameters:
        +
        p - The parser to bind with.
        +
        Returns:
        +
        A parser after binding anonymously.
        +
        +
        • +
      + + + +
        +
      • +

        apply

        +
        public <B> Parser<I,B,E> apply(Parser<I,F<A,B>,E> p)
        +
        Performs function application within a parser.
        +
        +
        Parameters:
        +
        p - The parser returning a function value.
        +
        Returns:
        +
        A new parser after function application.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(F0<Parser<I,A,E>> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Parser<I,A,E> or(Parser<I,A,E> alt,
+                        Semigroup<E> s)
        +
        Returns a parser that tries this parser and if it fails, then tries the given parser. If both parsers fail, then + append their errors with the given semigroup.
        +
        +
        Parameters:
        +
        alt - The parser to try if this parser fails.
        +
        s - The semigroup to append error messages if both parsers fail.
        +
        Returns:
        +
        A parser that tries this parser and if it fails, then tries the given parser.
        +
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(F0<E> e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + + + +
        +
      • +

        not

        +
        public Parser<I,Unit,E> not(E e)
        +
        Returns a parser that negates this parser. If this parser succeeds, then the returned parser fails and vice versa.
        +
        +
        Parameters:
        +
        e - The error message to fail with if this parser succeeds.
        +
        Returns:
        +
        A parser that negates this parser.
        +
        +
        • +
      + + + +
        +
      • +

        repeat

        +
        public Parser<I,Stream<A>,E> repeat()
        +
        Returns a parser that repeats application of this parser zero or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser zero or many times.
        +
        +
        • +
      + + + +
        +
      • +

        repeat1

        +
        public Parser<I,Stream<A>,E> repeat1()
        +
        Returns a parser that repeats application of this parser one or many times.
        +
        +
        Returns:
        +
        A parser that repeats application of this parser one or many times.
        +
        +
        • +
      + + + +
        +
      • +

        mapError

        +
        public <K> Parser<I,A,K> mapError(F<E,K> f)
        +
        Maps the given function across this parser's error.
        +
        +
        Parameters:
        +
        f - The function to map this parser's error with.
        +
        Returns:
        +
        A new parser with a new error type.
        +
        +
        • +
      + + + +
        +
      • +

        parser

        +
        public static <I,A,E> Parser<I,A,E> parser(F<I,Validation<E,Result<I,A>>> f)
        +
        Returns a parser that computes using the given function.
        +
        +
        Parameters:
        +
        f - The function to construct the parser with.
        +
        Returns:
        +
        A parser that computes using the given function.
        +
        +
        • +
      + + + + + +
        +
      • +

        value

        +
        public static <I,A,E> Parser<I,A,E> value(A a)
        +
        Constructs a parser that always returns the given value. The unital for a parser.
        +
        +
        Parameters:
        +
        a - The value to consistently return from a parser.
        +
        Returns:
        +
        A parser that always returns the given value.
        +
        +
        • +
      + + + + + +
        +
      • +

        fail

        +
        public static <I,A,E> Parser<I,A,E> fail(E e)
        +
        Returns a parser that always fails with the given error.
        +
        +
        Parameters:
        +
        e - The error to fail with.
        +
        Returns:
        +
        A parser that always fails with the given error.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/Result.html b/javadoc/5.0/functionaljava/fj/parser/Result.html new file mode 100644 index 0000000..daf2731 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/Result.html @@ -0,0 +1,523 @@ + + + + + +Result (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
fj.parser
+

Class Result<I,A>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • fj.parser.Result<I,A>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<A>
    +
    +
    +
    +
    public final class Result<I,A>
+extends java.lang.Object
+implements java.lang.Iterable<A>
    +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>>bimap() +
      First-class bifunctor map.
      +
      <B,J> Result<J,B>bimap(F<I,J> f, + F<A,B> g) +
      A bifunctor map across both the remainder of the parse input and the parse value.
      +
      booleanequals(java.lang.Object other) 
      inthashCode() 
      java.util.Iterator<A>iterator() +
      Returns an iterator over the parse value.
      +
      <J> F<F<I,J>,Result<J,A>>mapRest() +
      First-class function mapping across the remainder of the parse input.
      +
      <J> Result<J,A>mapRest(F<I,J> f) +
      Maps the given function across the remainder of the parse input.
      +
      <B> F<F<A,B>,Result<I,B>>mapValue() +
      First-class function mapping across the parse value.
      +
      <B> Result<I,B>mapValue(F<A,B> f) +
      Maps the given function across the parse value.
      +
      Irest() +
      The remainder of the parse input.
      +
      static <A,I> F<I,F<A,Result<I,A>>>result() +
      First-class construction of a result.
      +
      static <A,I> Result<I,A>result(I i, + A a) +
      Construct a result with the given remainder of the parse input and parse value.
      +
      java.lang.StringtoString() 
      Avalue() +
      The parsed value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public final java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object other)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        rest

        +
        public I rest()
        +
        The remainder of the parse input.
        +
        +
        Returns:
        +
        The remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        value

        +
        public A value()
        +
        The parsed value.
        +
        +
        Returns:
        +
        The parsed value.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> Result<J,A> mapRest(F<I,J> f)
        +
        Maps the given function across the remainder of the parse input.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapRest

        +
        public <J> F<F<I,J>,Result<J,A>> mapRest()
        +
        First-class function mapping across the remainder of the parse input.
        +
        +
        Returns:
        +
        A first-class function mapping across the remainder of the parse input.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> Result<I,B> mapValue(F<A,B> f)
        +
        Maps the given function across the parse value.
        +
        +
        Parameters:
        +
        f - The function to map with.
        +
        Returns:
        +
        A result with a different parse value.
        +
        +
        • +
      + + + +
        +
      • +

        mapValue

        +
        public <B> F<F<A,B>,Result<I,B>> mapValue()
        +
        First-class function mapping across the parse value.
        +
        +
        Returns:
        +
        A first-class function mapping across the parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> Result<J,B> bimap(F<I,J> f,
+                               F<A,B> g)
        +
        A bifunctor map across both the remainder of the parse input and the parse value.
        +
        +
        Parameters:
        +
        f - The function to map the remainder of the parse input with.
        +
        g - The function to map the parse value with.
        +
        Returns:
        +
        A result with a different parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        bimap

        +
        public <B,J> F<F<I,J>,F<F<A,B>,Result<J,B>>> bimap()
        +
        First-class bifunctor map.
        +
        +
        Returns:
        +
        A first-class bifunctor map.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<A> iterator()
        +
        Returns an iterator over the parse value. This method exists to permit the use in a for-each loop.
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<A>
        +
        Returns:
        +
        An iterator over the parse value.
        +
        +
        • +
      + + + + + +
        +
      • +

        result

        +
        public static <A,I> Result<I,A> result(I i,
+                                       A a)
        +
        Construct a result with the given remainder of the parse input and parse value.
        +
        +
        Parameters:
        +
        i - The remainder of the parse input.
        +
        a - The parse value.
        +
        Returns:
        +
        A result with the given remainder of the parse input and parse value.
        +
        +
        • +
      + + + +
        +
      • +

        result

        +
        public static <A,I> F<I,F<A,Result<I,A>>> result()
        +
        First-class construction of a result.
        +
        +
        Returns:
        +
        A first-class function for construction of a result.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/package-frame.html b/javadoc/5.0/functionaljava/fj/parser/package-frame.html new file mode 100644 index 0000000..798ece1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/package-frame.html @@ -0,0 +1,22 @@ + + + + + +fj.parser (core 5.0 API) + + + + +

fj.parser

+
+

Classes

+ +
+ + diff --git a/javadoc/5.0/functionaljava/fj/parser/package-summary.html b/javadoc/5.0/functionaljava/fj/parser/package-summary.html new file mode 100644 index 0000000..de95eb1 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/package-summary.html @@ -0,0 +1,169 @@ + + + + + +fj.parser (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package fj.parser

+
+
Parser combinators.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Parser<I,A,E> +
    A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
    +
    Parser.CharsParser +
    Parsers that accept Stream<Character> input.
    +
    Parser.StreamParser +
    Parsers that accept Stream input.
    +
    Result<I,A> +
    A parse result made up of a value (A) and the remainder of the parse input (I).
    +
    +
    • +
+ + + +

Package fj.parser Description

+
Parser combinators.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/fj/parser/package-tree.html b/javadoc/5.0/functionaljava/fj/parser/package-tree.html new file mode 100644 index 0000000..bd48e58 --- /dev/null +++ b/javadoc/5.0/functionaljava/fj/parser/package-tree.html @@ -0,0 +1,137 @@ + + + + + +fj.parser Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package fj.parser

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/help-doc.html b/javadoc/5.0/functionaljava/help-doc.html new file mode 100644 index 0000000..1ac4bac --- /dev/null +++ b/javadoc/5.0/functionaljava/help-doc.html @@ -0,0 +1,222 @@ + + + + + +API Help (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/index-all.html b/javadoc/5.0/functionaljava/index-all.html new file mode 100644 index 0000000..3492af7 --- /dev/null +++ b/javadoc/5.0/functionaljava/index-all.html @@ -0,0 +1,15867 @@ + + + + + +Index (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _  + + +

$

+
+
$<A,B> - Class in fj.data
+
+
The constant arrow, for attaching a new name to an existing type.
+
+
+ + + +

A

+
+
abs - Static variable in class fj.function.BigIntegers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Doubles
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Integers
+
+
Absolute value.
+
+
abs - Static variable in class fj.function.Longs
+
+
Absolute value.
+
+
absurd() - Method in class fj.Void
+
+
Since Void values logically don't exist, this witnesses the logical reasoning tool of "ex falso quodlibet".
+
+
accept(A) - Method in interface fj.function.Effect1
+
 
+
accept(A, B) - Method in interface fj.function.Effect2
+
 
+
accumapply(Semigroup<E>, Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the successful side of this validation, or accumulating the errors on the failing side + using the given semigroup should one or more be encountered.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F<T, F<A, B>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, F2<T, A, B>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F<T, F<A, F<B, C>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, F3<T, A, B, C>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F<T, F<A, F<B, F<C, D>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, F4<T, A, B, C, D>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F<T, F<A, F<B, F<C, F<D, E$>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, F5<T, A, B, C, D, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F<T, F<A, F<B, F<C, F<D, F<E$, F$>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, F6<T, A, B, C, D, E$, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, F7<T, A, B, C, D, E$, F$, G>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F<T, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>, F8<T, A, B, C, D, E$, F$, G, H>) - Method in class fj.data.Validation
+
+
Accumulates errors on the failing side of this or any given validation if one or more are encountered, or applies + the given function if all succeeded and returns that value on the successful side.
+
+
accumulate(Semigroup<E>, Validation<E, A>, Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, E$>, Validation<E, F$>, Validation<E, G>) - Method in class fj.data.Validation
+
+
Accumulates errors anonymously.
+
+
accumulate() - Method in class fj.data.Validation
+
 
+
accumulate(F<T, B>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, F2<T, B, C>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, F3<T, B, C, D>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, F4<T, B, C, D, $E>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, F5<T, B, C, D, $E, $F>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, F6<T, B, C, D, $E, $F, G>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, F7<T, B, C, D, $E, $F, G, H>) - Method in class fj.data.Validation
+
 
+
accumulate(Validation<E, B>, Validation<E, C>, Validation<E, D>, Validation<E, $E>, Validation<E, $F>, Validation<E, G>, Validation<E, H>, F8<T, B, C, D, $E, $F, G, H, I>) - Method in class fj.data.Validation
+
 
+
act(A) - Method in class fj.control.parallel.Actor
+
+
Pass a message to this actor, applying its side-effect to the message.
+
+
Actor<A> - Class in fj.control.parallel
+
+
Light weight actors for Java.
+
+
actor(Strategy<Unit>, Effect1<A>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Strategy<Unit>, F<A, P1<Unit>>) - Static method in class fj.control.parallel.Actor
+
+
Creates a new Actor that uses the given parallelization strategy and has the given side-effect.
+
+
actor(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a concurrent actor that is guaranteed to process only one message at a time.
+
+
actor() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of actors.
+
+
add(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of zero and any other number is that number.
+
+
add(HPre.HSucc<N>, HPre.HSucc<M>, H) - Static method in class fj.data.hlist.HPre.HAdd
+
+
The sum of numbers a and b is one greater than the sum of b and the predecessor of a.
+
+
add - Static variable in class fj.data.Natural
+
+
A function that adds two natural numbers.
+
+
add(Natural) - Method in class fj.data.Natural
+
+
Add two natural numbers together.
+
+
add - Static variable in class fj.function.BigIntegers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Doubles
+
+
Curried Double addition.
+
+
add - Static variable in class fj.function.Integers
+
+
Curried Integer addition.
+
+
add - Static variable in class fj.function.Longs
+
+
Curried Long addition.
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if all targets satisfy the predicate
+
+
all(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if all targets satisfy the predicate
+
+
allEqual(Equal<A>) - Method in class fj.data.List
+
+
Returns whether or not all elements in the list are equal according to the given equality test.
+
+
alpha(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alpha(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha character.
+
+
alphaNum(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
alphaNum(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an alpha-numeric character.
+
+
always(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation without caching.
+
+
and(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
and - Static variable in class fj.function.Booleans
+
+
Curried form of logical "and" (conjunction).
+
+
and(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given list are true.
+
+
and(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using conjunction
+
+
and(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if all the elements of the given stream are true.
+
+
andAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns composed predicate
+
+
andAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
andThen(F<B, C>) - Method in class fj.data.Reader
+
 
+
andThen(F<B, C>) - Method in interface fj.F
+
+
Function composition flipped.
+
+
andThen() - Method in interface fj.F
+
+
First-class composition flipped.
+
+
andThen() - Static method in class fj.Function
+
+
Function composition flipped.
+
+
andThen(F<A, B>, F<B, C>) - Static method in class fj.Function
+
+
Function composition flipped.
+
+
andThen(F<Unit, B>) - Method in interface fj.function.Effect1
+
 
+
anyEqual() - Static method in class fj.Equal
+
+
Returns an equal instance that uses the Object.equals(Object) method to test for + equality.
+
+
anyHash() - Static method in class fj.Hash
+
+
A hash that uses Object.hashCode().
+
+
anyShow() - Static method in class fj.Show
+
+
Returns a show instance that uses Object.toString() to perform the display rendering.
+
+
append(Array<A>) - Method in class fj.data.Array
+
+
Appends the given array to this array.
+
+
append(Array<A>) - Method in class fj.data.Array.ImmutableProjection
+
+
Appends the given array to this array.
+
+
append(DList<A>) - Method in class fj.data.DList
+
+
Appends two DLists together to produce a new DList.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Deep
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Empty
+
 
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.FingerTree
+
+
Appends one finger tree to another.
+
+
append(FingerTree<V, A>) - Method in class fj.data.fingertrees.Single
+
 
+
append() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for concatenating heterogeneous lists.
+
+
append(A, B) - Method in class fj.data.hlist.HList.HAppend
+
+
Append a given heterogeneous list to another.
+
+
append() - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for concatenating lists to the empty list.
+
+
append(H) - Static method in class fj.data.hlist.HList.HAppend
+
+
Returns a method for appending lists to a nonempty heterogeneous list.
+
+
append(IO<B>) - Method in interface fj.data.IO
+
 
+
append(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
append(LazyString) - Method in class fj.data.LazyString
+
+
Appends the given lazy string to the end of this lazy string.
+
+
append(String) - Method in class fj.data.LazyString
+
+
Appends the given String to the end of this lazy string.
+
+
append(List<A>) - Method in class fj.data.List
+
+
Appends the given list to this list.
+
+
append(List<A>) - Method in class fj.data.List.Buffer
+
+
Appends the given list to this buffer.
+
+
append(List<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(NonEmptyList<A>) - Method in class fj.data.NonEmptyList
+
+
Appends the given list to this list.
+
+
append(Seq<A>) - Method in class fj.data.Seq
+
+
Appends the given sequence to this sequence.
+
+
append(Stream<A>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Appends the given stream to this stream.
+
+
append(A, A) - Method in interface fj.Monoid.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Ord.Definition
+
 
+
append(C) - Method in class fj.P2
+
+
Creates a P3 by adding the given element to the current P2
+
+
append(P2<C, D>) - Method in class fj.P2
+
+
Creates a P4 by adding the given element to the current P2
+
+
append(P3<C, D, E>) - Method in class fj.P2
+
+
Creates a P5 by adding the given element to the current P2
+
+
append(P4<C, D, E, F>) - Method in class fj.P2
+
+
Creates a P6 by adding the given element to the current P2
+
+
append(P5<C, D, E, F, G>) - Method in class fj.P2
+
+
Creates a P7 by adding the given element to the current P2
+
+
append(P6<C, D, E, F, G, H>) - Method in class fj.P2
+
+
Creates a P8 by adding the given element to the current P2
+
+
append(D) - Method in class fj.P3
+
+
Creates a P4 by adding the given element to the current P3
+
+
append(P2<D, E>) - Method in class fj.P3
+
+
Creates a P5 by adding the given element to the current P3
+
+
append(P3<D, E, F>) - Method in class fj.P3
+
+
Creates a P6 by adding the given element to the current P3
+
+
append(P4<D, E, F, G>) - Method in class fj.P3
+
+
Creates a P7 by adding the given element to the current P3
+
+
append(P5<D, E, F, G, H>) - Method in class fj.P3
+
+
Creates a P8 by adding the given element to the current P3
+
+
append(E) - Method in class fj.P4
+
+
Creates a P5 by adding the given element to the current P4
+
+
append(P2<E, F>) - Method in class fj.P4
+
+
Creates a P6 by adding the given element to the current P4
+
+
append(P3<E, F, G>) - Method in class fj.P4
+
+
Creates a P7 by adding the given element to the current P4
+
+
append(P4<E, F, G, H>) - Method in class fj.P4
+
+
Creates a P8 by adding the given element to the current P4
+
+
append(F) - Method in class fj.P5
+
+
Creates a P6 by adding the given element to the current P5
+
+
append(P2<F, G>) - Method in class fj.P5
+
+
Creates a P7 by adding the given element to the current P5
+
+
append(P3<F, G, H>) - Method in class fj.P5
+
+
Creates a P8 by adding the given element to the current P5
+
+
append(G) - Method in class fj.P6
+
+
Creates a P7 by adding the given element to the current P6
+
+
append(P2<G, H>) - Method in class fj.P6
+
+
Creates a P8 by adding the given element to the current P6
+
+
append(H) - Method in class fj.P7
+
+
Creates a P8 by adding the given element to the current P7
+
+
append(A, A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
append(A, A) - Method in interface fj.Semigroup.Definition
+
 
+
apply(Callable<A>, Callable<F<A, B>>) - Static method in class fj.control.parallel.Callables
+
+
Performs function application within a callable (applicative functor pattern).
+
+
apply(Promise<F<A, B>>) - Method in class fj.control.parallel.Promise
+
+
Performs function application within a promise (applicative functor pattern).
+
+
apply(Trampoline<F<A, B>>) - Method in class fj.control.Trampoline
+
+
Performs function application within a Trampoline (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Array<F<A, B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs function application within an array (applicative functor pattern).
+
+
apply(Either<F<A, X>, B>) - Method in class fj.data.Either.LeftProjection
+
+
Function application on this projection's value.
+
+
apply(Either<A, F<B, X>>) - Method in class fj.data.Either.RightProjection
+
+
Function application on this projection's value.
+
+
apply(Either3<F<A, X>, B, C>) - Method in class fj.data.Either3.LeftProjection
+
 
+
apply(Either3<A, F<B, X>, C>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
apply(Either3<A, B, F<C, X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
Apply() - Constructor for class fj.data.hlist.HList.Apply
+
 
+
apply(F$, A) - Method in class fj.data.hlist.HList.Apply
+
 
+
apply(IO<A>, IO<F<A, B>>) - Static method in class fj.data.IOFunctions
+
 
+
apply(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Performs function application within an iterable (applicative functor pattern).
+
+
apply(F0<Z>, F0<F<E, Z>>, F0<Z>) - Method in class fj.data.Iteratee.Input
+
 
+
apply(List<F<A, B>>) - Method in class fj.data.List
+
+
Performs function application within a list (applicative functor pattern).
+
+
apply(Option<F<A, B>>) - Method in class fj.data.Option
+
+
Performs function application within an optional value (applicative functor pattern).
+
+
apply(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Performs function application within a stream (applicative functor pattern).
+
+
apply(Validation<E, F<T, A>>) - Method in class fj.data.Validation
+
+
Function application on the success value.
+
+
apply(Validation<F<E, A>, T>) - Method in class fj.data.Validation.FailProjection
+
+
Function application on the failing value.
+
+
apply(V2<F<A, B>>) - Method in class fj.data.vector.V2
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V3<F<A, B>>) - Method in class fj.data.vector.V3
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V4<F<A, B>>) - Method in class fj.data.vector.V4
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V5<F<A, B>>) - Method in class fj.data.vector.V5
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V6<F<A, B>>) - Method in class fj.data.vector.V6
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V7<F<A, B>>) - Method in class fj.data.vector.V7
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(V8<F<A, B>>) - Method in class fj.data.vector.V8
+
+
Performs function application within a vector (applicative functor pattern).
+
+
apply(A) - Method in interface fj.F
+
 
+
apply(F<A, F<B, C>>) - Method in interface fj.F
+
+
Function application in an environment (Applicative Functor).
+
+
apply() - Method in interface fj.F
+
+
First-class function application in an environment.
+
+
apply(A, B) - Method in interface fj.F2
+
 
+
apply(A) - Static method in class fj.Function
+
+
Function application with the arguments flipped.
+
+
apply(F<C, F<A, B>>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(F2<C, A, B>, F<C, A>) - Static method in class fj.Function
+
+
Performs function application within a higher-order function (applicative functor pattern).
+
+
apply(A) - Method in interface fj.function.Effect1
+
 
+
apply(P1<F<A, B>>) - Method in class fj.P1
+
+
Performs function application within a P1 (applicative functor pattern).
+
+
apply(Parser<I, F<A, B>, E>) - Method in class fj.parser.Parser
+
+
Performs function application within a parser.
+
+
Array<A> - Class in fj.data
+
+
Provides an interface to arrays.
+
+
array(Class<A[]>) - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array() - Method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
array(A...) - Static method in class fj.data.Array
+
+
Constructs an array from the given elements.
+
+
array(Class<A[]>) - Method in class fj.data.List
+
+
Returns an array from this list.
+
+
array(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array from this optional value.
+
+
array(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns an array from this stream.
+
+
Array.ImmutableProjection<A> - Class in fj.data
+
+
Projects an array by providing only operations which do not mutate.
+
+
Array_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to array blocking queues.
+
+
Array_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to array lists.
+
+
Array_BitSet - Static variable in class fj.data.Java
+
+
A function that converts arrays to bit sets.
+
+
Array_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to concurrent linked queues.
+
+
Array_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array lists.
+
+
Array_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts arrays to copy on write array sets.
+
+
Array_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to delay queues.
+
+
Array_Either() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to eithers.
+
+
Array_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to enum sets.
+
+
Array_HashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to hash sets.
+
+
Array_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked blocking queues.
+
+
Array_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked hash sets.
+
+
Array_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts arrays to linked lists.
+
+
Array_List() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to lists.
+
+
Array_Option() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to options.
+
+
Array_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority blocking queues.
+
+
Array_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts arrays to priority queues.
+
+
Array_Stack() - Static method in class fj.data.Java
+
+
A function that converts arrays to stacks.
+
+
Array_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts arrays to streams.
+
+
Array_String - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to strings.
+
+
Array_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string buffers.
+
+
Array_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts arrays to string builders.
+
+
Array_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts arrays to synchronous queues.
+
+
Array_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts arrays to tree sets.
+
+
Array_Vector() - Static method in class fj.data.Java
+
+
A function that converts arrays to vectors.
+
+
arrayArray(A...) - Static method in class fj.data.Array
+
+
Returns a copy of the underlying primitive array.
+
+
ArrayBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts array blocking queues to lists.
+
+
arrayDList(A...) - Static method in class fj.data.DList
+
+
Creates a DList from an array
+
+
arrayEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Array type.
+
+
arrayHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Array type.
+
+
arrayHashMap(P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashMap(Equal<K>, Hash<K>, P2<K, V>...) - Static method in class fj.data.HashMap
+
+
Converts the array to a HashMap
+
+
arrayHashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayHashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
arrayK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result in a Array.
+
+
arrayList(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
ArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts array lists to lists.
+
+
arrayM() - Method in interface fj.F2
+
+
Promotes this function to a function on Arrays.
+
+
arrayMonoid() - Static method in class fj.Monoid
+
+
A monoid for arrays.
+
+
arrayOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Array type.
+
+
arraySemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for arrays.
+
+
arraySeq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the array.
+
+
arraySet(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
arrayShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Array type.
+
+
arrayStream(A...) - Static method in class fj.data.Stream
+
 
+
arrayTreeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
arrow() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a function to a Callable-valued function that is equivalent to it.
+
+
arrow() - Static method in class fj.data.IterableW
+
+
Provides a transformation from a function to a Iterable-valued function that is equivalent to it.
+
+
as(IO<A>, B) - Static method in class fj.data.IOFunctions
+
 
+
asFold() - Method in class fj.data.optic.Getter
+
+
view a Getter with a Fold
+
+
asFold() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Fold
+
+
asFold() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Fold
+
+
asFold() - Method in class fj.data.optic.POptional
+
+
view a POptional as a Fold
+
+
asFold() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Fold
+
+
asFold() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a Fold
+
+
asFunction() - Method in class fj.control.db.DB
+
+
Returns the callable-valued function projection of this database action.
+
+
asGetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Getter
+
+
asGetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a Getter
+
+
asJavaList() - Method in class fj.data.Array
+
+
Projects an unmodifiable list view of this array.
+
+
asLens() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Lens
+
+
asLens() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PLens
+
+
asOptional() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Optional
+
+
asOptional() - Method in class fj.data.optic.Lens
+
+
view a Lens as an Optional
+
+
asOptional() - Method in class fj.data.optic.PIso
+
+
view a PIso as a POptional
+
+
asOptional() - Method in class fj.data.optic.PLens
+
+
view a PLens as an POptional
+
+
asOptional() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a POptional
+
+
asOptional() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Optional
+
+
asPrism() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Prism
+
+
asPrism() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PPrism
+
+
asSetter() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Setter
+
+
asSetter() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Setter
+
+
asSetter() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Setter
+
+
asSetter() - Method in class fj.data.optic.PIso
+
+
view a PIso as a Setter
+
+
asSetter() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PSetter
+
+
asSetter() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PSetter
+
+
asSetter() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a Setter
+
+
asSetter() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Setter
+
+
asSetter() - Method in class fj.data.optic.PTraversal
+
+
view a PTraversal as a PSetter
+
+
asSetter() - Method in class fj.data.optic.Traversal
+
+
view a Traversal as a Setter
+
+
association(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
associationLazy(List<P2<A, B>>, Equal<A>) - Static method in class fj.function.Visitor
+
+
Uses an association list to perform a lookup with equality and returns a function that can be applied to a default, + followed by the associated key to return a value.
+
+
asString() - Method in class fj.data.hamt.BitSet
+
 
+
asString(List<Character>) - Static method in class fj.data.List
+
+
Returns a string from the given list of characters.
+
+
asString() - Static method in class fj.data.List
+
+
A first-class asString.
+
+
asString(Stream<Character>) - Static method in class fj.data.Stream
+
+
Returns a string from the given stream of characters.
+
+
asTraversal() - Method in class fj.data.optic.Iso
+
+
view an Iso as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Lens
+
+
view a Lens as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.Optional
+
+
view a Optional as a Traversal
+
+
asTraversal() - Method in class fj.data.optic.PIso
+
+
view a PIso as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PLens
+
+
view a PLens as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.POptional
+
+
view a POptional as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.PPrism
+
+
view a PPrism as a PTraversal
+
+
asTraversal() - Method in class fj.data.optic.Prism
+
+
view a Prism as a Traversal
+
+
atEnd() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the last element.
+
+
atStart() - Method in class fj.data.Zipper
+
+
Returns whether the focus is on the first element.
+
+
+ + + +

B

+
+
BASE_LONG - Static variable in class fj.data.hamt.BitSet
+
 
+
BiFunction_F2(BiFunction<A, B, C>) - Static method in class fj.data.Java8
+
 
+
BiFunction_F2() - Static method in class fj.data.Java8
+
 
+
bigdecimalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big decimals.
+
+
bigdecimalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big decimals.
+
+
bigdecimalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigDecimal.
+
+
bigdecimalEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigDecimal type.
+
+
bigdecimalHash - Static variable in class fj.Hash
+
+
A hash instance for the BigDecimal type.
+
+
bigDecimalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big decimals.
+
+
bigDecimalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big decimals.
+
+
bigdecimalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big decimals.
+
+
bigdecimalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big decimals.
+
+
bigdecimalOrd - Static variable in class fj.Ord
+
+
An order instance for the BigDecimal type.
+
+
bigdecimalShow - Static variable in class fj.Show
+
+
A show instance for the BigDecimal type.
+
+
bigintAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds big integers.
+
+
bigintAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds big integers.
+
+
BigIntegers - Class in fj.function
+
+
Curried functions over Integers.
+
+
bigIntegerValue - Static variable in class fj.data.Natural
+
+
A function that returns the BigInteger value of a given Natural.
+
+
bigIntegerValue() - Method in class fj.data.Natural
+
+
Return the BigInteger value of this natural number.
+
+
bigintEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for BigInteger.
+
+
bigintEqual - Static variable in class fj.Equal
+
+
An equal instance for the BigInteger type.
+
+
bigintHash - Static variable in class fj.Hash
+
+
A hash instance for the BigInteger type.
+
+
bigintMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of big integers.
+
+
bigintMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of big integers.
+
+
bigintMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies big integers.
+
+
bigintMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies big integers.
+
+
bigintOrd - Static variable in class fj.Ord
+
+
An order instance for the BigInteger type.
+
+
bigintShow - Static variable in class fj.Show
+
+
A show instance for the BigInteger type.
+
+
bimap(F<A, X>, F<B, Y>) - Method in class fj.data.Either
+
+
Map the given functions across the appropriate side.
+
+
bimap(F<I, J>, F<A, B>) - Method in class fj.parser.Result
+
+
A bifunctor map across both the remainder of the parse input and the parse value.
+
+
bimap() - Method in class fj.parser.Result
+
+
First-class bifunctor map.
+
+
bind(F<A, DB<B>>) - Method in class fj.control.db.DB
+
+
Binds the given action across the result of this database action.
+
+
bind(Callable<A>, F<A, Callable<B>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the value in a Callable with a final join.
+
+
bind(Callable<A>, Callable<B>, F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Binds the given function to the values in the given callables with a final join.
+
+
bind(F<A, Promise<B>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function over this promise, with a final join.
+
+
bind(Promise<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(P1<Promise<B>>, F<A, F<B, C>>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function to this promise and the given promise, with a final join.
+
+
bind(F<A, Trampoline<B>>) - Method in class fj.control.Trampoline
+
+
Binds the given continuation to the result of this trampoline.
+
+
bind(Trampoline<B>, F<A, F<B, C>>) - Method in class fj.control.Trampoline
+
+
Binds the given function across the result of this Trampoline and the given Trampoline.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Binds the given function across each element of this array and the given array with a final + join.
+
+
bind(F<A, Array<B>>) - Method in class fj.data.Array.ImmutableProjection
+
+
Binds the given function across each element of this array with a final join.
+
+
bind(F<A, Either<X, B>>) - Method in class fj.data.Either.LeftProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<B, Either<A, X>>) - Method in class fj.data.Either.RightProjection
+
+
Binds the given function across this projection's value if it has one.
+
+
bind(F<A, Either3<X, B, C>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
bind(F<B, Either3<A, X, C>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
bind(F<C, Either3<A, B, X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
bind(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function that directly produces Eval.
+
+
bind(F<A, IO<B>>) - Method in interface fj.data.IO
+
 
+
bind(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
bind(F<A, T>) - Method in class fj.data.IterableW
+
+
Binds the given function across the wrapped Iterable with a final join.
+
+
bind(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Binds the given function to the values in the given iterables with a final join.
+
+
bind() - Static method in class fj.data.IterableW
+
+
The first-class bind function over Iterable.
+
+
bind(F<A, Iteratee.IterV<E, B>>) - Method in class fj.data.Iteratee.IterV
+
+
TODO more documentation
+
+
bind(F<Character, LazyString>) - Method in class fj.data.LazyString
+
 
+
bind(F<A, List<B>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given list with a final + join.
+
+
bind(List<B>, List<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(List<B>, List<C>, List<D>, List<E>, List<F$>, List<G>, List<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.List
+
+
Binds the given function across each element of this list and the given lists with a final + join.
+
+
bind(F<A, NonEmptyList<B>>) - Method in class fj.data.NonEmptyList
+
+
Binds the given function across each element of this list with a final join.
+
+
bind(F<A, Option<B>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value with a final join.
+
+
bind(Option<B>, F<A, F<B, C>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Option
+
+
Binds the given function across the element of this optional value and the given optional value + with a final join.
+
+
bind() - Static method in class fj.data.Option
+
+
First-class bind function.
+
+
bind(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
bind(F<A, Seq<B>>) - Method in class fj.data.Seq
+
+
Bind the given function across this seq.
+
+
bind(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Set
+
+
Binds the given function across this set.
+
+
bind(F<A, State<S, B>>) - Method in class fj.data.State
+
+
Bind the given function across this state.
+
+
bind(F<A, Stream<B>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream with a final join.
+
+
bind(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given stream with a final + join.
+
+
bind(Stream<B>, Stream<C>, F<A, F<B, F<C, D>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, F<A, F<B, F<C, F<D, E>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(Stream<B>, Stream<C>, Stream<D>, Stream<E>, Stream<F$>, Stream<G>, Stream<H>, F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Method in class fj.data.Stream
+
+
Binds the given function across each element of this stream and the given streams with a final + join.
+
+
bind(F<T, Validation<E, A>>) - Method in class fj.data.Validation
+
+
Binds the given function across this validation's success value if it has one.
+
+
bind(F<E, Validation<A, T>>) - Method in class fj.data.Validation.FailProjection
+
+
Binds the given function across this validation's failing value if it has one.
+
+
bind(F<B, F<A, C>>) - Method in interface fj.F
+
+
Binds a given function across this function (Reader Monad).
+
+
bind() - Method in interface fj.F
+
+
First-class function binding.
+
+
bind(F<C, A>, F<A, F<C, B>>) - Static method in class fj.Function
+
+
Binds the function in the second argument to the function in the first argument.
+
+
bind(F<D, A>, F<D, B>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Binds the given function f to the values of the given functions, with a final join.
+
+
bind(F<Unit, F<A, C>>) - Method in interface fj.function.Effect1
+
 
+
bind(F<A, P1<B>>) - Method in class fj.P1
+
+
Binds the given function to the value in a product-1 with a final join.
+
+
bind(P1<B>, F<A, F<B, C>>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
+
Binds the given function to the values in the given P1s with a final join.
+
+
bind(F<A, Parser<I, B, E>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parser with a final join.
+
+
bind(Parser<I, B, E>, F<A, F<B, C>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, F<A, F<B, F<C, D>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, F<A, F<B, F<C, F<D, E$>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, F<A, F<B, F<C, F<D, F<E$, F$>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, G>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, H>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind(Parser<I, B, E>, Parser<I, C, E>, Parser<I, D, E>, Parser<I, E$, E>, Parser<I, F$, E>, Parser<I, G, E>, Parser<I, H, E>, F<A, F<B, F<C, F<D, F<E$, F<F$, F<G, F<H, I$>>>>>>>>) - Method in class fj.parser.Parser
+
+
Binds the given function across the parsers with a final join.
+
+
bind_() - Static method in class fj.control.Trampoline
+
 
+
bind_() - Static method in class fj.data.List
+
+
Provides a first-class version of bind()
+
+
bind_() - Static method in class fj.data.Stream
+
+
A first-class version of the bind function.
+
+
bindProduct(Option<B>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>) - Method in class fj.data.Option
+
 
+
bindProduct(Option<B>, Option<C>, Option<D>, Option<E>, Option<F$>, Option<G>, Option<H>) - Method in class fj.data.Option
+
 
+
BITS_IN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
BitSet - Class in fj.data.hamt
+
+
A sequence of bits representing a value.
+
+
BitSet_List - Static variable in class fj.data.Java
+
+
A function that converts bit sets to lists.
+
+
bitSetSequal - Static variable in class fj.Equal
+
+
An equal instance for the BitSet type.
+
+
bitSetShow - Static variable in class fj.Show
+
 
+
bitsOn() - Method in class fj.data.hamt.BitSet
+
 
+
bitsToRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
bitsUsed() - Method in class fj.data.hamt.BitSet
+
 
+
Boolean_Byte - Static variable in class fj.Primitive
+
+
A function that converts booleans to bytes.
+
+
Boolean_Character - Static variable in class fj.Primitive
+
+
A function that converts booleans to characters.
+
+
Boolean_Double - Static variable in class fj.Primitive
+
+
A function that converts booleans to doubles.
+
+
Boolean_Float - Static variable in class fj.Primitive
+
+
A function that converts booleans to floats.
+
+
Boolean_Integer - Static variable in class fj.Primitive
+
+
A function that converts booleans to integers.
+
+
Boolean_Long - Static variable in class fj.Primitive
+
+
A function that converts booleans to longs.
+
+
Boolean_Short - Static variable in class fj.Primitive
+
+
A function that converts booleans to shorts.
+
+
booleanEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for boolean.
+
+
booleanEqual - Static variable in class fj.Equal
+
+
An equal instance for the boolean type.
+
+
booleanHash - Static variable in class fj.Hash
+
+
A hash instance for the boolean type.
+
+
booleanOrd - Static variable in class fj.Ord
+
+
An order instance for the boolean type.
+
+
Booleans - Class in fj.function
+
+
Curried logical functions.
+
+
booleanShow - Static variable in class fj.Show
+
+
A show instance for the boolean type.
+
+
Bottom - Class in fj
+
+
Represents the bottom _|_ value.
+
+
bottomUp(Tree<A>, F<P2<A, Stream<B>>, B>) - Static method in class fj.data.Tree
+
+
Folds a Tree into a Tree by applying the function f from the bottom of the Tree to the top
+
+
Bounded<A> - Class in fj
+
+
The Bounded class is used to name the upper and lower limits of a type.
+
+
bounded(A, A) - Static method in class fj.Bounded
+
 
+
Bounded.Definition<A> - Interface in fj
+
+
Minimal definition of Bounded
+
+
boundedDef(Bounded.Definition<A>) - Static method in class fj.Bounded
+
 
+
bracket(IO<A>, F<A, IO<B>>, F<A, IO<C>>) - Static method in class fj.data.IOFunctions
+
 
+
breakk(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that does not satisfy + the given predicate and the second element is the remainder of the list.
+
+
Buffer() - Constructor for class fj.data.List.Buffer
+
 
+
bufferedReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
Byte_Boolean - Static variable in class fj.Primitive
+
+
A function that converts bytes to booleans.
+
+
Byte_Character - Static variable in class fj.Primitive
+
+
A function that converts bytes to characters.
+
+
Byte_Double - Static variable in class fj.Primitive
+
+
A function that converts bytes to doubles.
+
+
Byte_Float - Static variable in class fj.Primitive
+
+
A function that converts bytes to floats.
+
+
Byte_Integer - Static variable in class fj.Primitive
+
+
A function that converts bytes to integers.
+
+
Byte_Long - Static variable in class fj.Primitive
+
+
A function that converts bytes to longs.
+
+
Byte_Short - Static variable in class fj.Primitive
+
+
A function that converts bytes to shorts.
+
+
byteEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for byte.
+
+
byteEqual - Static variable in class fj.Equal
+
+
An equal instance for the byte type.
+
+
byteHash - Static variable in class fj.Hash
+
+
A hash instance for the byte type.
+
+
byteOrd - Static variable in class fj.Ord
+
+
An order instance for the byte type.
+
+
byteShow - Static variable in class fj.Show
+
+
A show instance for the byte type.
+
+
+ + + +

C

+
+
callable(A) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that completely preserves the argument.
+
+
callable(Exception) - Static method in class fj.control.parallel.Callables
+
+
Returns a callable that throws the given exception.
+
+
callable() - Static method in class fj.control.parallel.Callables
+
+
Provides a transformation from a value to a Callable that completely preserves that value.
+
+
callable(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Wraps a given function's return value in a Callable.
+
+
Callables - Class in fj.control.parallel
+
+
Monadic functions and conversion methods for java.util.concurrent.Callable.
+
+
callableStrategy(Strategy<Callable<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a normalising strategy that fully evaluates its Callable argument.
+
+
character(F0<E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(E) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a character if one is available or fails with the given error.
+
+
character(F0<E>, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
character(E, F<Character, E>, char) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given character or fails otherwise.
+
+
Character_Boolean - Static variable in class fj.Primitive
+
+
A function that converts characters to booleans.
+
+
Character_Byte - Static variable in class fj.Primitive
+
+
A function that converts characters to bytes.
+
+
Character_Double - Static variable in class fj.Primitive
+
+
A function that converts characters to doubles.
+
+
Character_Float - Static variable in class fj.Primitive
+
+
A function that converts characters to floats.
+
+
Character_Integer - Static variable in class fj.Primitive
+
+
A function that converts characters to integers.
+
+
Character_Long - Static variable in class fj.Primitive
+
+
A function that converts characters to longs.
+
+
Character_Short - Static variable in class fj.Primitive
+
+
A function that converts characters to shorts.
+
+
Characters - Class in fj.function
+
+
First-class functions on Characters.
+
+
characters(F0<E>, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(E, int) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given number of characters, or fails with the given error.
+
+
characters(F0<E>, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
characters(E, F<Character, E>, Stream<Character>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given stream of characters or fails otherwise.
+
+
charAt(int) - Method in class fj.data.LazyString
+
+
Returns the caracter at the specified index.
+
+
charChunkReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with character chunks read from a Reader + (char[] of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charChunkReader2() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with characters read from a Reader + (chars are read in chunks of size IOFunctions.DEFAULT_BUFFER_SIZE).
+
+
charEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for char.
+
+
charEqual - Static variable in class fj.Equal
+
+
An equal instance for the char type.
+
+
charHash - Static variable in class fj.Hash
+
+
A hash instance for the char type.
+
+
charOrd - Static variable in class fj.Ord
+
+
An order instance for the char type.
+
+
charShow - Static variable in class fj.Show
+
+
A show instance for the char type.
+
+
claim() - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
claim(long, TimeUnit) - Method in class fj.control.parallel.Promise
+
+
Waits if necessary for the computation to complete, and then retrieves its result.
+
+
clas() - Method in class fj.Class
+
+
Returns the underlying class.
+
+
clas(Class<T>) - Static method in class fj.Class
+
+
Constructs a class from the given argument.
+
+
Class<T> - Class in fj
+
+
A wrapper for a Class that provides additional methods.
+
+
classParameters() - Method in class fj.Class
+
+
Provides this class's type parameter information as a Tree of the type expression.
+
+
classShow() - Static method in class fj.Show
+
+
A show instance for the Class type.
+
+
clear(int) - Method in class fj.data.hamt.BitSet
+
 
+
clear() - Method in class fj.data.HashMap
+
+
Clear all entries from this hash map.
+
+
clear() - Method in class fj.data.HashSet
+
+
Clear all elements from this hash set.
+
+
closeReader - Static variable in class fj.data.IOFunctions
+
 
+
closeReader(Reader) - Static method in class fj.data.IOFunctions
+
 
+
cobind(F<Promise<A>, B>) - Method in class fj.control.parallel.Promise
+
+
Binds the given function across a promise of this promise (Comonad pattern).
+
+
cobind(F<Stream<A>, B>) - Method in class fj.data.Stream
+
+
Binds the given function across the stream of substreams of this stream.
+
+
cobind(F<Tree<A>, B>) - Method in class fj.data.Tree
+
+
Applies the given function to all subtrees of this tree, returning a tree of the results (comonad pattern).
+
+
cobind(F<TreeZipper<A>, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function over the tree of all positions for this zipper (comonad pattern).
+
+
cobind(F<Zipper<A>, B>) - Method in class fj.data.Zipper
+
+
Maps over variations of this zipper, such that the given function is applied to each variation (comonad pattern).
+
+
cobind(F<P2<A, B>, C>) - Method in class fj.P2
+
+
Duplicates this product on the first element, and maps the given function across the duplicate (Comonad pattern).
+
+
codiagonal() - Static method in class fj.data.optic.Fold
+
 
+
codiagonal() - Static method in class fj.data.optic.Getter
+
 
+
codiagonal() - Static method in class fj.data.optic.Setter
+
 
+
codiagonal() - Static method in class fj.data.optic.Traversal
+
 
+
cojoin() - Method in class fj.control.parallel.Promise
+
+
Duplicates this promise to a promise of itself (Comonad pattern).
+
+
cojoin() - Method in class fj.data.Tree
+
+
Expands this tree into a tree of trees, with this tree as the root label, and subtrees as the labels of + child nodes (comonad pattern).
+
+
Collection_List(Collection<A>) - Static method in class fj.data.Java
+
 
+
Collection_List() - Static method in class fj.data.Java
+
 
+
Collectors - Class in fj.data
+
 
+
comp() - Static method in class fj.data.hlist.HList.Apply
+
+
A function application operator for function composition.
+
+
comparableOrd() - Static method in class fj.Ord
+
+
An order instance for the Comparable interface.
+
+
compare(A, A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare(A) - Method in interface fj.Ord.AltDefinition
+
 
+
compare() - Method in class fj.Ord
+
+
First-class ordering.
+
+
compare(A, A) - Method in class fj.Ord
+
+
Returns an ordering for the given arguments.
+
+
compare(A) - Method in interface fj.Ord.Definition
+
 
+
compare(A, A) - Method in interface fj.Ord.Definition
+
 
+
completionStrategy(CompletionService<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses a CompletionService to control the method and + degree of parallelism, and where each parallel task's completion is registered with the service.
+
+
compose() - Static method in class fj.Function
+
+
Function composition.
+
+
compose(F<B, C>, F<A, B>) - Static method in class fj.Function
+
+
Function composition.
+
+
compose(Monoid<B>) - Method in class fj.Monoid
+
+
Composes this monoid with another.
+
+
compose(Monoid<B>, F<C, A>, F<C, B>, F2<A, B, C>) - Method in class fj.Monoid
+
 
+
compose(Semigroup<B>, F<C, B>, F<C, A>, F2<A, B, C>) - Method in class fj.Semigroup
+
 
+
compose2(F<C, D>, F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function composition.
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Fold
+
+
composeFold(Fold<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Fold
+
+
composeFold(Fold<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Fold
+
+
composeFold(Getter<A, C>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a Getter
+
+
composeGetter(Getter<A, B>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a Getter
+
+
composeGetter(Getter<A, C>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a Getter
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Iso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with an Iso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PIso
+
+
composeIso(PIso<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PIso
+
+
composeIso(Iso<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with an Iso
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Lens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PLens
+
+
composeLens(Lens<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Lens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PLens
+
+
composeLens(PLens<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PLens
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with an Optional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with an POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a POptional
+
+
composeOptional(Optional<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Optional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a POptional
+
+
composeOptional(POptional<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a POptional
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Fold
+
+
compose a Fold with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.Getter
+
+
compose a Getter with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Prism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PPrism
+
+
composePrism(Prism<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Prism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PPrism
+
+
composePrism(PPrism<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PPrism
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Setter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PSetter
+
+
composeSetter(PSetter<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PSetter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Setter
+
+
composeSetter(Setter<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Setter
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Iso
+
+
compose an Iso with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Lens
+
+
compose a Lens with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Optional
+
+
compose a Optional with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PIso
+
+
compose a PIso with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PLens
+
+
compose a PLens with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.POptional
+
+
compose a POptional with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PPrism
+
+
compose a PPrism with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Prism
+
+
compose a Prism with a Traversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PSetter
+
+
compose a PSetter with a PTraversal
+
+
composeTraversal(PTraversal<A, B, C, D>) - Method in class fj.data.optic.PTraversal
+
+
compose a PTraversal with a PTraversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Setter
+
+
compose a Setter with a Traversal
+
+
composeTraversal(Traversal<A, C>) - Method in class fj.data.optic.Traversal
+
+
compose a Traversal with a Traversal
+
+
ConcurrentLinkedQueue_List() - Static method in class fj.data.Java
+
+
A function that converts concurrent linked queues to lists.
+
+
concurry(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a concurrent function.
+
+
concurry(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function of arity-2 to a concurrent function.
+
+
cond() - Static method in class fj.function.Booleans
+
+
Curried form of conditional.
+
+
condition(boolean, E, T) - Static method in class fj.data.Validation
+
+
Returns a validation based on a boolean condition.
+
+
conjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ANDs booleans.
+
+
conjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ANDs booleans.
+
+
connect() - Method in class fj.control.db.Connector
+
 
+
Connector - Class in fj.control.db
+
+
A method of connecting to the database.
+
+
Connector() - Constructor for class fj.control.db.Connector
+
 
+
cons(A) - Method in class fj.data.DList
+
+
Prepends a single element on the DList to produce a new DList.
+
+
cons(A) - Method in class fj.data.fingertrees.Deep
+
 
+
cons(A) - Method in class fj.data.fingertrees.Empty
+
 
+
cons(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the first element.
+
+
cons(A) - Method in class fj.data.fingertrees.Single
+
 
+
cons() - Static method in class fj.data.hlist.HList.Apply
+
+
An operator for the construction of heterogeneous lists.
+
+
cons(E, L) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of an element and another list.
+
+
cons(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
cons() - Static method in class fj.data.List
+
+
Returns a function that prepends (cons) an element to a list to produce a new list.
+
+
cons(List<A>) - Static method in class fj.data.List
+
+
Returns a function that prepends a value to the given list.
+
+
cons(A, List<A>) - Static method in class fj.data.List
+
+
Prepends the given head element to the given tail element to produce a new list.
+
+
cons() - Static method in class fj.data.List.Optic
+
+
Cons prism
+
+
cons(A) - Method in class fj.data.NonEmptyList
+
+
Prepend the given value to this list.
+
+
cons(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the front of this sequence.
+
+
cons(A) - Method in class fj.data.Stream
+
+
Prepends (cons) the given element to this stream to product a new stream.
+
+
cons() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
cons(A, F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Prepends the given head element to the given tail element to produce a new stream.
+
+
cons(P1<A>, V2<A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a head and a tail.
+
+
cons(P1<A>, V3<A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a head and a tail.
+
+
cons(P1<A>, V4<A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a head and a tail.
+
+
cons(P1<A>, V5<A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a head and a tail.
+
+
cons(P1<A>, V6<A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a head and a tail.
+
+
cons(P1<A>, V7<A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a head and a tail.
+
+
cons_() - Static method in class fj.data.List
+
 
+
cons_(A) - Static method in class fj.data.List
+
+
Returns a function that prepends the given value to a list.
+
+
cons_() - Static method in class fj.data.Stream
+
+
Returns a function that prepends (cons) an element to a stream to produce a new stream.
+
+
conss(A) - Method in class fj.data.List
+
+
Prepends (cons) the given element to this list to product a new list.
+
+
constant(B) - Static method in class fj.data.$
+
 
+
constant(B) - Static method in class fj.data.Reader
+
 
+
constant(A) - Static method in class fj.data.State
+
 
+
constant() - Static method in class fj.Function
+
+
Returns a function that given an argument, returns a function that ignores its argument.
+
+
constant(B) - Static method in class fj.Function
+
+
Returns a function that ignores its argument to constantly produce the given value.
+
+
constant() - Method in class fj.P1
+
+
Returns a constant function that always uses this value.
+
+
Consumer_F() - Static method in class fj.data.Java8
+
 
+
Consumer_F(Consumer<A>) - Static method in class fj.data.Java8
+
 
+
cont(F<Iteratee.Input<E>, Iteratee.IterV<E, A>>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that takes an element from an input to yield a new computation
+
+
contains(K) - Method in class fj.data.HashMap
+
+
Determines if the given key value exists in this hash map.
+
+
contains(A) - Method in class fj.data.HashSet
+
+
Determines if this hash set contains the given element.
+
+
contains(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a substring of this lazy string.
+
+
contains(K) - Method in class fj.data.PriorityQueue
+
+
Does the priority k exist already?
+
+
contains(K) - Method in class fj.data.TreeMap
+
+
Determines if the given key value exists in this tree map.
+
+
contains - Static variable in class fj.function.Strings
+
+
A curried version of String.contains(CharSequence).
+
+
contramap(F<B, A>) - Method in class fj.control.parallel.Actor
+
+
Contravariant functor pattern.
+
+
contramap(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's codomain (Invariant Functor pattern).
+
+
contramap(Effect1<A>, F<B, A>) - Static method in class fj.Effect
+
+
A contra-variant functor on effect.
+
+
contramap(F<B, A>) - Method in class fj.Equal
+
+
Maps the given function across this equal as a contra-variant functor.
+
+
contramap(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Static version of Equal.contramap(F)
+
+
contramap(F<C, A>) - Method in interface fj.F
+
 
+
contramap(F<X, A>, F<Y, B>) - Method in interface fj.F2
+
 
+
contramap(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
maps given function to the predicate function
+
+
contramap(F<C, A>) - Method in interface fj.function.Effect1
+
 
+
contramap(F<B, A>) - Method in class fj.Hash
+
+
Maps the given function across this hash as a contra-variant functor.
+
+
contramap(F<B, A>) - Method in class fj.Ord
+
+
Maps the given function across this ord as a contra-variant functor.
+
+
contramap(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Static version of Ord.contramap(F)
+
+
contramap(F<B, A>) - Method in class fj.Show
+
+
Maps the given function across this show as a contra-variant functor.
+
+
contramapActor() - Method in interface fj.F
+
+
Returns a function that contramaps over a given actor.
+
+
contramapEqual() - Method in interface fj.F
+
+
Promotes this function to map over an Equal as a contravariant functor.
+
+
contramapFirst(F<Z, A>) - Method in interface fj.F2
+
 
+
contramapHash() - Method in interface fj.F
+
+
Promotes this function to map over a Hash as a contravariant functor.
+
+
contramapSecond(F<Z, B>) - Method in interface fj.F2
+
 
+
contramapShow() - Method in interface fj.F
+
+
Promotes this function to map over a Show as a contravariant functor.
+
+
Conversions - Class in fj.data
+
+
Functions that convert between data structure types.
+
+
copyOf(U[], int, Class<? extends T[]>) - Static method in class fj.data.Array
+
 
+
copyOf(T[], int) - Static method in class fj.data.Array
+
 
+
copyOfRange(char[], int, int) - Static method in class fj.data.Array
+
 
+
CopyOnWriteArrayList_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array lists to lists.
+
+
CopyOnWriteArraySet_List() - Static method in class fj.data.Java
+
+
A function that converts copy on write array sets to lists.
+
+
curry() - Method in interface fj.F2
+
+
Curries this wrapped function to a wrapped function of arity-1 that returns another wrapped function.
+
+
curry(F2<A, B, C>) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F2<A, B, C>, A) - Static method in class fj.Function
+
+
Curry a function of arity-2.
+
+
curry(F3<A, B, C, D>) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F3<A, B, C, D>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-3.
+
+
curry(F4<A, B, C, D, E>) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F4<A, B, C, D, E>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-4.
+
+
curry(F5<A, B, C, D, E, F$>) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F5<A, B, C, D, E, F$>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-5.
+
+
curry(F6<A, B, C, D, E, F$, G>) - Static method in class fj.Function
+
+
Curry a function of arity-6.
+
+
curry(F7<A, B, C, D, E, F$, G, H>) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F7<A, B, C, D, E, F$, G, H>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$) - Static method in class fj.Function
+
+
Curry a function of arity-8.
+
+
curry(F8<A, B, C, D, E, F$, G, H, I>, A, B, C, D, E, F$, G) - Static method in class fj.Function
+
+
Curry a function of arity-7.
+
+
curry(F<A, B>) - Static method in class fj.P1
+
+
Promotes the given function so that it returns its value in a P1.
+
+
cycle(Stream<A>) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given elements cycling.
+
+
cycleNext() - Method in class fj.data.Zipper
+
+
Move the focus to the next element.
+
+
cyclePrevious() - Method in class fj.data.Zipper
+
+
Move the focus to the previous element.
+
+
+ + + +

D

+
+
DB<A> - Class in fj.control.db
+
+
The DB monad represents a database action, or a value within the context of a database connection.
+
+
DB() - Constructor for class fj.control.db.DB
+
 
+
db(F<Connection, A>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
db(Try1<Connection, A, SQLException>) - Static method in class fj.control.db.DB
+
+
Constructs a database action as a function from a database connection to a value.
+
+
DbState - Class in fj.control.db
+
+
Performs database I/O, in order to read or write the database state.
+
+
decons(A, Show<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
decons(Class<A>) - Static method in class fj.Bottom
+
+
Represents a deconstruction failure that was non-exhaustive.
+
+
Deep<V,A> - Class in fj.data.fingertrees
+
+
A finger tree with 1-4-digits on the left and right, and a finger tree of 2-3-nodes in the middle.
+
+
deep(Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree.
+
+
deep(V, Digit<V, A>, FingerTree<V, Node<V, A>>, Digit<V, A>) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a deep tree with the given annotation value.
+
+
defer(F0<Eval<A>>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation of an expression that produces Eval.
+
+
defined(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
defined(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a defined character.
+
+
DelayQueue_List() - Static method in class fj.data.Java
+
+
A function that converts delay queues to lists.
+
+
delete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key.
+
+
delete(A) - Method in class fj.data.HashSet
+
+
Deletes the given element from this hash set.
+
+
delete(A, Equal<A>) - Method in class fj.data.List
+
+
Removes the first element that equals the given object.
+
+
delete(int) - Method in class fj.data.Seq
+
+
Delete the element at the given index.
+
+
delete(A) - Method in class fj.data.Set
+
+
Deletes the given element from this set.
+
+
delete() - Method in class fj.data.Set
+
+
First-class deletion function.
+
+
delete(K) - Method in class fj.data.TreeMap
+
+
Deletes the entry in the tree map that corresponds to the given key.
+
+
delete() - Method in class fj.data.TreeZipper
+
+
Removes the current node from the tree.
+
+
deleteLeft() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the left into focus.
+
+
deleteLeftCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the left into focus.
+
+
deleteOthers() - Method in class fj.data.Zipper
+
+
Deletes all elements in the zipper except the focus.
+
+
deleteRight() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then moves the element on the right into focus.
+
+
deleteRightCycle() - Method in class fj.data.Zipper
+
+
Possibly deletes the element at the focus, then move the element on the right into focus.
+
+
dequeue() - Method in class fj.data.PriorityQueue
+
+
Removes the node with the highest priority.
+
+
dequeue(int) - Method in class fj.data.PriorityQueue
+
+
Removes the top n elements with the highest priority.
+
+
Digit<V,A> - Class in fj.data.fingertrees
+
+
A digit is a vector of 1-4 elements.
+
+
Digit - Enum in fj
+
+
The digits zero to nine.
+
+
digit - Static variable in class fj.function.Characters
+
 
+
digit(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digit(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a digit (0 to 9).
+
+
digitMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for digits.
+
+
digitShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
dimap(F<C, A>, F<B, D>) - Method in interface fj.F
+
+
Both map (with g) and contramap (with f) the target function.
+
+
dimap(F<C, A>, F<Unit, D>) - Method in interface fj.function.Effect1
+
 
+
discard() - Static method in class fj.control.parallel.Strategy
+
+
Returns an Effect that waits for a given Future to obtain a value, discarding the value.
+
+
disjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that ORs booleans.
+
+
disjunctionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that ORs booleans.
+
+
divide - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first.
+
+
divide(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another.
+
+
divmod - Static variable in class fj.data.Natural
+
+
A function that divides its second argument by its first, yielding both the quotient and the remainder.
+
+
divmod(Natural) - Method in class fj.data.Natural
+
+
Divide a natural number by another yielding both the quotient and the remainder.
+
+
DList<A> - Class in fj.data
+
+
Difference List.
+
+
dlist(F<List<A>, Trampoline<List<A>>>) - Static method in class fj.data.DList
+
+
Creates a DList from the function + + For alternatives functions to create a DList:
+
+
done(A, Iteratee.Input<E>) - Static method in class fj.data.Iteratee.IterV
+
+
A computation that has finished
+
+
Double_Boolean - Static variable in class fj.Primitive
+
+
A function that converts doubles to booleans.
+
+
Double_Byte - Static variable in class fj.Primitive
+
+
A function that converts doubles to bytes.
+
+
Double_Character - Static variable in class fj.Primitive
+
+
A function that converts doubles to characters.
+
+
Double_Float - Static variable in class fj.Primitive
+
+
A function that converts doubles to floats.
+
+
Double_Integer - Static variable in class fj.Primitive
+
+
A function that converts doubles to integers.
+
+
Double_Long - Static variable in class fj.Primitive
+
+
A function that converts doubles to longs.
+
+
Double_Short - Static variable in class fj.Primitive
+
+
A function that converts doubles to shorts.
+
+
doubleEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for double.
+
+
doubleEqual - Static variable in class fj.Equal
+
+
An equal instance for the double type.
+
+
doubleHash - Static variable in class fj.Hash
+
+
A hash instance for the double type.
+
+
doubleOrd - Static variable in class fj.Ord
+
+
An order instance for the double type.
+
+
Doubles - Class in fj.function
+
+
Curried functions over Doubles.
+
+
doubleShow - Static variable in class fj.Show
+
+
A show instance for the double type.
+
+
doubleValue() - Method in class fj.data.Natural
+
+
Return the double value of this natural number.
+
+
draw(Show<A>) - Method in class fj.data.Tree
+
+
Draws a 2-dimensional representation of a tree.
+
+
driverManager(String) - Static method in class fj.control.db.DbState
+
+
A simple connector (the default) that gets connections to the given database URL from the driver manager.
+
+
drop(int) - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that skips the first n elements of the input
+
+
drop(int) - Method in class fj.data.List
+
+
Drops the given number of elements from the head of this list if they are available.
+
+
drop(int) - Method in class fj.data.Seq
+
+
Drops the given number of elements from the head of this sequence if they are available.
+
+
drop(int) - Method in class fj.data.Stream
+
+
Drops the given number of elements from the head of this stream if they are available.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Removes elements from the head of this list that do not match the given predicate function + until an element is found that does match or the list is exhausted.
+
+
dropWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Removes elements from the head of this stream that do not match the given predicate function + until an element is found that does match or the stream is exhausted.
+
+
dual() - Method in interface fj.Monoid.Definition
+
 
+
dual() - Method in class fj.Monoid
+
+
Swaps the arguments when summing.
+
+
dual() - Method in interface fj.Ord.Definition
+
 
+
dual() - Method in interface fj.Semigroup.Definition
+
 
+
dual() - Method in class fj.Semigroup
+
+
Swaps the arguments when summing.
+
+
duplicate() - Method in class fj.P2
+
+
Duplicates this product into the first element (Comonad pattern).
+
+
+ + + +

E

+
+
effect(Effect1<A>) - Method in class fj.control.parallel.ParModule
+
+
Creates a very fast concurrent effect, as an actor that does not guarantee ordering of its messages.
+
+
effect() - Method in class fj.control.parallel.ParModule
+
+
A first-class constructor of concurrent effects, as actors that don't guarantee ordering of messages.
+
+
Effect - Class in fj
+
+
Represents a side-effect.
+
+
Effect0 - Interface in fj.function
+
 
+
Effect0_P1() - Static method in class fj.data.Conversions
+
 
+
Effect0_P1(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect1<A> - Interface in fj.function
+
 
+
Effect1_F(Effect1<A>) - Static method in class fj.data.Conversions
+
 
+
Effect1_F() - Static method in class fj.data.Conversions
+
 
+
Effect2<A,B> - Interface in fj.function
+
 
+
Effect3<A,B,C> - Interface in fj.function
+
 
+
Effect4<A,B,C,D> - Interface in fj.function
+
 
+
Effect5<A,B,C,D,E> - Interface in fj.function
+
 
+
Effect6<A,B,C,D,E,F> - Interface in fj.function
+
 
+
Effect7<A,B,C,D,E,F,G> - Interface in fj.function
+
 
+
Effect8<A,B,C,D,E,F,G,H> - Interface in fj.function
+
 
+
Effect_IO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_IO() - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO(Effect0) - Static method in class fj.data.Conversions
+
 
+
Effect_SafeIO() - Static method in class fj.data.Conversions
+
 
+
either(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into either an exception or the value in the Callable.
+
+
either() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an Either.
+
+
Either<A,B> - Class in fj.data
+
+
The Either type represents a value of one of two possible types (a disjoint union).
+
+
either(F<A, X>, F<B, X>) - Method in class fj.data.Either
+
+
The catamorphism for either.
+
+
either() - Method in class fj.data.Either.LeftProjection
+
+
The either value underlying this projection.
+
+
either() - Method in class fj.data.Either.RightProjection
+
+
The either value underlying this projection.
+
+
either(F<A, D>, F<B, D>, F<C, D>) - Method in class fj.data.Either3
+
 
+
either() - Method in class fj.data.Either3.LeftProjection
+
 
+
either() - Method in class fj.data.Either3.MiddleProjection
+
 
+
either() - Method in class fj.data.Either3.RightProjection
+
 
+
either() - Static method in class fj.data.Validation
+
+
Returns a function that constructs an either with a validation.
+
+
Either.LeftProjection<A,B> - Class in fj.data
+
+
A left projection of an either value.
+
+
Either.RightProjection<A,B> - Class in fj.data
+
+
A right projection of an either value.
+
+
Either3<A,B,C> - Class in fj.data
+
 
+
Either3.LeftProjection<A,B,C> - Class in fj.data
+
 
+
Either3.MiddleProjection<A,B,C> - Class in fj.data
+
 
+
Either3.RightProjection<A,B,C> - Class in fj.data
+
 
+
either3Equal(Equal<A>, Equal<B>, Equal<C>) - Static method in class fj.Equal
+
 
+
either3Hash(Hash<A>, Hash<B>, Hash<C>) - Static method in class fj.Hash
+
 
+
either3Show(Show<A>, Show<B>, Show<C>) - Static method in class fj.Show
+
 
+
either_(F<A, X>, F<B, X>) - Static method in class fj.data.Either
+
+
First class catamorphism for either.
+
+
either_(F<A, D>, F<B, D>, F<C, D>) - Static method in class fj.data.Either3
+
 
+
Either_ArrayA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to arrays.
+
+
Either_ArrayBlockingQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayBlockingQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to array blocking queues.
+
+
Either_ArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_ArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to array lists.
+
+
Either_BitSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_BitSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to bit sets.
+
+
Either_ConcurrentLinkedQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_ConcurrentLinkedQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to concurrent linked queues.
+
+
Either_CopyOnWriteArrayListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArrayListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array lists.
+
+
Either_CopyOnWriteArraySetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_CopyOnWriteArraySetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to copy on write array sets.
+
+
Either_DelayQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_DelayQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to delay queues.
+
+
Either_EnumSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_EnumSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to enum sets.
+
+
Either_HashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_HashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to hash sets.
+
+
Either_LinkedBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked blocking queues.
+
+
Either_LinkedHashSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedHashSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked hash sets.
+
+
Either_LinkedListA() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_LinkedListB() - Static method in class fj.data.Java
+
+
A function that converts eithers to linked lists.
+
+
Either_ListA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_ListB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to lists.
+
+
Either_OptionA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_OptionB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to options.
+
+
Either_PriorityBlockingQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_PriorityBlockingQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority blocking queues.
+
+
Either_StackA() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StackB() - Static method in class fj.data.Java
+
+
A function that converts eithers to stacks.
+
+
Either_StreamA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StreamB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to streams.
+
+
Either_StringA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to strings.
+
+
Either_StringBufferA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBufferB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string buffers.
+
+
Either_StringBuilderA() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_StringBuilderB() - Static method in class fj.data.Conversions
+
+
A function that converts eithers to string builders.
+
+
Either_SynchronousQueueA(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_SynchronousQueueB(boolean) - Static method in class fj.data.Java
+
+
A function that converts eithers to synchronous queues.
+
+
Either_TreeSetA() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_TreeSetB() - Static method in class fj.data.Java
+
+
A function that converts eithers to tree sets.
+
+
Either_VectorA() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
Either_VectorB() - Static method in class fj.data.Java
+
+
A function that converts eithers to vectors.
+
+
eitherEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Either type.
+
+
eitherHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Either type.
+
+
eitherLeftK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result on the left side of an Either.
+
+
eitherOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Either type.
+
+
eitherRightK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result on the right side of an Either.
+
+
eitherShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Either type.
+
+
el(E) - Static method in class fj.data.Iteratee.Input
+
+
Input that has a value available
+
+
element(F0<E>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
element(E) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream if it is available and fails otherwise.
+
+
elementIndex(Equal<A>, A) - Method in class fj.data.List
+
+
Returns the index of the first element in this list which is equal (by the given equality) to the + query element, or None if there is no such element.
+
+
eMessage() - Static method in class fj.Bottom
+
+
A function that returns the getMessage for a throwable.
+
+
empty() - Static method in class fj.data.Array
+
+
Returns an empty array.
+
+
Empty<V,A> - Class in fj.data.fingertrees
+
+
The empty tree.
+
+
empty(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Creates an empty finger tree with elements of type A and node annotations + of type V.
+
+
empty() - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs an empty tree.
+
+
EMPTY - Static variable in class fj.data.hamt.BitSet
+
 
+
empty() - Static method in class fj.data.hamt.BitSet
+
 
+
empty(Equal<K>, Hash<K>) - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Creates an empty trie.
+
+
empty(Equal<A>, Hash<A>) - Static method in class fj.data.HashSet
+
+
Creates a new HashSet using the given Equal and Hash
+
+
empty() - Static method in class fj.data.HashSet
+
+
Creates an empty HashSet
+
+
empty() - Static method in class fj.data.Iteratee.Input
+
+
Input that has no values available
+
+
empty - Static variable in class fj.data.LazyString
+
+
The empty string.
+
+
empty() - Static method in class fj.data.List.Buffer
+
+
An empty buffer.
+
+
empty(Monoid<K>, Equal<K>) - Static method in class fj.data.PriorityQueue
+
+
Creates an empty priority queue.
+
+
empty() - Static method in class fj.data.Seq
+
+
The empty sequence.
+
+
empty(Ord<A>) - Static method in class fj.data.Set
+
+
The empty set.
+
+
empty(Ord<K>) - Static method in class fj.data.TreeMap
+
+
Constructs an empty tree map.
+
+
empty() - Method in interface fj.Monoid.Definition
+
 
+
emptyInt() - Static method in class fj.data.PriorityQueue
+
+
An empty priority queue with integer priorities.
+
+
emptyIntAddition() - Static method in class fj.data.fingertrees.FingerTree
+
 
+
emptyIntMax() - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a finger tree which combines the integer node annotations with the + maximum function.
+
+
emptyKeyInteger() - Static method in class fj.data.hamt.HashArrayMappedTrie
+
+
Create and empty trie keyed by integer.
+
+
endsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a suffix of this lazy string.
+
+
enqueue(K, A) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enqueue(List<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the list of products with priority k and value a.
+
+
enqueue(Iterable<P2<K, A>>) - Method in class fj.data.PriorityQueue
+
+
Adds nodes using the iterable of products with priority k and value a.
+
+
enqueue(P2<K, A>) - Method in class fj.data.PriorityQueue
+
+
Adds a node with priority k and value a.
+
+
enumerationStream(Enumeration<A>) - Static method in class fj.data.Stream
+
 
+
Enumerator<A> - Class in fj.data
+
+
Abstracts over a type that may have a successor and/or predecessor value.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>, F<A, F<Long, Option<A>>>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumerator(F<A, Option<A>>, F<A, Option<A>>, Option<A>, Option<A>, Ord<A>) - Static method in class fj.data.Enumerator
+
+
Construct an enumerator.
+
+
enumFileCharChunks(File, Option<Charset>, Iteratee.IterV<char[], A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes them to the given iteratee.
+
+
enumFileChars(File, Option<Charset>, Iteratee.IterV<Character, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads char chunks from the given file and passes single chars to the given iteratee.
+
+
enumFileLines(File, Option<Charset>, Iteratee.IterV<String, A>) - Static method in class fj.data.IOFunctions
+
+
An IO monad that reads lines from the given file (using a BufferedReader) and passes + lines to the provided iteratee.
+
+
EnumSet_List() - Static method in class fj.data.Java
+
+
A function that converts enum sets to lists.
+
+
eof() - Static method in class fj.data.Iteratee.Input
+
+
Input that is exhausted
+
+
eq(K, K) - Method in class fj.data.HashMap
+
+
Compare two key values for equality using the underlying equality strategy.
+
+
eq(A, A) - Method in class fj.data.HashSet
+
+
Compare two values for equality using the underlying equality strategy.
+
+
eq(HPre.HZero, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is equal to itself.
+
+
eq(HPre.HZero, HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HZero) - Static method in class fj.data.hlist.HPre.HEq
+
+
Zero is not equal to anything other than zero.
+
+
eq(HPre.HSucc<N>, HPre.HSucc<NN>, E) - Static method in class fj.data.hlist.HPre.HEq
+
+
A number is equal to another if their predecessors are equal.
+
+
eq(Equal<A>) - Static method in class fj.data.TreeZipper
+
+
An Equal instance for tree zippers.
+
+
eq(Equal<A>) - Static method in class fj.data.Zipper
+
+
An Equal instance for Zippers.
+
+
eq - Static variable in class fj.Equal
+
+
An equal instance for lazy strings.
+
+
eq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are equal, false otherwise.
+
+
eq() - Method in class fj.Equal
+
+
First-class equality check.
+
+
eq(A) - Method in class fj.Equal
+
+
Partially applied equality check.
+
+
eq(A, A) - Method in class fj.Ord
+
+
Returns true if the given arguments are equal, false otherwise.
+
+
Equal<A> - Class in fj
+
+
Tests for equality between two objects.
+
+
equal(A, A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.AltDefinition
+
 
+
equal(A) - Method in interface fj.Equal.Definition
+
 
+
equal(A, A) - Method in interface fj.Equal.Definition
+
 
+
equal() - Method in interface fj.Equal.Definition
+
+
Build an equal instance from this definition.
+
+
equal(F<A, F<A, Boolean>>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(F2<A, A, Boolean>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given function.
+
+
equal(A, A) - Method in interface fj.Ord.Definition
+
 
+
equal(A) - Method in interface fj.Ord.Definition
+
 
+
equal() - Method in class fj.Ord
+
+
Returns an Equal for this order.
+
+
Equal.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Equal: alternative minimal definition and overridable methods.
+
+
Equal.Definition<A> - Interface in fj
+
+
Primitives functions of Equal: minimal definition and overridable methods.
+
+
equalDef(Equal.Definition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given definition.
+
+
equalDef(Equal.AltDefinition<A>) - Static method in class fj.Equal
+
+
Constructs an equal instance from the given (alternative) definition.
+
+
equals(Object) - Method in class fj.data.Array
+
 
+
equals(Object) - Method in class fj.data.Either
+
 
+
equals(Object) - Method in class fj.data.Either3
+
 
+
equals(Object) - Method in class fj.data.hamt.BitSet
+
 
+
equals(Object) - Method in class fj.data.List
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Natural
+
 
+
equals(Object) - Method in class fj.data.NonEmptyList
+
+
Perform an equality test on this list which delegates to the .equals() method of the member instances.
+
+
equals(Object) - Method in class fj.data.Option
+
 
+
equals(Object) - Method in class fj.data.Seq
+
 
+
equals(Object) - Method in class fj.data.Set
+
 
+
equals(Object) - Method in class fj.data.Stream
+
 
+
equals(Object) - Method in class fj.data.Tree
+
 
+
equals(Object) - Method in class fj.data.TreeMap
+
 
+
equals(Object) - Method in class fj.data.TreeZipper
+
 
+
equals(Object) - Method in class fj.data.Validation
+
 
+
equals(Object) - Method in class fj.data.vector.V2
+
 
+
equals(Object) - Method in class fj.data.vector.V3
+
 
+
equals(Object) - Method in class fj.data.vector.V4
+
 
+
equals(Object) - Method in class fj.data.vector.V5
+
 
+
equals(Object) - Method in class fj.data.vector.V6
+
 
+
equals(Object) - Method in class fj.data.vector.V7
+
 
+
equals(Object) - Method in class fj.data.vector.V8
+
 
+
equals(Object) - Method in class fj.data.Zipper
+
 
+
equals(Object) - Method in class fj.P1
+
 
+
equals(Object) - Method in class fj.P2
+
 
+
equals(Object) - Method in class fj.P3
+
 
+
equals(Object) - Method in class fj.P4
+
 
+
equals(Object) - Method in class fj.P5
+
 
+
equals(Object) - Method in class fj.P6
+
 
+
equals(Object) - Method in class fj.P7
+
 
+
equals(Object) - Method in class fj.P8
+
 
+
equals(Object) - Method in class fj.parser.Result
+
 
+
equals0(Class<? super A>, A, Object, Equal<A>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
equals0(Class<? super A>, A, Object, F0<Equal<A>>) - Static method in class fj.Equal
+
+
Helper method to implement Object.equals(Object) correctly.
+
+
error(String) - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation with early failure using the given + message.
+
+
error_(String) - Static method in class fj.Bottom
+
+
Provides a thunk that throws an error using the given message when evaluated.
+
+
errorF(String) - Static method in class fj.Bottom
+
+
Provides a function that throws an error using the given message, ignoring its argument.
+
+
errorStrategy(Effect1<Error>) - Method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
errorStrategy(Strategy<A>, Effect1<Error>) - Static method in class fj.control.parallel.Strategy
+
+
Provides an error-handling strategy.
+
+
eToString() - Static method in class fj.Bottom
+
+
A function that returns the toString for a throwable.
+
+
Eval<A> - Class in fj.data
+
+
Eval is an abstraction over different models of evaluation.
+
+
Eval() - Constructor for class fj.data.Eval
+
 
+
eval() - Method in class fj.data.LazyString
+
 
+
eval(S) - Method in class fj.data.State
+
 
+
even - Static variable in class fj.function.Doubles
+
+
Evenness.
+
+
even - Static variable in class fj.function.Integers
+
+
Evenness.
+
+
exclusiveDisjunctionMonoid - Static variable in class fj.Monoid
+
+
A monoid that XORs booleans.
+
+
exclusiveDisjunctionSemiGroup - Static variable in class fj.Semigroup
+
+
A semigroup that XORs booleans.
+
+
exec(S) - Method in class fj.data.State
+
 
+
executorStrategy(ExecutorService) - Static method in class fj.control.parallel.Strategy
+
+
Provides a parallelization strategy that uses an ExecutorService to control the method and + degree of parallelism.
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
check if at least one target satisfies the predicate
+
+
exist(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
check if at least one target satisfies the predicate
+
+
exists(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for at least one of the elements of this + array, false otherwise (false for the empty array).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns false if no value or returns the result of the application of the given + function to the value.
+
+
exists(F<A, Boolean>) - Method in class fj.data.Either3.LeftProjection
+
 
+
exists(F<B, Boolean>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
exists(F<C, Boolean>) - Method in class fj.data.Either3.RightProjection
+
 
+
exists(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for at least one of the elements of this list, + false otherwise (false for the empty list).
+
+
exists(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true is this optional value has a value and the given predicate function + holds on that value, false otherwise.
+
+
exists(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for at least one of the elements of this + stream, false otherwise (false for the empty stream).
+
+
exists(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns false if this is a failure or returns the result of the application of the given + function to the success value.
+
+
exists(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns false if this is a success or returns the result of the application of the given + function to the failing value.
+
+
extend(E) - Method in class fj.data.hlist.HList
+
+
Extends (cons) this list by prepending the given element, returning a new list.
+
+
extend(X) - Method in class fj.data.hlist.HList.HCons
+
 
+
extend(E) - Method in class fj.data.hlist.HList.HNil
+
 
+
extender() - Method in class fj.data.hlist.HList
+
 
+
extender() - Method in class fj.data.hlist.HList.HCons
+
 
+
extender() - Method in class fj.data.hlist.HList.HNil
+
 
+
+ + + +

F

+
+
f() - Method in class fj.control.parallel.Strategy
+
+
Returns the functional representation of this Strategy, a function that evaluates a product-1.
+
+
f() - Static method in class fj.data.hlist.HList.Apply
+
+
Function application operator.
+
+
f() - Method in interface fj.data.IO
+
 
+
f(A) - Method in class fj.data.Reader
+
 
+
f() - Method in interface fj.data.SafeIO
+
 
+
f() - Method in class fj.data.Validation
+
+
Returns a failing projection of this validation.
+
+
f(Effect0) - Static method in class fj.Effect
+
 
+
f(Effect1<A>) - Static method in class fj.Effect
+
+
Returns a function for the given effect.
+
+
f(Effect2<A, B>) - Static method in class fj.Effect
+
 
+
f(Effect3<A, B, C>) - Static method in class fj.Effect
+
 
+
f(Effect4<A, B, C, D>) - Static method in class fj.Effect
+
 
+
f(Effect5<A, B, C, D, E>) - Static method in class fj.Effect
+
 
+
f(Effect6<A, B, C, D, E, $F>) - Static method in class fj.Effect
+
 
+
f(Effect7<A, B, C, D, E, $F, G>) - Static method in class fj.Effect
+
 
+
f(Effect8<A, B, C, D, E, $F, G, H>) - Static method in class fj.Effect
+
 
+
F<A,B> - Interface in fj
+
+
A transformation or function from A to B.
+
+
f(A) - Method in interface fj.F
+
+
Transform A to B.
+
+
f() - Method in interface fj.F0
+
 
+
f(A, B) - Method in interface fj.F2
+
+
Transform A and B to C.
+
+
f(A) - Method in interface fj.F2
+
+
Partial application.
+
+
f(A, B, C) - Method in interface fj.F3
+
+
Transform A, B and C to D.
+
+
f(A, B, C, D) - Method in interface fj.F4
+
+
Transform A, B, C and D to E.
+
+
f(A, B, C, D, E) - Method in interface fj.F5
+
+
Transform A, B, C, D and E to + F$.
+
+
f(A, B, C, D, E, F$) - Method in interface fj.F6
+
+
Transform A, B, C, D, E and + F$ to G.
+
+
f(A, B, C, D, E, F$, G) - Method in interface fj.F7
+
+
Transform A, B, C, D, E, + F$ and G to H.
+
+
f(A, B, C, D, E, F$, G, H) - Method in interface fj.F8
+
+
Transform A, B, C, D, E, + F$, G and H to I.
+
+
f() - Method in interface fj.function.Effect0
+
 
+
f(A) - Method in interface fj.function.Effect1
+
 
+
f(A, B) - Method in interface fj.function.Effect2
+
 
+
f(A, B, C) - Method in interface fj.function.Effect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Effect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Effect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Effect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Effect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Effect8
+
 
+
f() - Method in interface fj.function.Try0
+
 
+
f(A) - Method in interface fj.function.Try1
+
 
+
f(A, B) - Method in interface fj.function.Try2
+
 
+
f(A, B, C) - Method in interface fj.function.Try3
+
 
+
f(A, B, C, D) - Method in interface fj.function.Try4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.Try5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.Try6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.Try7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.Try8
+
 
+
f() - Method in interface fj.function.TryEffect0
+
 
+
f(A) - Method in interface fj.function.TryEffect1
+
 
+
f(A, B) - Method in interface fj.function.TryEffect2
+
 
+
f(A, B, C) - Method in interface fj.function.TryEffect3
+
 
+
f(A, B, C, D) - Method in interface fj.function.TryEffect4
+
 
+
f(A, B, C, D, E) - Method in interface fj.function.TryEffect5
+
 
+
f(A, B, C, D, E, F) - Method in interface fj.function.TryEffect6
+
 
+
f(A, B, C, D, E, F, G) - Method in interface fj.function.TryEffect7
+
 
+
f(A, B, C, D, E, F, G, H) - Method in interface fj.function.TryEffect8
+
 
+
f() - Method in class fj.P1
+
 
+
f(Try0<A, E>) - Static method in class fj.Try
+
+
Promotes the Try0 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try1<A, B, E>) - Static method in class fj.Try
+
+
Promotes the Try1 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try2<A, B, C, E>) - Static method in class fj.Try
+
+
Promotes the Try2 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try3<A, B, C, D, E>) - Static method in class fj.Try
+
+
Promotes the Try3 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try4<A, B, C, D, E, Z>) - Static method in class fj.Try
+
+
Promotes the Try4 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try5<A, B, C, D, E, F, Z>) - Static method in class fj.Try
+
+
Promotes the Try5 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try6<A, B, C, D, E, F, G, Z>) - Static method in class fj.Try
+
+
Promotes the Try6 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try7<A, B, C, D, E, F, G, H, Z>) - Static method in class fj.Try
+
+
Promotes the Try7 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(Try8<A, B, C, D, E, F, G, H, I, Z>) - Static method in class fj.Try
+
+
Promotes the Try8 to a Validation that returns an Exception on the failure side and its result on the success side.
+
+
f(TryEffect0<Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect1<A, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect2<A, B, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect3<A, B, C, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect4<A, B, C, D, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect5<A, B, C, D, E, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect6<A, B, C, D, E, $F, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect7<A, B, C, D, E, $F, G, Z>) - Static method in class fj.TryEffect
+
 
+
f(TryEffect8<A, B, C, D, E, $F, G, H, Z>) - Static method in class fj.TryEffect
+
 
+
F0<A> - Interface in fj
+
 
+
F2<A,B,C> - Interface in fj
+
+
A transformation function of arity-2 from A and B to C.
+
+
F2_BiFunction(F2<A, B, C>) - Static method in class fj.data.Java8
+
 
+
F2_BiFunction() - Static method in class fj.data.Java8
+
 
+
F3<A,B,C,D> - Interface in fj
+
+
A transformation function of arity-3 from A, B and C to + D.
+
+
F4<A,B,C,D,E> - Interface in fj
+
+
A transformation function of arity-4 from A, B, C and + D to E.
+
+
F5<A,B,C,D,E,F$> - Interface in fj
+
+
A transformation function of arity-5 from A, B, C, + D and E to F$.
+
+
F6<A,B,C,D,E,F$,G> - Interface in fj
+
+
A transformation function of arity-6 from A, B, C, + D, E and F$ to G.
+
+
F7<A,B,C,D,E,F$,G,H> - Interface in fj
+
+
A transformation function of arity-7 from A, B, C, + D, E, F$ and G to H.
+
+
F8<A,B,C,D,E,F$,G,H,I> - Interface in fj
+
+
A transformation function of arity-8 from A, B, C, + D, E, F$, G and H to + I.
+
+
F_Function(F<A, B>) - Static method in class fj.data.Java8
+
 
+
F_Function() - Static method in class fj.data.Java8
+
 
+
F_SafeIO(F<Unit, A>) - Static method in class fj.data.Conversions
+
 
+
F_SafeIO() - Static method in class fj.data.Conversions
+
 
+
fail() - Method in class fj.data.Validation
+
+
Returns the failing value, or throws an error if there is no failing value.
+
+
fail(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing the given value.
+
+
fail(E) - Static method in class fj.parser.Parser
+
+
Returns a parser that always fails with the given error.
+
+
failE(F0<String>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failE(String) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or fails with the given error message.
+
+
failK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result on the failure side of a Validation.
+
+
failNEL(E) - Static method in class fj.data.Validation
+
+
Returns a failing validation containing a non-empty list that contains the given value.
+
+
fails(List<Validation<E, ?>>) - Static method in class fj.data.Validation
+
 
+
FALSE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
fanout(F<B, C>, F<B, D>, B) - Static method in class fj.P2
+
+
Sends the given input value to both argument functions and combines their output.
+
+
fileReader(File, Option<Charset>) - Static method in class fj.data.IOFunctions
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Array
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Array.ImmutableProjection
+
+
Filters elements from this array by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a right in Some.
+
+
filter(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns None if this projection has no value or if the given predicate + p does not hold for the value, otherwise, returns a left in Some.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Either3.LeftProjection
+
 
+
filter(F<B, Boolean>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
filter(F<C, Boolean>) - Method in class fj.data.Either3.RightProjection
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce true when + the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Option
+
+
Filters elements from this optional value by returning only elements which produce + true when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Seq
+
 
+
filter(F<A, Boolean>) - Method in class fj.data.Set
+
+
Filters elements from this set by returning only elements which produce true + when the given function is applied to them.
+
+
filter(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce true + when the given function is applied to them.
+
+
filter() - Static method in class fj.data.Stream
+
+
Returns a first-class version of the filter function.
+
+
filter(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns None if this is a success or if the given predicate p does not hold for the + failing value, otherwise, returns a fail in Some.
+
+
filter(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns None if this is a failure or if the given predicate p does not hold for the + success value, otherwise, returns a success in Some.
+
+
filter(F<A, Boolean>, E) - Method in class fj.parser.Parser
+
+
Returns a parser that fails with the given error if the result value does not meet the given predicate.
+
+
filterKeys(F<K, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters the nodes based on the annotation of each node.
+
+
filterValues(F<A, Boolean>) - Method in class fj.data.PriorityQueue
+
+
Filters nodes based on the value inside each node.
+
+
find(F<A, Boolean>) - Method in class fj.data.Array
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(K) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k.
+
+
find(K, int, int) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns an optional value for the given key k for those nodes between + lowIndex (inclusive) and highIndex (exclusive).
+
+
find(F<A, Boolean>) - Method in class fj.data.List
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.Fold
+
+
find the first target of a Fold matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.optic.PTraversal
+
+
find the first target of a PTraversal matching the predicate
+
+
find(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Finds the first occurrence of an element that matches the given predicate or no value if no + elements match.
+
+
find(F<A, Boolean>) - Method in class fj.data.Zipper
+
+
Moves the focus to the element matching the given predicate, if present.
+
+
findChild(F<Tree<A>, Boolean>) - Method in class fj.data.TreeZipper
+
+
Navigates to the first child of the current location, that satisfies the given predicate.
+
+
findChild() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the findChild function.
+
+
findFirst(List<Option<X>>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first value available in the given list of optional values.
+
+
FingerTree<V,A> - Class in fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fingerTreeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
first() - Method in class fj.data.optic.Getter
+
 
+
first() - Method in class fj.data.optic.Iso
+
 
+
first() - Method in class fj.data.optic.Optional
+
 
+
first() - Method in class fj.data.optic.PIso
+
 
+
first() - Method in class fj.data.optic.POptional
+
 
+
firstChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the first child of the current location.
+
+
firstOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the first available value.
+
+
firstOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the first available value.
+
+
firstSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "first" (left-hand side) value.
+
+
fj - package fj
+
+
Types that set the premise for the existence of Functional Java.
+
+
fj.control - package fj.control
+
+
Functional control abstractions.
+
+
fj.control.db - package fj.control.db
+
+
Abstractions for JDBC connections.
+
+
fj.control.parallel - package fj.control.parallel
+
+
Parallelization strategies.
+
+
fj.data - package fj.data
+
+
Common algebraic data types.
+
+
fj.data.fingertrees - package fj.data.fingertrees
+
+
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
+
fj.data.hamt - package fj.data.hamt
+
 
+
fj.data.hlist - package fj.data.hlist
+
+
Type-safe, extensible, heterogeneous lists
+
+
fj.data.optic - package fj.data.optic
+
+
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
+
fj.data.vector - package fj.data.vector
+
+
Fixed-length vectors
+
+
fj.function - package fj.function
+
+
A prelude of commonly used first-class functions
+
+
fj.parser - package fj.parser
+
+
Parser combinators.
+
+
flatMap(F<A, Eval<B>>) - Method in class fj.data.Eval
+
+
Alias for Eval.bind(F).
+
+
flatMap(IO<A>, F<A, IO<B>>) - Static method in class fj.data.IOFunctions
+
 
+
flatMap(F<B, Reader<A, C>>) - Method in class fj.data.Reader
+
 
+
flatMap(State<S, A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
 
+
flatMap(F<A, State<S, B>>) - Method in class fj.data.State
+
+
Bind the given function across this state.
+
+
flatMap(F<A, Writer<W, B>>) - Method in class fj.data.Writer
+
 
+
flatten() - Method in class fj.data.Tree
+
+
Puts the elements of the tree into a Stream, in pre-order.
+
+
flatten_() - Static method in class fj.data.Tree
+
+
+ flatten :: Tree a -> [a] + flatten t = squish t [] +
+
+
flip() - Method in interface fj.F2
+
+
Flips the arguments of this function.
+
+
flip() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip(F2<A, B, C>) - Static method in class fj.Function
+
+
Function argument flipping.
+
+
flip2() - Static method in class fj.Function
+
+
Function argument flipping.
+
+
Float_Boolean - Static variable in class fj.Primitive
+
+
A function that converts floats to booleans.
+
+
Float_Byte - Static variable in class fj.Primitive
+
+
A function that converts floats to bytes.
+
+
Float_Character - Static variable in class fj.Primitive
+
+
A function that converts floats to characters.
+
+
Float_Double - Static variable in class fj.Primitive
+
+
A function that converts floats to doubles.
+
+
Float_Integer - Static variable in class fj.Primitive
+
+
A function that converts floats to integers.
+
+
Float_Long - Static variable in class fj.Primitive
+
+
A function that converts floats to longs.
+
+
Float_Short - Static variable in class fj.Primitive
+
+
A function that converts floats to shorts.
+
+
floatEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for float.
+
+
floatEqual - Static variable in class fj.Equal
+
+
An equal instance for the float type.
+
+
floatHash - Static variable in class fj.Hash
+
+
A hash instance for the float type.
+
+
floatOrd - Static variable in class fj.Ord
+
+
An order instance for the float type.
+
+
floatShow - Static variable in class fj.Show
+
+
A show instance for the float type.
+
+
floatValue() - Method in class fj.data.Natural
+
+
Return the float value of this natural number.
+
+
fmap(F<A, B>) - Static method in class fj.control.parallel.Callables
+
+
Lifts any function to a function on Callables.
+
+
fmap(F<A, B>) - Method in class fj.control.parallel.Promise
+
+
Provides a promise to apply the given function to this promise's future value (covariant functor pattern).
+
+
fmap(F<A, B>) - Method in class fj.data.Tree
+
+
Maps the given function over this tree.
+
+
fmap_(F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Promotes any function to a transformation between promises (covariant functor pattern).
+
+
fmap_() - Static method in class fj.data.Tree
+
+
Provides a transformation to lift any function so that it maps over Trees.
+
+
focus() - Method in class fj.data.TreeZipper
+
+
Returns the tree at the currently focused node.
+
+
focus() - Method in class fj.data.Zipper
+
+
Returns the focus element of this zipper.
+
+
fold(F<Trampoline.Normal<A>, R>, F<Trampoline.Codense<A>, R>) - Method in class fj.control.Trampoline
+
 
+
fold(F<P2<A, Iteratee.Input<E>>, Z>, F<F<Iteratee.Input<E>, Iteratee.IterV<E, A>>, Z>) - Method in class fj.data.Iteratee.IterV
+
 
+
Fold<S,A> - Class in fj.data.optic
+
+
A Fold can be seen as a Getter with many targets or a weaker PTraversal which cannot modify its + target.
+
+
Fold() - Constructor for class fj.data.optic.Fold
+
 
+
fold(Monoid<A>) - Method in class fj.data.optic.Fold
+
+
combine all targets using a target's Monoid
+
+
fold(Monoid<A>) - Method in class fj.data.optic.PTraversal
+
+
combine all targets using a target's Monoid
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a left-fold reduction across this array.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the left using the given function and the given initial value.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function and the given initial element.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldLeft(F2<A, Boolean, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldLeft(F2<B, P2<K, V>, B>, F2<B, HashArrayMappedTrie<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F2<B, P2<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a left fold.
+
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.List
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft() - Static method in class fj.data.List
+
+
Provides a first-class version of foldLeft.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Seq
+
 
+
foldLeft(F<B, F<A, B>>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft(F2<B, A, B>, B) - Method in class fj.data.Stream
+
+
Performs a left-fold reduction across this stream.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.IterableW
+
+
Takes the first 2 elements of the iterable and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.List
+
+
Takes the first 2 elements of the list and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a left-fold reduction across this list.
+
+
foldLeft1(F2<A, A, A>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft1(F<A, F<A, A>>) - Method in class fj.data.Stream
+
+
Takes the first 2 elements of the stream and applies the function to them, + then applies the function to the result and the third element and so on.
+
+
foldLeft_(F<B, F<A, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldLeftOnNode(F2<B, Node<K, V>, B>, B) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Performs a left-fold reduction across this trie.
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Fold
+
+
map each target to a Monoid and combine the results underlying representation of Fold, all Fold + methods are defined in terms of foldMap
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.PTraversal
+
+
map each target to a Monoid and combine the results
+
+
foldMap(Monoid<M>, F<A, M>) - Method in class fj.data.optic.Traversal
+
 
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set using the given monoid.
+
+
foldMap(F<A, B>, Monoid<B>) - Method in class fj.data.Tree
+
+
Folds this tree using the given monoid.
+
+
foldMap_(F<A, B>, Monoid<B>) - Static method in class fj.data.Tree
+
+
Provides a function that folds a tree with the given monoid.
+
+
foldMapRight(F<A, B>, Monoid<B>) - Method in class fj.data.Set
+
+
Folds this Set from the right using the given monoid.
+
+
foldMapTree(Monoid<B>) - Method in interface fj.F
+
+
Returns a function that maps this function over a tree and folds it with the given monoid.
+
+
foldRight(Strategy<Unit>, F<A, F<B, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a list in constant stack space.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a right-fold reduction across this array.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Deep
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function and the given initial value.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Empty
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function and the given initial element.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.fingertrees.FingerTree
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Four
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node2
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Node3
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.One
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Single
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Three
+
 
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.fingertrees.Two
+
 
+
foldRight(F2<Boolean, A, A>, A) - Method in class fj.data.hamt.BitSet
+
 
+
foldRight(G, V, L) - Method in class fj.data.hlist.HList.HFoldr
+
+
Folds a non-empty heterogeneous list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.IterableW
+
+
The catamorphism for Iterables, implemented as a right fold.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list.
+
+
foldRight(F2<A, B, B>, B) - Method in class fj.data.Seq
+
 
+
foldRight(F<A, F<P1<B>, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight(F2<A, P1<B>, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight() - Static method in class fj.data.Stream
+
+
A first-class version of the foldRight function.
+
+
foldRight(F<A, F<B, B>>, B) - Method in class fj.data.Zipper
+
+
Performs a right-fold reduction across this zipper.
+
+
foldRight1(F<A, F<A, A>>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F2<A, A, A>) - Method in class fj.data.NonEmptyList
+
+
Performs a right-fold reduction across this list.
+
+
foldRight1(F<A, F<B, B>>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight1(F2<A, B, B>, B) - Method in class fj.data.Stream
+
+
Performs a right-fold reduction across this stream.
+
+
foldRight_(F<A, F<B, B>>) - Static method in class fj.data.fingertrees.Node
+
 
+
foldRightC(F2<A, B, B>, B) - Method in class fj.data.List
+
+
Performs a right-fold reduction across this list in O(1) stack space.
+
+
foldRightS(Strategy<Unit>, F<A, F<P1<B>, B>>, B) - Static method in class fj.control.parallel.Promise
+
+
Performs a right-fold reduction across a Stream in constant stack space.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Array
+
+
Returns true if the predicate holds for all of the elements of this array, + false otherwise (true for the empty array).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Either.LeftProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<B, Boolean>) - Method in class fj.data.Either.RightProjection
+
+
Returns true if no value or returns the result of the application of the given + function to the value.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Either3.LeftProjection
+
 
+
forall(F<B, Boolean>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
forall(F<C, Boolean>) - Method in class fj.data.Either3.RightProjection
+
 
+
forall(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns true if the predicate holds for all of the elements of this list, + false otherwise (true for the empty list).
+
+
forall(F<A, Boolean>) - Method in class fj.data.Option
+
+
Returns true if this optional value has no value, or the predicate holds for the + given predicate function, false otherwise.
+
+
forall(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns true if the predicate holds for all of the elements of this stream, + false otherwise (true for the empty stream).
+
+
forall(F<E, Boolean>) - Method in class fj.data.Validation.FailProjection
+
+
Returns true if this is a success or returns the result of the application of the given + function to the failing value.
+
+
forall(F<T, Boolean>) - Method in class fj.data.Validation
+
+
Returns true if this is a failure or returns the result of the application of the given + function to the success value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a side-effect for each element of this array.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<B, Unit>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Either3.LeftProjection
+
 
+
foreach(F<B, Unit>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
foreach(F<C, Unit>) - Method in class fj.data.Either3.RightProjection
+
 
+
foreach(F<P2<K, V>, Unit>) - Method in class fj.data.HashMap
+
 
+
foreach(F<A, Unit>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreach(F<A, Unit>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreach(F<E, Unit>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreach(F<T, Unit>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Array
+
+
Performs a side-effect for each element of this array.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Either.LeftProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<B>) - Method in class fj.data.Either.RightProjection
+
+
Execute a side-effect on this projection's value if it has one.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Either3.LeftProjection
+
 
+
foreachDoEffect(Effect1<B>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
foreachDoEffect(Effect1<C>) - Method in class fj.data.Either3.RightProjection
+
 
+
foreachDoEffect(Effect1<P2<K, V>>) - Method in class fj.data.HashMap
+
 
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.List
+
+
Performs a side-effect for each element of this list.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Option
+
+
Performs a side-effect for the value of this optional value.
+
+
foreachDoEffect(Effect1<A>) - Method in class fj.data.Stream
+
+
Performs a side-effect for each element of this stream.
+
+
foreachDoEffect(Effect1<E>) - Method in class fj.data.Validation.FailProjection
+
+
Executes a side-effect on the failing value if there is one.
+
+
foreachDoEffect(Effect1<T>) - Method in class fj.data.Validation
+
+
Executes a side-effect on the success value if there is one.
+
+
forever(Enumerator<A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at increments of 1.
+
+
forever(Enumerator<A>, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream that is either infinite or bounded up to the maximum value of the given iterator starting at the + given value and stepping at the given increment.
+
+
Four<V,A> - Class in fj.data.fingertrees
+
+
A four-element prefix or suffix of a finger tree.
+
+
four(A, A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of four elements.
+
+
fromBigInt - Static variable in class fj.data.Natural
+
+
A function that returns the natural number equal to a given BigInteger
+
+
fromChar - Static variable in enum fj.Digit
+
+
First-class conversion from a character to a digit.
+
+
fromChar(char) - Static method in enum fj.Digit
+
+
Converts the given character in the given long value to a digit.
+
+
fromEither(F0<Either<Exception, A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a given Either value into the equivalent Callable.
+
+
fromEither() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an Either to a Callable.
+
+
fromF(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
fromF(F<A, Unit>) - Static method in interface fj.function.Effect1
+
 
+
fromForest(Stream<Tree<A>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the first element of the given forest.
+
+
fromFunction(F<Natural, A>) - Static method in class fj.data.Stream
+
+
Converts a function of natural numbers to a stream.
+
+
fromFunction(Enumerator<B>, F<B, A>, B) - Static method in class fj.data.Stream
+
+
Converts a function of an enumerable type to a stream of the results of that function, + starting at the given index.
+
+
fromInt(int) - Static method in enum fj.Ordering
+
 
+
fromIterator(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
fromJavaList(List<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.List.Buffer
+
+
Constructs a buffer from the given list.
+
+
fromList(List<A>) - Static method in class fj.data.NonEmptyList
+
+
Returns a potential non-empty list from the given list.
+
+
fromLong - Static variable in enum fj.Digit
+
+
First-class conversion from a long to a digit.
+
+
fromLong(long) - Static method in enum fj.Digit
+
+
Converts the right-most digit in the given long value to a digit.
+
+
fromMap(Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMap(Equal<K>, Hash<K>, Map<K, V>) - Static method in class fj.data.HashMap
+
 
+
fromMutableMap(Ord<K>, Map<K, V>) - Static method in class fj.data.TreeMap
+
+
An immutable projection of the given mutable map.
+
+
fromNull(T) - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromNull() - Static method in class fj.data.Option
+
+
Turns an unsafe nullable value into a safe optional value.
+
+
fromOption(F0<Option<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns an optional value into a Callable.
+
+
fromOption() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from an optional value to a Callable
+
+
fromSet(Set<A>) - Static method in class fj.data.HashSet
+
 
+
fromSome() - Static method in class fj.data.Option
+
+
Returns a function that takes an optional value to a value or errors if there is no value.
+
+
fromStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from character streams to lazy strings.
+
+
fromStream(Stream<Character>) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a stream of characters.
+
+
fromStream(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromStreamEnd(Stream<A>) - Static method in class fj.data.Zipper
+
+
Possibly create a zipper if the provided stream has at least one element, otherwise None.
+
+
fromString(String) - Static method in class fj.data.List
+
+
Returns a list of characters from the given string.
+
+
fromString() - Static method in class fj.data.List
+
+
A first-class fromString.
+
+
fromString(String) - Static method in class fj.data.Option
+
+
Returns an optional non-empty string, or no value if the given string is empty.
+
+
fromString() - Static method in class fj.data.Option
+
+
Returns a function that transforms a string to an optional non-empty string, + or no value if the string is empty.
+
+
fromString(String) - Static method in class fj.data.Stream
+
+
Returns a stream of characters from the given string.
+
+
fromString() - Static method in class fj.function.Doubles
+
+
A function that converts strings to doubles.
+
+
fromString() - Static method in class fj.function.Integers
+
+
A function that converts strings to integers.
+
+
fromString() - Static method in class fj.function.Longs
+
+
A function that converts strings to integers.
+
+
fromTree(Tree<A>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper focused on the root of the given tree.
+
+
fromTree() - Static method in class fj.data.TreeZipper
+
+
First-class conversion of a Tree to the corresponding tree zipper.
+
+
fromTry(Try0<A, ? extends IOException>) - Static method in class fj.data.IOFunctions
+
 
+
Function - Class in fj
+
+
Transformations on functions.
+
+
Function_F(Function<A, B>) - Static method in class fj.data.Java8
+
 
+
Function_F() - Static method in class fj.data.Java8
+
 
+
functionMonoid(Monoid<B>) - Static method in class fj.Monoid
+
+
A monoid for functions.
+
+
functionSemigroup(Semigroup<B>) - Static method in class fj.Semigroup
+
+
A semigroup for functions.
+
+
Future_P1() - Static method in class fj.data.Java
+
 
+
+ + + +

G

+
+
get(int) - Method in class fj.data.Array
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(int) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
get(K) - Method in class fj.data.HashMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.HashMap
+
+
A curried version of HashMap.get(Object).
+
+
get(S) - Method in class fj.data.optic.Getter
+
+
get the target of a Getter
+
+
get(S) - Method in class fj.data.optic.Iso
+
 
+
get(S) - Method in class fj.data.optic.Lens
+
 
+
get(S) - Method in class fj.data.optic.PIso
+
+
get the target of a PIso
+
+
get(S) - Method in class fj.data.optic.PLens
+
+
get the target of a PLens
+
+
get(K) - Method in class fj.data.TreeMap
+
+
Returns a potential value that the given key maps to.
+
+
get() - Method in class fj.data.TreeMap
+
+
Returns a first-class version of the get method for this TreeMap.
+
+
get() - Method in interface fj.F0
+
 
+
getAll(S) - Method in class fj.data.optic.Fold
+
+
get all the targets of a Fold TODO: Shall it return a Stream as there might be an infinite number of targets?
+
+
getAll(S) - Method in class fj.data.optic.PTraversal
+
+
get all the targets of a PTraversal
+
+
getBitSet() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
getChild(int) - Method in class fj.data.TreeZipper
+
+
Navigates to the given child of the current location, starting at index 0.
+
+
getContents() - Static method in interface fj.data.IO
+
 
+
getContents() - Static method in class fj.data.IOFunctions
+
 
+
getDelete(K) - Method in class fj.data.HashMap
+
+
Deletes the entry in the hash map that corresponds to the given key and returns any associated value.
+
+
getDirectionality - Static variable in class fj.function.Characters
+
 
+
getFunction() - Method in class fj.data.Reader
+
 
+
getLabel() - Method in class fj.data.TreeZipper
+
+
Returns the label at the current node.
+
+
getNumericValue - Static variable in class fj.function.Characters
+
 
+
getOption(S) - Method in class fj.data.optic.Optional
+
 
+
getOption(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or nothing if there is no target
+
+
getOption(S) - Method in class fj.data.optic.Prism
+
 
+
getOrModify(S) - Method in class fj.data.optic.Optional
+
 
+
getOrModify(S) - Method in class fj.data.optic.POptional
+
+
get the target of a POptional or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.PPrism
+
+
get the target of a PPrism or modify the source in case there is no target
+
+
getOrModify(S) - Method in class fj.data.optic.Prism
+
 
+
gets(F<S, A>) - Static method in class fj.data.State
+
 
+
gets() - Method in class fj.data.State
+
 
+
getSeed() - Method in class fj.LcgRng
+
 
+
getSeq() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
Getter<S,A> - Class in fj.data.optic
+
+
A Getter can be seen as a glorified get method between a type S and a type A.
+
+
getter(F<S, A>) - Static method in class fj.data.optic.Getter
+
 
+
getType - Static variable in class fj.function.Characters
+
 
+
group(Equal<A>) - Method in class fj.data.List
+
+
Groups elements according to the given equality implementation by longest + sequence of equal elements.
+
+
groupBy(F<A, B>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap.
+
+
groupBy(F<A, B>, F<A, C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, Monoid<C>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction into a TreeMap and transforms + the matching elements with the given valueFunction.
+
+
groupBy(F<A, B>, F<A, C>, D, F2<C, D, D>, Ord<B>) - Method in class fj.data.List
+
+
Groups the elements of this list by a given keyFunction, applies the valueFunction and + accumulates the mapped values with the given grouping accumulator function on the grouping + identity.
+
+
gteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than or equal to zero.
+
+
gteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than or equal to zero.
+
+
gtZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is greater than zero.
+
+
gtZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is greater than zero.
+
+
+ + + +

H

+
+
hamtNode(HashArrayMappedTrie<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
hamtNodeShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hamtShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
hAnd(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hAnd(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HAnd
+
 
+
hardMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-need semantic: + function f is evaluated at most once, at first to P1._1().
+
+
hardMemo() - Method in class fj.P1
+
+
Returns a P1 that remembers its value.
+
+
hasChildren() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node has any child nodes.
+
+
hash(K) - Method in class fj.data.HashMap
+
+
Compute the hash of the given key value using the underlying hashing strategy.
+
+
hash(A) - Method in class fj.data.HashSet
+
+
Compute the hash of the given value using the underlying hashing strategy.
+
+
Hash<A> - Class in fj
+
+
Produces a hash code for an object which should attempt uniqueness.
+
+
hash(A) - Method in class fj.Hash
+
+
Compute the hash of the given value.
+
+
hash(F<A, Integer>) - Static method in class fj.Hash
+
+
Construct a hash with the given hash function.
+
+
HashArrayMappedTrie<K,V> - Class in fj.data.hamt
+
+
A hash array mapped trie (HAMT) is an implementation of an associative + array that combines the characteristics of a hash table and an array + mapped trie.
+
+
hashCode() - Method in class fj.data.Array
+
 
+
hashCode() - Method in class fj.data.Either
+
 
+
hashCode() - Method in class fj.data.Either3
+
 
+
hashCode() - Method in class fj.data.List
+
+
Compute the hash code from this list as a function of the hash codes of its members.
+
+
hashCode() - Method in class fj.data.Natural
+
 
+
hashCode() - Method in class fj.data.NonEmptyList
+
 
+
hashCode() - Method in class fj.data.Option
+
 
+
hashCode() - Method in class fj.data.Seq
+
 
+
hashCode() - Method in class fj.data.Set
+
 
+
hashCode() - Method in class fj.data.Stream
+
 
+
hashCode() - Method in class fj.data.Tree
+
 
+
hashCode() - Method in class fj.data.TreeMap
+
 
+
hashCode() - Method in class fj.data.TreeZipper
+
 
+
hashCode() - Method in class fj.data.Validation
+
 
+
hashCode() - Method in class fj.data.vector.V2
+
 
+
hashCode() - Method in class fj.data.vector.V3
+
 
+
hashCode() - Method in class fj.data.vector.V4
+
 
+
hashCode() - Method in class fj.data.vector.V5
+
 
+
hashCode() - Method in class fj.data.vector.V6
+
 
+
hashCode() - Method in class fj.data.vector.V7
+
 
+
hashCode() - Method in class fj.data.vector.V8
+
 
+
hashCode() - Method in class fj.data.Zipper
+
 
+
hashCode() - Method in class fj.P1
+
 
+
hashCode() - Method in class fj.P2
+
 
+
hashCode() - Method in class fj.P3
+
 
+
hashCode() - Method in class fj.P4
+
 
+
hashCode() - Method in class fj.P5
+
 
+
hashCode() - Method in class fj.P6
+
 
+
hashCode() - Method in class fj.P7
+
 
+
hashCode() - Method in class fj.P8
+
 
+
hashCode() - Method in class fj.parser.Result
+
 
+
HashMap<K,V> - Class in fj.data
+
+
A mutable hash map providing O(1) lookup.
+
+
HashMap(Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>, Equal<K>, Hash<K>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
HashMap(Map<K, V>) - Constructor for class fj.data.HashMap
+
 
+
HashMap(Equal<K>, Hash<K>, int, float) - Constructor for class fj.data.HashMap
+
+
Construct a hash map with the given equality and hashing strategy.
+
+
hashMap() - Static method in class fj.data.HashMap
+
+
Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode().
+
+
hashMap(Equal<K>, Hash<K>) - Static method in class fj.data.HashMap
+
+
Construct a hash map.
+
+
HashSet<A> - Class in fj.data
+
+
A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.
+
+
HashSet(Equal<A>, Hash<A>) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
HashSet(Equal<A>, Hash<A>, int, float) - Constructor for class fj.data.HashSet
+
+
Construct a hash set with the given equality and hashing strategy.
+
+
hashSet(A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
hashSet(Equal<A>, Hash<A>, A...) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the array.
+
+
HashSet_List() - Static method in class fj.data.Java
+
+
A function that converts hash sets to lists.
+
+
hCond(HPre.HFalse, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
hCond(HPre.HTrue, X, Y) - Static method in class fj.data.hlist.HPre.HCond
+
 
+
head() - Method in class fj.data.fingertrees.Deep
+
 
+
head() - Method in class fj.data.fingertrees.Empty
+
 
+
head() - Method in class fj.data.fingertrees.FingerTree
+
+
The first element of this tree.
+
+
head() - Method in class fj.data.fingertrees.Single
+
 
+
head() - Method in class fj.data.hlist.HList.HCons
+
 
+
head() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the head of the input
+
+
head() - Method in class fj.data.LazyString
+
+
Returns the first character of this string.
+
+
head() - Method in class fj.data.List
+
+
The first element of the linked list or fails for the empty list.
+
+
head() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons head.
+
+
head() - Method in class fj.data.NonEmptyList
+
+
The first element of this linked list.
+
+
head() - Method in class fj.data.Seq
+
+
The first element of this sequence.
+
+
head() - Method in class fj.data.Stream
+
+
The first element of the stream or fails for the empty stream.
+
+
head() - Method in class fj.data.vector.V2
+
+
Return the first element of this vector as a product-1.
+
+
head() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector, as a product-1.
+
+
head() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector, as a product-1.
+
+
head_() - Static method in class fj.data.List
+
+
First-class head function.
+
+
headOption() - Method in class fj.data.fingertrees.FingerTree
+
 
+
headOption() - Method in class fj.data.List
+
+
Returns the head of the list, if any.
+
+
headOption(S) - Method in class fj.data.optic.Fold
+
+
get the first target of a Fold
+
+
headOption(S) - Method in class fj.data.optic.PTraversal
+
+
get the first target of a PTraversal
+
+
headOption() - Method in class fj.data.Seq
+
 
+
hFalse() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents falsehood.
+
+
hFoldr() - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for the empty list.
+
+
hFoldr(PP, H) - Static method in class fj.data.hlist.HList.HFoldr
+
+
A fold instance for a non-empty heterogeneous list
+
+
highSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
highSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a high-surrogate character.
+
+
HList<A extends HList<A>> - Class in fj.data.hlist
+
+
Type-safe heterogeneous lists.
+
+
HList.Apply<F$,A,R> - Class in fj.data.hlist
+
+
Type-level function application operators.
+
+
HList.HAppend<A,B,C> - Class in fj.data.hlist
+
+
The concatenation of two heterogeneous lists.
+
+
HList.HCons<E,L extends HList<L>> - Class in fj.data.hlist
+
+
The nonempty list
+
+
HList.HFoldr<G,V,L,R> - Class in fj.data.hlist
+
+
The catamorphism over heterogeneous lists.
+
+
HList.HNil - Class in fj.data.hlist
+
+
The empty list
+
+
hListEqual - Static variable in class fj.Equal
+
+
An equal instance for the empty heterogeneous list.
+
+
hListEqual(Equal<E>, Equal<L>) - Static method in class fj.Equal
+
+
An equal instance for heterogeneous lists.
+
+
HListShow - Static variable in class fj.Show
+
+
A show instance for the empty heterogeneous Stream.
+
+
HListShow(Show<E>, Show<L>) - Static method in class fj.Show
+
+
A show instance for heterogeneous Streams.
+
+
HNat() - Constructor for class fj.data.hlist.HPre.HNat
+
 
+
hOr(HPre.HFalse, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HFalse) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HFalse, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
hOr(HPre.HTrue, HPre.HTrue) - Static method in class fj.data.hlist.HPre.HOr
+
 
+
HPre - Class in fj.data.hlist
+
+
A basic prelude of values lifted into the type system.
+
+
HPre.HAdd<A extends HPre.HNat<A>,B extends HPre.HNat<B>,C extends HPre.HNat<C>> - Class in fj.data.hlist
+
+
Type-level integer arithmetic
+
+
HPre.HAnd<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean conjunction.
+
+
HPre.HBool - Class in fj.data.hlist
+
+
A type-level Boolean
+
+
HPre.HCond<T,X,Y,Z> - Class in fj.data.hlist
+
+
A type-level conditional.
+
+
HPre.HEq<X,Y,B extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level equality.
+
+
HPre.HFalse - Class in fj.data.hlist
+
+
Boolean false
+
+
HPre.HNat<A extends HPre.HNat<A>> - Class in fj.data.hlist
+
+
Type-level natural numbers.
+
+
HPre.HOr<A extends HPre.HBool,B extends HPre.HBool,C extends HPre.HBool> - Class in fj.data.hlist
+
+
Type-level boolean disjunction.
+
+
HPre.HSucc<N extends HPre.HNat<N>> - Class in fj.data.hlist
+
+
A natural number N + 1
+
+
HPre.HTrue - Class in fj.data.hlist
+
+
Boolean true
+
+
HPre.HZero - Class in fj.data.hlist
+
+
Type-level zero
+
+
hPred(HPre.HSucc<N>) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hSucc(N) - Static method in class fj.data.hlist.HPre.HNat
+
 
+
hTrue() - Static method in class fj.data.hlist.HPre
+
+
Returns a boolean value whose type represents truth.
+
+
hZero() - Static method in class fj.data.hlist.HPre.HNat
+
 
+
+ + + +

I

+
+
id() - Static method in class fj.data.hlist.HList.Apply
+
+
Identity operator
+
+
id() - Static method in class fj.data.optic.Fold
+
 
+
id() - Static method in class fj.data.optic.Getter
+
 
+
id() - Static method in class fj.data.optic.Iso
+
+
create an Iso between any type and itself.
+
+
id() - Static method in class fj.data.optic.Lens
+
 
+
id() - Static method in class fj.data.optic.Optional
+
 
+
id() - Static method in class fj.data.optic.Prism
+
 
+
id() - Static method in class fj.data.optic.Setter
+
 
+
id() - Static method in class fj.data.optic.Traversal
+
 
+
identifierIgnorable(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identifierIgnorable(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an identifier-ignorable character.
+
+
identity() - Static method in class fj.Function
+
+
The identity transformation.
+
+
idStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs no evaluation of its argument.
+
+
if_ - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if" (reverse material implication).
+
+
iff - Static variable in class fj.function.Booleans
+
+
Curried form of logical "if and only if" (biconditional, equivalence).
+
+
ignored() - Static method in class fj.data.optic.Optional
+
 
+
iif(boolean, F0<B>, F0<A>) - Static method in class fj.data.Either
+
+
If the condition satisfies, return the given B in right, otherwise, return the given A in left.
+
+
iif(F<A, Boolean>, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument, if the given predicate holds + on that argument, otherwise, returns no value.
+
+
iif(boolean, F0<A>) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif(boolean, A) - Static method in class fj.data.Option
+
+
Returns an optional value that has a value of the given argument if the given boolean is true, otherwise, returns + no value.
+
+
iif() - Static method in class fj.data.Option
+
+
First-class version of the iif function.
+
+
immutable() - Method in class fj.data.Array
+
 
+
implies - Static variable in class fj.function.Booleans
+
+
Curried form of logical "only if" (material implication).
+
+
index(int) - Method in class fj.data.List
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index(int) - Method in class fj.data.Seq
+
+
Returns the element at the given index.
+
+
index(int) - Method in class fj.data.Stream
+
+
Returns the element at the given index if it exists, fails otherwise.
+
+
index() - Method in class fj.data.Zipper
+
+
Returns the index of the focus.
+
+
indexOf(char) - Method in class fj.data.LazyString
+
+
Returns the first index of the given character in this lazy string, if present.
+
+
indexOf(LazyString) - Method in class fj.data.LazyString
+
+
Returns the first index of the given substring in this lazy string, if present.
+
+
indexOf(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the position of the first element matching the given predicate, if any.
+
+
inheritance() - Method in class fj.Class
+
+
Returns the inheritance hierarchy of this class.
+
+
init() - Method in class fj.data.fingertrees.Deep
+
 
+
init() - Method in class fj.data.fingertrees.Empty
+
 
+
init() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the last element.
+
+
init() - Method in class fj.data.fingertrees.Single
+
 
+
init() - Method in class fj.data.List
+
+
Returns all but the last element of this list.
+
+
init() - Method in class fj.data.Seq
+
+
The sequence without the last element.
+
+
init() - Static method in class fj.data.State
+
 
+
inits() - Method in class fj.data.List
+
+
Returns the list of initial segments of this list, shortest first.
+
+
inits() - Method in class fj.data.Stream
+
+
Returns a stream of all prefixes of this stream.
+
+
inject(C) - Method in class fj.P2
+
+
Replaces the first element of this product with the given value.
+
+
insert(int, A) - Method in class fj.data.Seq
+
+
Inserts the element at the given index.
+
+
insert(A) - Method in class fj.data.Set
+
+
Inserts the given element into this set.
+
+
insert() - Static method in class fj.data.Set
+
+
First-class insertion function.
+
+
insertBy(F<A, F<A, Ordering>>, A) - Method in class fj.data.List
+
+
Inserts the given element before the first element that is greater than or equal to it according + to the given ordering.
+
+
insertDownAt(int, Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree at the specified location in the current node's stream of children.
+
+
insertDownFirst(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the first child of the current node.
+
+
insertDownLast(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree as the last child of the current node.
+
+
insertLeft(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the left of the current position.
+
+
insertLeft(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the left of the focus, then moves the focus to the new element.
+
+
insertRight(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Inserts a tree to the right of the current position.
+
+
insertRight(A) - Method in class fj.data.Zipper
+
+
Inserts an element to the right of the focus, then moves the focus to the new element.
+
+
intAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds integers.
+
+
intAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds integers.
+
+
Integer_Boolean - Static variable in class fj.Primitive
+
+
A function that converts integers to booleans.
+
+
Integer_Byte - Static variable in class fj.Primitive
+
+
A function that converts integers to bytes.
+
+
Integer_Character - Static variable in class fj.Primitive
+
+
A function that converts integers to characters.
+
+
Integer_Double - Static variable in class fj.Primitive
+
+
A function that converts integers to doubles.
+
+
Integer_Float - Static variable in class fj.Primitive
+
+
A function that converts integers to floats.
+
+
Integer_Long - Static variable in class fj.Primitive
+
+
A function that converts integers to longs.
+
+
Integer_Short - Static variable in class fj.Primitive
+
+
A function that converts integers to shorts.
+
+
Integers - Class in fj.function
+
+
Curried functions over Integers.
+
+
intEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for int.
+
+
intEqual - Static variable in class fj.Equal
+
+
An equal instance for the int type.
+
+
interact(F<LazyString, LazyString>) - Static method in interface fj.data.IO
+
 
+
interact(F<LazyString, LazyString>) - Static method in class fj.data.IOFunctions
+
 
+
interactWhile(F<String, Boolean>, F<String, String>) - Static method in class fj.data.IOFunctions
+
+
Read lines from stdin until condition is not met, transforming each line and printing + the result to stdout.
+
+
intercalate(List<List<A>>) - Method in class fj.data.List
+
+
Intersperses this list through the given list then joins the results.
+
+
interfaceParameters() - Method in class fj.Class
+
+
Provides this class's interface type parameter information as a list of trees.
+
+
interleave(Stream<A>) - Method in class fj.data.Stream
+
+
Interleaves the given stream with this stream to produce a new stream.
+
+
intersect(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that do not occur in the given set.
+
+
intersect() - Static method in class fj.data.Set
+
+
A first class function for Set.intersect(Set).
+
+
intersperse(A) - Method in class fj.data.List
+
+
Intersperses the given argument between each element of this list.
+
+
intersperse(A) - Method in class fj.data.NonEmptyList
+
+
Intersperses the given argument between each element of this non empty list.
+
+
intersperse(A) - Method in class fj.data.Stream
+
+
Intersperses the given value between each two elements of the stream.
+
+
intHash - Static variable in class fj.Hash
+
+
A hash instance for the int type.
+
+
intMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of integers.
+
+
intMaxMonoid - Static variable in class fj.Monoid
+
+
A monoid for the maximum of two integers.
+
+
intMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of integers.
+
+
intMinMonoid - Static variable in class fj.Monoid
+
+
A monoid for the minimum of two integers.
+
+
intMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies integers.
+
+
intMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies integers.
+
+
intOrd - Static variable in class fj.Ord
+
+
An order instance for the int type.
+
+
intShow - Static variable in class fj.Show
+
+
A show instance for the int type.
+
+
intValue() - Method in class fj.data.Natural
+
+
Return the int value of this natural number.
+
+
IO<A> - Interface in fj.data
+
+
IO monad for processing files
+
+
io(Try0<A, ? extends IOException>) - Static method in class fj.Try
+
 
+
IOFunctions - Class in fj.data
+
+
IO monad for processing files, with main methods IOFunctions.enumFileLines(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.String, A>), + IOFunctions.enumFileChars(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<java.lang.Character, A>) and IOFunctions.enumFileCharChunks(java.io.File, fj.data.Option<java.nio.charset.Charset>, fj.data.Iteratee.IterV<char[], A>) + (the latter one is the fastest as char chunks read from the file are directly passed to the iteratee + without indirection in between).
+
+
ioMonoid(Monoid<A>) - Static method in class fj.Monoid
+
+
A monoid for IO values.
+
+
ioSemigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A semigroup for IO values.
+
+
ioUnit - Static variable in class fj.data.IOFunctions
+
 
+
is(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
alias for contramap
+
+
isChild() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is a child node of another node.
+
+
isDefined - Static variable in class fj.function.Characters
+
 
+
isDigit - Static variable in class fj.function.Characters
+
 
+
isEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.Array
+
+
Returns true is this array is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.fingertrees.FingerTree
+
+
Indicates whether this tree is empty.
+
+
isEmpty() - Method in class fj.data.hamt.BitSet
+
 
+
isEmpty() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns if the trie is empty.
+
+
isEmpty() - Method in class fj.data.HashMap
+
+
Determines if this hash map has any entries.
+
+
isEmpty() - Method in class fj.data.HashSet
+
+
Determines if this hash set contains any elements.
+
+
isEmpty() - Method in class fj.data.LazyString
+
+
Checks if this string is empty.
+
+
isEmpty() - Method in class fj.data.List.Buffer
+
+
Returns true if this buffer is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.List
+
+
Returns true if this list is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.PriorityQueue
+
+
Is the tree empty?
+
+
isEmpty() - Method in class fj.data.Seq
+
+
Checks if this is the empty sequence.
+
+
isEmpty() - Method in class fj.data.Set
+
 
+
isEmpty() - Method in class fj.data.Stream
+
+
Returns true if this stream is empty, false otherwise.
+
+
isEmpty() - Method in class fj.data.TreeMap
+
+
Determines if this tree map has any entries.
+
+
isEmpty - Static variable in class fj.function.Strings
+
+
A curried version of String.isEmpty().
+
+
isEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is empty.
+
+
isEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is empty.
+
+
isEqual(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isFail() - Method in class fj.data.Validation
+
+
Returns true if this is a failure, false otherwise.
+
+
isFirst() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the leftmost tree in the current forest.
+
+
isFulfilled() - Method in class fj.control.parallel.Promise
+
+
Returns true if this promise has been fulfilled.
+
+
isGreaterThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
 
+
isGreaterThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is greater than the second given + argument, false otherwise.
+
+
isGreaterThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is greater than than the argument to this method.
+
+
isIdentifierIgnorable - Static variable in class fj.function.Characters
+
 
+
isISOControl - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isJavaIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isLast() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is the rightmost tree in the current forest.
+
+
isLeaf() - Method in class fj.data.Tree
+
 
+
isLeaf() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the bottom of the tree.
+
+
isLeft() - Method in class fj.data.Either
+
+
Returns true if this either is a left, false otherwise.
+
+
isLeft() - Method in class fj.data.Either3
+
 
+
isLessThan(Ord<K>, K) - Method in class fj.data.PriorityQueue
+
+
Does the top of the queue have lower priority than k?
+
+
isLessThan(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than the second given argument, + false otherwise.
+
+
isLessThan(A) - Method in class fj.Ord
+
+
Returns a function that returns true if its argument is less than the argument to this method.
+
+
isLessThanOrEqualTo(A, A) - Method in class fj.Ord
+
+
Returns true if the first given argument is less than or equal to the second given argument, + false otherwise.
+
+
isLetter - Static variable in class fj.function.Characters
+
 
+
isLetterOrDigit - Static variable in class fj.function.Characters
+
 
+
isLowerCase - Static variable in class fj.function.Characters
+
 
+
isMatching(S) - Method in class fj.data.optic.POptional
+
+
check if a POptional has a target
+
+
isMatching(S) - Method in class fj.data.optic.PPrism
+
+
check if a PPrism has a target
+
+
isMiddle() - Method in class fj.data.Either3
+
 
+
isMirrored - Static variable in class fj.function.Characters
+
 
+
isNewLine - Static variable in class fj.function.Characters
+
 
+
isNone() - Method in class fj.data.Option
+
+
Returns false if this optional value has a value, true otherwise.
+
+
isNone_() - Static method in class fj.data.Option
+
+
A first-class version of the isNone method.
+
+
isnot(F<B, A>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns inverse of contramap
+
+
isNotEmpty() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Array
+
+
Returns false is this array is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.List
+
+
Returns false if this list is empty, true otherwise.
+
+
isNotEmpty() - Method in class fj.data.Seq
+
+
Checks if this sequence is not empty.
+
+
isNotEmpty() - Method in class fj.data.Stream
+
+
Returns false if this stream is empty, true otherwise.
+
+
isNotEmpty_() - Static method in class fj.data.List
+
+
Returns a function that determines whether a given list is not empty.
+
+
isNotEmpty_() - Static method in class fj.data.Stream
+
+
Returns a function that determines whether a given stream is not empty.
+
+
isNotNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String contains any non-whitespace character + (according to Character.isWhitespace(char)) and if it's also not + null and not empty ("").
+
+
isNotNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is neither null nor empty.
+
+
isNullOrBlank - Static variable in class fj.function.Strings
+
+
This function checks if a given String is whitespace (according to Character.isWhitespace(char)), + empty ("") or null.
+
+
isNullOrEmpty - Static variable in class fj.function.Strings
+
+
This function checks if a given String is null or empty (String.isEmpty()).
+
+
Iso<S,A> - Class in fj.data.optic
+
+
PIso when S = T and A = B
+
+
Iso(PIso<S, S, A, A>) - Constructor for class fj.data.optic.Iso
+
 
+
iso(F<S, A>, F<A, S>) - Static method in class fj.data.optic.Iso
+
+
create an Iso using a pair of functions: one to get the target and one to get the source.
+
+
isoControl(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isoControl(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces an ISO control character.
+
+
isPrefixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isRight() - Method in class fj.data.Either
+
+
Returns true if this either is a right, false otherwise.
+
+
isRight() - Method in class fj.data.Either3
+
 
+
isRoot() - Method in class fj.data.TreeZipper
+
+
Indicates whether the current node is at the top of the tree.
+
+
isSet(int) - Method in class fj.data.hamt.BitSet
+
 
+
isSingle() - Method in class fj.data.List
+
+
True if and only if the list has one element.
+
+
isSome() - Method in class fj.data.Option
+
+
Returns true if this optional value has a value, false otherwise.
+
+
isSome_() - Static method in class fj.data.Option
+
+
A first-class version of the isSome method.
+
+
isSpaceChar - Static variable in class fj.function.Characters
+
 
+
isSuccess() - Method in class fj.data.Validation
+
+
Returns true if this is a success, false otherwise.
+
+
isSuffixOf(Equal<A>, List<A>) - Method in class fj.data.List
+
 
+
isTitleCase - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierPart - Static variable in class fj.function.Characters
+
 
+
isUnicodeIdentifierStart - Static variable in class fj.function.Characters
+
 
+
isUpperCase - Static variable in class fj.function.Characters
+
 
+
isWhitespace - Static variable in class fj.function.Characters
+
 
+
iterable(A) - Static method in class fj.data.IterableW
+
+
Returns an Iterable that completely preserves the argument.
+
+
iterable(F<A, B>) - Static method in class fj.data.IterableW
+
+
Wraps a given function's return value in a Iterable.
+
+
Iterable_JavaStream(Iterable<A>) - Static method in class fj.data.Java8
+
 
+
iterableArray(Iterable<A>) - Static method in class fj.data.Array
+
+
Takes the given iterable to an array.
+
+
iterableBuffer(Iterable<A>) - Static method in class fj.data.List.Buffer
+
+
Takes the given iterable to a buffer.
+
+
iterableDList(Iterable<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterable
+
+
iterableHashMap(Equal<K>, Hash<K>, Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashMap(Iterable<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterable to a HashMap
+
+
iterableHashSet(Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableHashSet(Equal<A>, Hash<A>, Iterable<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterable.
+
+
iterableK() - Method in interface fj.F
+
+
Promotes this function to return its value in an Iterable.
+
+
iterableList(Iterable<A>) - Static method in class fj.data.List
+
+
Takes the given iterable to a list.
+
+
iterableM() - Method in interface fj.F2
+
+
Promotes this function to a function on Iterables.
+
+
iterableSeq(Iterable<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterable.
+
+
iterableSet(Ord<A>, Iterable<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterable as a set.
+
+
iterableStream(Iterable<A>) - Static method in class fj.data.Stream
+
+
Takes the given iterable to a stream.
+
+
iterableTreeMap(Ord<K>, Iterable<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
IterableW<A> - Class in fj.data
+
+
A wrapper for Iterable that equips it with some useful functions.
+
+
iterate(F<A, A>, A) - Static method in class fj.data.Stream
+
+
Returns a stream constructed by applying the given iteration function starting at the given value.
+
+
iterate() - Static method in class fj.data.Stream
+
+
A first-class version of the iterate function.
+
+
Iteratee - Class in fj.data
+
 
+
Iteratee.Input<E> - Class in fj.data
+
+
The input to an iteratee.
+
+
Iteratee.IterV<E,A> - Class in fj.data
+
+
A pure iteratee computation which is either done or needs more input
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.List
+
+
Creates a list where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterateWhile(F<A, A>, F<A, Boolean>, A) - Static method in class fj.data.Stream
+
+
Creates a stream where the first item is calculated by applying the function on the third argument, + the second item by applying the function on the previous result and so on.
+
+
iterator() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Array
+
+
Returns an iterator for this array.
+
+
iterator() - Method in class fj.data.Either.LeftProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Either.RightProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Either3.LeftProjection
+
 
+
iterator() - Method in class fj.data.Either3.MiddleProjection
+
 
+
iterator() - Method in class fj.data.Either3.RightProjection
+
 
+
iterator() - Method in class fj.data.HashMap
+
+
Returns an iterator for this map's keys.
+
+
iterator() - Method in class fj.data.HashSet
+
+
Returns an iterator for this hash set.
+
+
iterator() - Method in class fj.data.IterableW
+
+
Returns an iterator for this iterable.
+
+
iterator() - Method in class fj.data.List.Buffer
+
+
Returns an iterator for this buffer.
+
+
iterator() - Method in class fj.data.List
+
+
Returns an iterator for this list.
+
+
iterator() - Method in class fj.data.NonEmptyList
+
+
Returns an iterator for this non-empty list.
+
+
iterator() - Method in class fj.data.Option
+
+
Returns an iterator for this optional value.
+
+
iterator() - Method in class fj.data.Seq
+
+
Returns an iterator for this seq.
+
+
iterator() - Method in class fj.data.Set
+
+
Returns an iterator over this set.
+
+
iterator() - Method in class fj.data.Stream
+
+
Returns an iterator for this stream.
+
+
iterator() - Method in class fj.data.Tree
+
+
Returns an iterator for this tree.
+
+
iterator() - Method in class fj.data.TreeMap
+
+
Returns an iterator for this map's key-value pairs.
+
+
iterator() - Method in class fj.data.TreeZipper
+
+
Returns an iterator of all the positions of this TreeZipper.
+
+
iterator() - Method in class fj.data.Validation.FailProjection
+
+
Returns an iterator for this projection.
+
+
iterator() - Method in class fj.data.Validation
+
+
Returns an iterator for this validation.
+
+
iterator() - Method in class fj.data.vector.V2
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V3
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V4
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V5
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V6
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V7
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.vector.V8
+
+
Returns an iterator for the elements of this vector.
+
+
iterator() - Method in class fj.data.Zipper
+
+
Returns an iterator of all the positions of this Zipper, starting from the leftmost position.
+
+
iterator() - Method in class fj.parser.Result
+
+
Returns an iterator over the parse value.
+
+
Iterator_JavaStream(Iterator<A>) - Static method in class fj.data.Java8
+
 
+
iteratorArray(Iterator<A>) - Static method in class fj.data.Array
+
+
Creates an Array from the iterator.
+
+
iteratorDList(Iterator<A>) - Static method in class fj.data.DList
+
+
Creates a DList from an Iterator
+
+
iteratorHashMap(Equal<K>, Hash<K>, Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashMap(Iterator<P2<K, V>>) - Static method in class fj.data.HashMap
+
+
Converts the Iterator to a HashMap
+
+
iteratorHashSet(Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorHashSet(Equal<A>, Hash<A>, Iterator<A>) - Static method in class fj.data.HashSet
+
+
Create a HashSet from the Iterator.
+
+
iteratorList(Iterator<A>) - Static method in class fj.data.List
+
+
Constructs a list from the given Iterator.
+
+
iteratorSeq(Iterator<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the iterator.
+
+
iteratorSet(Ord<A>, Iterator<A>) - Static method in class fj.data.Set
+
+
Return the elements of the given iterator as a set.
+
+
iteratorStream(Iterator<A>) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements in the Iterator.
+
+
iteratorTreeMap(Ord<K>, Iterator<P2<K, V>>) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
+ + + +

J

+
+
Java - Class in fj.data
+
+
Functions that convert between types from the core Java API.
+
+
Java8 - Class in fj.data
+
 
+
javaIdentifierPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier part character.
+
+
javaIdentifierStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
javaIdentifierStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a Java identifier start character.
+
+
JavaList_List() - Static method in class fj.data.Java
+
 
+
JavaList_List(List<A>) - Static method in class fj.data.Java
+
 
+
JavaStream_Array(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_List(Stream<A>) - Static method in class fj.data.Java8
+
 
+
JavaStream_Stream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
join(DB<DB<A>>) - Static method in class fj.control.db.DB
+
+
Removes one layer of monadic structure.
+
+
join(Callable<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Joins a Callable of a Callable with a bind operation.
+
+
join(Promise<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a promise of a promise into just a promise.
+
+
join(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a product of a promise into just a promise.
+
+
join(Array<Array<A>>) - Static method in class fj.data.Array
+
+
Joins the given array of arrays using a bind operation.
+
+
join() - Static method in class fj.data.Array
+
+
A first-class version of join
+
+
join(IO<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
join(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Joins an Iterable of Iterables into a single Iterable.
+
+
join() - Static method in class fj.data.IterableW
+
+
Returns a function that joins an Iterable of Iterables into a single Iterable.
+
+
join(List<List<A>>) - Static method in class fj.data.List
+
+
Joins the given list of lists using a bind operation.
+
+
join() - Static method in class fj.data.List
+
+
A first-class version of join
+
+
join(NonEmptyList<NonEmptyList<A>>) - Static method in class fj.data.NonEmptyList
+
+
Concatenate (join) a non empty list of non empty lists.
+
+
join(Option<Option<A>>) - Static method in class fj.data.Option
+
+
Joins the given optional value of optional value using a bind operation.
+
+
join() - Static method in class fj.data.Option
+
+
First-class join function.
+
+
join(Ord<A>, Set<Set<A>>) - Static method in class fj.data.Set
+
+
Join a set of sets into a single set.
+
+
join(Stream<Stream<A>>) - Static method in class fj.data.Stream
+
+
Joins the given stream of streams by concatenation.
+
+
join() - Static method in class fj.data.Stream
+
+
A first-class version of join
+
+
join(F<B, F<B, A>>) - Static method in class fj.Function
+
+
Joins two arguments of a function of arity-2 into one argument, yielding a function of arity-1.
+
+
join(Iterable<A>, A) - Method in class fj.Monoid
+
+
Intersperses the given value between each two elements of the iterable, and sums the result.
+
+
join(P1<P1<A>>) - Static method in class fj.P1
+
+
Joins a P1 of a P1 with a bind operation.
+
+
joinLeft(Either<Either<A, B>, B>) - Static method in class fj.data.Either
+
+
Joins an either through left.
+
+
joinLeft(Either3<Either3<A, B, C>, B, C>) - Static method in class fj.data.Either3
+
 
+
joinMiddle(Either3<A, Either3<A, B, C>, C>) - Static method in class fj.data.Either3
+
 
+
joinRight(Either<A, Either<A, B>>) - Static method in class fj.data.Either
+
+
Joins an either through right.
+
+
joinRight(Either3<A, B, Either3<A, B, C>>) - Static method in class fj.data.Either3
+
 
+
+ + + +

K

+
+
keys() - Method in class fj.data.HashMap
+
+
Returns all key entries in this hash map.
+
+
keys() - Method in class fj.data.TreeMap
+
+
Returns all keys in this tree map.
+
+
+ + + +

L

+
+
last() - Method in class fj.data.fingertrees.Deep
+
 
+
last() - Method in class fj.data.fingertrees.Empty
+
 
+
last() - Method in class fj.data.fingertrees.FingerTree
+
+
The last element of this tree.
+
+
last() - Method in class fj.data.fingertrees.Single
+
 
+
last() - Method in class fj.data.List
+
+
Returns the last element of this list.
+
+
last() - Method in class fj.data.Seq
+
+
The last element of this sequence.
+
+
last() - Method in class fj.data.Stream
+
+
Get the last element of this stream.
+
+
lastChild() - Method in class fj.data.TreeZipper
+
+
Navigtes to the last child of the current location.
+
+
lastOptionMonoid() - Static method in class fj.Monoid
+
+
A monoid for options that take the last available value.
+
+
lastOptionSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for optional values that take the last available value.
+
+
lastSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup which always uses the "last" (right-hand side) value.
+
+
later(F0<A>) - Static method in class fj.data.Eval
+
+
Constructs a lazy evaluation with caching.
+
+
lazy(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazy(F<A, Unit>) - Static method in class fj.Effect
+
 
+
lazy() - Method in interface fj.F
+
+
Promotes this function so that it returns its result in a product-1.
+
+
lazy(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using call-by-name semantic: + function f is evaluated at each call to P1._1().
+
+
lazy(F0<A>, F0<B>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>) - Static method in class fj.P
+
 
+
lazy(F0<A>, F0<B>, F0<C>, F0<D>, F0<E>, F0<F>, F0<G>, F0<H>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>) - Static method in class fj.P
+
 
+
lazy(F<Unit, A>, F<Unit, B>, F<Unit, C>, F<Unit, D>, F<Unit, E>, F<Unit, F$>, F<Unit, G>, F<Unit, H>) - Static method in class fj.P
+
 
+
lazyProduct(F0<P2<A, B>>) - Static method in class fj.P
+
 
+
lazySafe(F<Unit, A>) - Static method in class fj.data.IOFunctions
+
 
+
lazySafe(F0<A>) - Static method in class fj.data.IOFunctions
+
 
+
LazyString - Class in fj.data
+
+
A lazy (non-evaluated) immutable character string.
+
+
lazyStringShow - Static variable in class fj.Show
+
+
A show instance for lazy strings.
+
+
LcgRng - Class in fj
+
+
https://en.wikipedia.org/wiki/Linear_congruential_generator
+
+
LcgRng() - Constructor for class fj.LcgRng
+
 
+
LcgRng(long) - Constructor for class fj.LcgRng
+
 
+
leaf(A) - Static method in class fj.data.Tree
+
+
Creates a nullary tree.
+
+
left() - Method in class fj.data.Either
+
+
Projects this either as a left.
+
+
left(A) - Static method in class fj.data.Either
+
+
Construct a left value of either.
+
+
left(A) - Static method in class fj.data.Either3
+
 
+
left() - Method in class fj.data.Either3
+
 
+
left(IO<A>, IO<B>) - Static method in class fj.data.IOFunctions
+
 
+
left() - Method in class fj.data.TreeZipper
+
+
Navigates to the left sibling of the current location.
+
+
left_() - Static method in class fj.data.Either
+
+
A function that constructs a left value of either.
+
+
left_() - Static method in class fj.data.Either3
+
 
+
left_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the left() function.
+
+
leftMap(F<A, X>) - Method in class fj.data.Either
+
+
Map the given function across this either's left projection.
+
+
leftMap(F<A, X>) - Method in class fj.data.Either3
+
 
+
leftMap_() - Static method in class fj.data.Either
+
+
Return a function that maps a given function across this either's left projection.
+
+
leftMap_() - Method in class fj.data.Either3
+
 
+
leftOption() - Method in class fj.data.Either3
+
 
+
lefts(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the left values in the given list.
+
+
lefts() - Method in class fj.data.TreeZipper
+
+
Returns the left siblings of the currently focused node.
+
+
lefts() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the left of focus.
+
+
length() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.Array
+
+
Returns the length of this array.
+
+
length() - Method in class fj.data.fingertrees.Deep
+
 
+
length() - Method in class fj.data.fingertrees.Digit
+
 
+
length() - Method in class fj.data.fingertrees.Empty
+
 
+
length() - Method in class fj.data.fingertrees.FingerTree
+
 
+
length() - Method in class fj.data.fingertrees.Four
+
 
+
length() - Method in class fj.data.fingertrees.Node
+
 
+
length() - Method in class fj.data.fingertrees.Node2
+
 
+
length() - Method in class fj.data.fingertrees.Node3
+
 
+
length() - Method in class fj.data.fingertrees.One
+
 
+
length() - Method in class fj.data.fingertrees.Single
+
 
+
length() - Method in class fj.data.fingertrees.Three
+
 
+
length() - Method in class fj.data.fingertrees.Two
+
 
+
length() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the number of elements in the trie.
+
+
length() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that counts and consumes the elements of the input
+
+
length() - Method in class fj.data.LazyString
+
+
The length of the lazy string.
+
+
length() - Method in class fj.data.List
+
+
The length of this list.
+
+
length() - Method in class fj.data.NonEmptyList
+
+
The length of this list.
+
+
length() - Method in class fj.data.Option
+
+
Returns the length of this optional value; 1 if there is a value, 0 otherwise.
+
+
length() - Method in class fj.data.Seq
+
+
Returns the number of elements in this sequence.
+
+
length() - Method in class fj.data.Stream
+
+
The length of this stream.
+
+
length() - Method in class fj.data.Tree
+
 
+
length() - Method in class fj.data.Zipper
+
+
Returns the length of this zipper.
+
+
length - Static variable in class fj.function.Strings
+
+
A curried version of String.length().
+
+
length_() - Static method in class fj.data.List
+
+
First-class length.
+
+
Lens<S,A> - Class in fj.data.optic
+
+
PLens with a monomorphic set function
+
+
Lens(PLens<S, S, A, A>) - Constructor for class fj.data.optic.Lens
+
 
+
lens(F<S, A>, F<A, F<S, S>>) - Static method in class fj.data.optic.Lens
+
+
create a Lens using a pair of functions: one to get the target, one to set the target.
+
+
levels() - Method in class fj.data.Tree
+
+
Provides a stream of the elements of the tree at each level, in level order.
+
+
lift(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Promotes a function of arity-2 to a higher-order function.
+
+
lift() - Method in class fj.Semigroup
+
+
Lifts the semigroup to obtain a trivial monoid.
+
+
liftM(F<A, B>) - Static method in class fj.control.db.DB
+
+
Promotes any given function so that it transforms between values in the database.
+
+
liftM(F<A, B>, Measured<V, B>) - Static method in class fj.data.fingertrees.Node
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Callables
+
+
Promotes a function of arity-2 to a function on callables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.parallel.Promise
+
+
Promotes a function of arity-2 to a function on promises.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.control.Trampoline
+
+
Promotes the given function of arity-2 to a function on Trampolines.
+
+
liftM2(IO<A>, IO<B>, F2<A, B, C>) - Static method in class fj.data.IOFunctions
+
 
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.IterableW
+
+
Promotes a function of arity-2 to a function on iterables.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.List
+
+
Promotes the given function of arity-2 to a function on lists.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.data.Option
+
+
Promotes a function of arity-2 so that it operates over options.
+
+
liftM2(Option<B>, F2<A, B, C>) - Method in class fj.data.Option
+
+
Lift the function of arity-2 through options.
+
+
liftM2(F<A, F<B, C>>) - Static method in class fj.P1
+
+
Promotes a function of arity-2 to a function on P1s.
+
+
liftM2(P1<B>, F2<A, B, C>) - Method in class fj.P1
+
 
+
lineReader() - Static method in class fj.data.IOFunctions
+
+
A function that feeds an iteratee with lines read from a BufferedReader.
+
+
lines() - Method in class fj.data.LazyString
+
+
Splits this lazy string into lines.
+
+
lines(String) - Static method in class fj.function.Strings
+
 
+
lines() - Static method in class fj.function.Strings
+
 
+
lines_() - Static method in class fj.data.LazyString
+
 
+
lineSeparator - Static variable in class fj.function.Strings
+
 
+
LinkedBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts linked blocking queues to lists.
+
+
LinkedHashSet_List() - Static method in class fj.data.Java
+
+
A function that converts linked hash sets to lists.
+
+
LinkedList_List() - Static method in class fj.data.Java
+
+
A function that converts linked lists to lists.
+
+
list() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that consumes the input elements and returns them as a list in reverse order, + so that the last line is the first element.
+
+
List<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list.
+
+
list(A...) - Static method in class fj.data.List
+
+
Constructs a list from the given elements.
+
+
List.Buffer<A> - Class in fj.data
+
+
A mutable, singly linked list.
+
+
List.Optic - Class in fj.data
+
+
Optic factory methods for a List
+
+
List.Unsafe - Class in fj.data
+
 
+
List_Array() - Static method in class fj.data.Conversions
+
+
A function that converts lists to arrays.
+
+
List_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to array blocking queue.
+
+
List_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to array lists.
+
+
List_BitSet - Static variable in class fj.data.Java
+
+
A function that converts lists to bit sets.
+
+
List_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to concurrent linked queues.
+
+
List_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array lists.
+
+
List_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts lists to copy on write array sets.
+
+
List_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to delay queues.
+
+
List_Either() - Static method in class fj.data.Conversions
+
+
A function that converts lists to eithers.
+
+
List_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts lists to array enum sets.
+
+
List_HashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to hash sets.
+
+
List_JavaStream(List<A>) - Static method in class fj.data.Java8
+
 
+
List_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to linked blocking queues.
+
+
List_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts lists to linked hash sets.
+
+
List_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts lists to linked lists.
+
+
List_Option() - Static method in class fj.data.Conversions
+
+
A function that converts lists to options.
+
+
List_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority blocking queues.
+
+
List_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts lists to priority queues.
+
+
List_Stack() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts lists to streams.
+
+
List_String - Static variable in class fj.data.Conversions
+
+
A function that converts lists to strings.
+
+
List_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string buffers.
+
+
List_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts lists to string builders.
+
+
List_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts lists to synchronous queues.
+
+
List_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts lists to stacks.
+
+
List_Vector() - Static method in class fj.data.Java
+
+
A function that converts lists to vectors.
+
+
listBitSet(List<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
listDList(List<A>) - Static method in class fj.data.DList
+
+
Creates a DList from a List
+
+
listEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the List type.
+
+
listHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the List type.
+
+
listK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result in a List.
+
+
listM() - Method in interface fj.F2
+
+
Promotes this function to a function on Lists.
+
+
listMonoid() - Static method in class fj.Monoid
+
+
A monoid for lists.
+
+
listOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the List type.
+
+
listSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for lists.
+
+
listSeq(List<A>) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given list.
+
+
listShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
log() - Method in class fj.data.Writer
+
 
+
Long_Boolean - Static variable in class fj.Primitive
+
+
A function that converts longs to booleans.
+
+
Long_Byte - Static variable in class fj.Primitive
+
+
A function that converts longs to bytes.
+
+
Long_Character - Static variable in class fj.Primitive
+
+
A function that converts longs to characters.
+
+
Long_Double - Static variable in class fj.Primitive
+
+
A function that converts longs to doubles.
+
+
Long_Float - Static variable in class fj.Primitive
+
+
A function that converts longs to floats.
+
+
Long_Integer - Static variable in class fj.Primitive
+
+
A function that converts longs to integers.
+
+
Long_Short - Static variable in class fj.Primitive
+
+
A function that converts longs to shorts.
+
+
longAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds longs.
+
+
longAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds longs.
+
+
longBitSet(long) - Static method in class fj.data.hamt.BitSet
+
 
+
longEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for long.
+
+
longEqual - Static variable in class fj.Equal
+
+
An equal instance for the long type.
+
+
longHash - Static variable in class fj.Hash
+
+
A hash instance for the long type.
+
+
longMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of longs.
+
+
longMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of longs.
+
+
longMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies longs.
+
+
longMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies longs.
+
+
longOrd - Static variable in class fj.Ord
+
+
An order instance for the long type.
+
+
Longs - Class in fj.function
+
+
Curried functions over Longs.
+
+
longShow - Static variable in class fj.Show
+
+
A show instance for the long type.
+
+
longValue() - Method in class fj.data.hamt.BitSet
+
 
+
longValue() - Method in class fj.data.Natural
+
+
Return the long value of this natural number.
+
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Deep
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Digit
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Empty
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.FingerTree
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Four
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node2
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Node3
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.One
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Single
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Three
+
 
+
lookup(F<V, Integer>, int) - Method in class fj.data.fingertrees.Two
+
 
+
lookup(Equal<A>, List<P2<A, B>>, A) - Static method in class fj.data.List
+
+
Returns an associated value with the given key in the list of pairs.
+
+
lookup(Equal<A>) - Static method in class fj.data.List
+
+
Returns a partially applied version of List.lookup(Equal, List, Object).
+
+
lookup(A) - Method in class fj.data.Set
+
+
Find element equal to the given one.
+
+
lookupGE(A) - Method in class fj.data.Set
+
+
Find smallest element greater or equal to the given one.
+
+
lookupGT(A) - Method in class fj.data.Set
+
+
Find smallest element greater than the given one.
+
+
lookupLE(A) - Method in class fj.data.Set
+
+
Find largest element smaller or equal to the given one.
+
+
lookupLT(A) - Method in class fj.data.Set
+
+
Find largest element smaller than the given one.
+
+
lower(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lower(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a lower-case character.
+
+
lowSurrogate(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lowSurrogate(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a low-surrogate character.
+
+
lteZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than or equal to zero.
+
+
lteZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than or equal to zero.
+
+
ltZero - Static variable in class fj.function.Doubles
+
+
A function that returns true if the given double is less than zero.
+
+
ltZero - Static variable in class fj.function.Integers
+
+
A function that returns true if the given integer is less than zero.
+
+
+ + + +

M

+
+
MakeTree<V,A> - Class in fj.data.fingertrees
+
+
A builder of trees and tree components, supplied with a particular monoid and measuring function.
+
+
map(F<A, B>) - Method in class fj.control.db.DB
+
+
Map a function over the result of this action.
+
+
map(F<P1<A>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given transformation across this strategy's domain (Invariant Functor pattern).
+
+
map(F<A, B>) - Method in class fj.control.Trampoline
+
+
Maps the given function across the result of this trampoline.
+
+
map(F<A, B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Maps the given function across this array.
+
+
map(F<A, B>) - Method in class fj.data.Array
+
+
Maps the given function across this array.
+
+
map() - Static method in class fj.data.Array
+
+
First-class map function for Arrays.
+
+
map(F<A, X>) - Method in class fj.data.Either.LeftProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<B, X>) - Method in class fj.data.Either.RightProjection
+
+
Map the given function across this projection's value if it has one.
+
+
map(F<A, X>) - Method in class fj.data.Either3.LeftProjection
+
 
+
map(F<B, X>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
map(F<C, X>) - Method in class fj.data.Either3.RightProjection
+
 
+
map(F<A, B>) - Method in class fj.data.Eval
+
+
Transforms Eval into a Eval using + the given function.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Deep
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Digit
+
+
Maps a function across the elements of this digit, measuring with the given measurement.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Empty
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Maps the given function across this tree, measuring with the given Measured instance.
+
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Node
+
 
+
map(F<A, B>, Measured<V, B>) - Method in class fj.data.fingertrees.Single
+
 
+
map(F<K, A>, F<V, B>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<K, A>, F<V, B>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
map(F<P2<K, V>, P2<A, B>>) - Method in class fj.data.HashMap
+
 
+
map(F<A, B>) - Method in interface fj.data.IO
+
 
+
map(IO<A>, F<A, B>) - Static method in class fj.data.IOFunctions
+
 
+
map(F<A, B>) - Method in class fj.data.IterableW
+
+
Maps a given function across the wrapped Iterable.
+
+
map() - Static method in class fj.data.IterableW
+
+
Returns a function that promotes any function so that it operates on Iterables.
+
+
map(F<Character, Character>) - Method in class fj.data.LazyString
+
 
+
map(F<A, B>) - Method in class fj.data.List
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across this list.
+
+
map(F<A, B>) - Method in class fj.data.Option
+
+
Maps the given function across this optional value.
+
+
map() - Static method in class fj.data.Option
+
+
A first-class map function.
+
+
map(F<A, B>) - Method in class fj.data.PriorityQueue
+
+
Maps the values in each node with function f.
+
+
map(F<B, C>) - Method in class fj.data.Reader
+
 
+
map(F<A, B>) - Method in class fj.data.Seq
+
 
+
map(Ord<B>, F<A, B>) - Method in class fj.data.Set
+
+
Maps the given function across this set.
+
+
map(F<A, B>) - Method in class fj.data.State
+
 
+
map(F<A, B>) - Method in class fj.data.Stream
+
+
Maps the given function across this stream.
+
+
map(F<V, W>) - Method in class fj.data.TreeMap
+
+
Maps the given function across the values of this TreeMap.
+
+
map(F<A, B>) - Method in class fj.data.TreeZipper
+
+
Maps the given function across this zipper (covariant functor pattern).
+
+
map(F<E, A>) - Method in class fj.data.Validation.FailProjection
+
+
Maps the given function across the failing side of this validation.
+
+
map(F<T, A>) - Method in class fj.data.Validation
+
+
Maps the given function across the success side of this validation.
+
+
map(F<A, B>) - Method in class fj.data.vector.V2
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V3
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V4
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V5
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V6
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V7
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.vector.V8
+
+
Maps the given function across this vector.
+
+
map(F<A, B>) - Method in class fj.data.Writer
+
 
+
map(F<A, B>) - Method in class fj.data.Zipper
+
+
Maps the given function across the elements of this zipper (covariant functor pattern).
+
+
map(F<B, C>) - Method in interface fj.F
+
 
+
map(F<C, Z>) - Method in interface fj.F2
+
 
+
map(F<Unit, C>) - Method in interface fj.function.Effect1
+
 
+
map(F<A, B>) - Method in class fj.P1
+
+
Map the element of the product.
+
+
map(F<A, B>, P2<A, A>) - Static method in class fj.P2
+
+
Maps the given function across both the elements of the given product.
+
+
map(F<A, B>) - Method in class fj.parser.Parser
+
+
Maps the given result type across this parser.
+
+
map1(F<A, X>) - Method in class fj.P2
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P3
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P4
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P5
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P6
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P7
+
+
Map the first element of the product.
+
+
map1(F<A, X>) - Method in class fj.P8
+
+
Map the first element of the product.
+
+
map1_(F<A, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the first element of a product.
+
+
map2(F<B, X>) - Method in class fj.P2
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P3
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P4
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P5
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P6
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P7
+
+
Map the second element of the product.
+
+
map2(F<B, X>) - Method in class fj.P8
+
+
Map the second element of the product.
+
+
map2_(F<B, X>) - Static method in class fj.P2
+
+
Promotes a function so that it maps the second element of a product.
+
+
map3(F<A, X>, F<B, Y>, F<C, Z>) - Method in class fj.data.Either3
+
 
+
map3(F<C, X>) - Method in class fj.P3
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P4
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P5
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P6
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P7
+
+
Map the third element of the product.
+
+
map3(F<C, X>) - Method in class fj.P8
+
+
Map the third element of the product.
+
+
map4(F<D, X>) - Method in class fj.P4
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P5
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P6
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P7
+
+
Map the fourth element of the product.
+
+
map4(F<D, X>) - Method in class fj.P8
+
+
Map the fourth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P5
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P6
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P7
+
+
Map the fifth element of the product.
+
+
map5(F<E, X>) - Method in class fj.P8
+
+
Map the fifth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P6
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P7
+
+
Map the sixth element of the product.
+
+
map6(F<F, X>) - Method in class fj.P8
+
+
Map the sixth element of the product.
+
+
map7(F<G, X>) - Method in class fj.P7
+
+
Map the seventh element of the product.
+
+
map7(F<G, X>) - Method in class fj.P8
+
+
Map the seventh element of the product.
+
+
map8(F<H, X>) - Method in class fj.P8
+
+
Map the eighth element of the product.
+
+
map_() - Static method in class fj.control.Trampoline
+
 
+
map_() - Static method in class fj.data.List
+
+
Provides a first-class version of map()
+
+
map_() - Static method in class fj.data.Stream
+
+
Provides a first-class version of the map function.
+
+
map_(F<A, B>) - Static method in class fj.P1
+
+
Promote any function to a transformation between P1s.
+
+
mapArray() - Method in interface fj.F
+
+
Promotes this function to map over a Array.
+
+
mapBoth() - Method in interface fj.F
+
+
Promotes this function to map over both elements of a pair.
+
+
mapError(F<E, K>) - Method in class fj.parser.Parser
+
+
Maps the given function across this parser's error.
+
+
mapFail() - Method in interface fj.F
+
+
Promotes this function to map over the failure side of a Validation.
+
+
mapFst() - Method in interface fj.F
+
+
Promotes this function to map over the first element of a pair.
+
+
mapIterable() - Method in interface fj.F
+
+
Promotes this function to map over Iterables.
+
+
mapJ(SynchronousQueue<A>) - Method in interface fj.F
+
+
Maps this function over a SynchronousQueue.
+
+
mapJ(PriorityBlockingQueue<A>) - Method in interface fj.F
+
+
Maps this function over a PriorityBlockingQueue.
+
+
mapJ(LinkedBlockingQueue<A>) - Method in interface fj.F
+
+
Maps this function over a LinkedBlockingQueue.
+
+
mapJ(CopyOnWriteArraySet<A>) - Method in interface fj.F
+
+
Maps this function over a CopyOnWriteArraySet.
+
+
mapJ(CopyOnWriteArrayList<A>) - Method in interface fj.F
+
+
Maps this function over a CopyOnWriteArrayList.
+
+
mapJ(ConcurrentLinkedQueue<A>) - Method in interface fj.F
+
+
Maps this function over a ConcurrentLinkedQueue.
+
+
mapJ(ArrayBlockingQueue<A>) - Method in interface fj.F
+
+
Maps this function over an ArrayBlockingQueue.
+
+
mapJ(TreeSet<A>) - Method in interface fj.F
+
+
Maps this function over a TreeSet.
+
+
mapJ(PriorityQueue<A>) - Method in interface fj.F
+
+
Maps this function over a PriorityQueue.
+
+
mapJ(LinkedList<A>) - Method in interface fj.F
+
+
Maps this function over a LinkedList.
+
+
mapJ(ArrayList<A>) - Method in interface fj.F
+
+
Maps this function over an ArrayList.
+
+
mapKeys(F<K, A>, Equal<A>, Hash<A>) - Method in class fj.data.HashMap
+
 
+
mapKeys(F<K, A>) - Method in class fj.data.HashMap
+
 
+
mapLeft() - Method in interface fj.F
+
+
Promotes this function to map over the left side of an Either.
+
+
mapList() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a List inside a promise.
+
+
mapList() - Method in interface fj.F
+
+
Promotes this function to map over a List.
+
+
mapM(List<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given List, yielding a promise of a List of results.
+
+
mapM(Stream<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Takes a Promise-valued function and applies it to each element + in the given Stream, yielding a promise of a Stream of results.
+
+
mapM(P1<A>, F<A, Promise<B>>) - Method in class fj.control.parallel.ParModule
+
+
Maps a concurrent function over a Product-1 inside a Promise.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.List
+
+
Maps the given function of arity-2 across this list and returns a function that applies all the resulting + functions to a given argument.
+
+
mapM(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Maps the given function of arity-2 across this stream and returns a function that applies all the resulting + functions to a given argument.
+
+
mapMOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Option monad.
+
+
mapMTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
+
Maps the given function across this list by binding through the Trampoline monad.
+
+
mapNel() - Method in interface fj.F
+
+
Promotes this function to map over a NonEmptyList.
+
+
mapOption() - Method in interface fj.F
+
+
Promotes this function to map over an optional value.
+
+
mapP1() - Method in interface fj.F
+
+
Promotes this function to map over a product-1.
+
+
mapPromise() - Method in interface fj.F
+
+
Promotes this function to map over a Promise.
+
+
mapRest(F<I, J>) - Method in class fj.parser.Result
+
+
Maps the given function across the remainder of the parse input.
+
+
mapRest() - Method in class fj.parser.Result
+
+
First-class function mapping across the remainder of the parse input.
+
+
mapRight() - Method in interface fj.F
+
+
Promotes this function to map over the right side of an Either.
+
+
mapSet(Ord<B>) - Method in interface fj.F
+
+
Promotes this function to map over a Set.
+
+
mapSnd() - Method in interface fj.F
+
+
Promotes this function to map over the second element of a pair.
+
+
mapState(F<P2<S, A>, P2<S, B>>) - Method in class fj.data.State
+
 
+
mapStream() - Method in class fj.control.parallel.ParModule
+
+
First-class function that maps a concurrent function over a Stream inside a promise.
+
+
mapStream() - Method in interface fj.F
+
+
Promotes this function to map over a Stream.
+
+
mapSuccess() - Method in interface fj.F
+
+
Promotes this function to map over the success side of a Validation.
+
+
mapTails(F<NonEmptyList<A>, B>) - Method in class fj.data.NonEmptyList
+
+
Maps the given function across the tails of this list (comonad pattern).
+
+
mapTree() - Method in interface fj.F
+
+
Promotes this function to map over a Tree.
+
+
mapTreeZipper() - Method in interface fj.F
+
+
Promotes this function to map over a TreeZipper.
+
+
mapValue(F<A, B>) - Method in class fj.parser.Result
+
+
Maps the given function across the parse value.
+
+
mapValue() - Method in class fj.parser.Result
+
+
First-class function mapping across the parse value.
+
+
mapValues(F<V, B>) - Method in class fj.data.HashMap
+
 
+
mapZipper() - Method in interface fj.F
+
+
Promotes this function to map over a Zipper.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Deep
+
+
Pattern matching on the tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Digit
+
+
Structural pattern matching on digits.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Empty
+
+
Pattern matching on the structure of this tree.
+
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Provides pattern matching on trees.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Four
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node2
+
 
+
match(F<Node2<V, A>, B>, F<Node3<V, A>, B>) - Method in class fj.data.fingertrees.Node3
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.One
+
 
+
match(F<Empty<V, A>, B>, F<Single<V, A>, B>, F<Deep<V, A>, B>) - Method in class fj.data.fingertrees.Single
+
+
Pattern matching on the structure of this tree.
+
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Three
+
 
+
match(F<One<V, A>, B>, F<Two<V, A>, B>, F<Three<V, A>, B>, F<Four<V, A>, B>) - Method in class fj.data.fingertrees.Two
+
 
+
match(F<P2<K, V>, B>, F<HashArrayMappedTrie<K, V>, B>) - Method in class fj.data.hamt.Node
+
+
Performs a reduction on this Node using the given arguments.
+
+
matches(String) - Method in class fj.data.LazyString
+
+
Regular expression pattern matching.
+
+
matches - Static variable in class fj.function.Strings
+
+
A curried version of String.matches(String).
+
+
max() - Method in interface fj.Bounded.Definition
+
 
+
max() - Method in class fj.Bounded
+
 
+
max() - Method in class fj.data.Enumerator
+
+
Returns the maximum value for this enumerator if there is one.
+
+
max() - Method in class fj.data.Set
+
 
+
max() - Method in class fj.data.TreeMap
+
+
Returns the maximum (key, value) pair in the tree if the tree is not empty.
+
+
max - Variable in class fj.Ord
+
+
A function that returns the greater of its two arguments.
+
+
max(A, A) - Method in class fj.Ord
+
+
Returns the greater of its two arguments.
+
+
MAX_BIT_INDEX - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_BIT_SIZE - Static variable in class fj.data.hamt.BitSet
+
 
+
MAX_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
maximum(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maximum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the maximum element in this non empty list according to the given ordering.
+
+
maximumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the maximum element in this list according to the given ordering.
+
+
maxKey() - Method in class fj.data.TreeMap
+
+
Returns the maximum key in the tree if the tree is not empty.
+
+
maxMonoid(A) - Method in class fj.Ord
+
 
+
maxSemigroup() - Method in class fj.Ord
+
 
+
measure() - Method in class fj.data.fingertrees.Deep
+
+
Returns the sum of the measurements of this tree's elements, according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Digit
+
+
Returns the sum of the measurements of this digit according to the monoid.
+
+
measure() - Method in class fj.data.fingertrees.Empty
+
+
Returns zero.
+
+
measure() - Method in class fj.data.fingertrees.FingerTree
+
+
Returns the sum of this tree's annotations.
+
+
measure() - Method in class fj.data.fingertrees.Measured
+
+
Returns the measuring function.
+
+
measure(A) - Method in class fj.data.fingertrees.Measured
+
+
Measures a given element.
+
+
measure() - Method in class fj.data.fingertrees.Node
+
 
+
measure() - Method in class fj.data.fingertrees.Single
+
+
Returns the annotation of this tree's single element.
+
+
measured() - Method in class fj.data.fingertrees.FingerTree
+
 
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Constructs a Measured instance for the element type, given a monoid and a measuring function.
+
+
Measured<V,A> - Class in fj.data.fingertrees
+
+
Determines how the elements of a tree are measured and how measures are summed.
+
+
measured(Monoid<V>, F<A, V>) - Static method in class fj.data.fingertrees.Measured
+
 
+
member(A) - Method in class fj.data.Set
+
+
Checks if the given element is a member of this set.
+
+
member() - Static method in class fj.data.Set
+
+
First-class membership check.
+
+
memo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using weak call-by-need semantic using P.weakMemo(F0).
+
+
memo() - Method in class fj.P1
+
+
Wrap the memoized value into a WeakReference.
+
+
memo() - Method in class fj.P2
+
+
Provides a memoising P2 that remembers its values.
+
+
memo() - Method in class fj.P3
+
+
Provides a memoising P3 that remembers its values.
+
+
memo() - Method in class fj.P4
+
+
Provides a memoising P4 that remembers its values.
+
+
memo() - Method in class fj.P5
+
+
Provides a memoising P5 that remembers its values.
+
+
memo() - Method in class fj.P6
+
+
Provides a memoising P6 that remembers its values.
+
+
memo() - Method in class fj.P7
+
+
Provides a memoising P7 that remembers its values.
+
+
memo() - Method in class fj.P8
+
+
Provides a memoising P8 that remembers its values.
+
+
mergeAll(List<Future<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Waits for every Future in a list to obtain a value, and collects those values in a list.
+
+
middle(B) - Static method in class fj.data.Either3
+
 
+
middle() - Method in class fj.data.Either3
+
 
+
middle() - Method in class fj.data.fingertrees.Deep
+
+
Returns a finger tree of the inner nodes of this tree.
+
+
middleMap(F<B, X>) - Method in class fj.data.Either3
+
 
+
middleMap_() - Method in class fj.data.Either3
+
 
+
middleOption() - Method in class fj.data.Either3
+
 
+
min() - Method in interface fj.Bounded.Definition
+
 
+
min() - Method in class fj.Bounded
+
 
+
min() - Method in class fj.data.Enumerator
+
+
Returns the minimum value for this enumerator if there is one.
+
+
min() - Method in class fj.data.Set
+
 
+
min() - Method in class fj.data.TreeMap
+
+
Returns the minimum (key, value) pair in the tree if the tree is not empty.
+
+
min - Variable in class fj.Ord
+
+
A function that returns the lesser of its two arguments.
+
+
min(A, A) - Method in class fj.Ord
+
+
Returns the lesser of its two arguments.
+
+
MIN_INDEX - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
minimum(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minimum(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Returns the minimum element in this non empty list according to the given ordering.
+
+
minimumOption(Ord<A>) - Method in class fj.data.List
+
+
Returns the minimum element in this list according to the given ordering.
+
+
minKey() - Method in class fj.data.TreeMap
+
+
Returns the minimum key in the tree if the tree is not empty.
+
+
minMonoid(A) - Method in class fj.Ord
+
 
+
minSemigroup() - Method in class fj.Ord
+
 
+
minus(Equal<A>, List<A>) - Method in class fj.data.List
+
+
Returns a new list of all the items in this list that do not appear in the given list.
+
+
minus(Set<A>) - Method in class fj.data.Set
+
+
Remove all elements from this set that occur in the given set.
+
+
minus() - Static method in class fj.data.Set
+
+
A first class function for Set.minus(Set).
+
+
minus(Equal<A>, Stream<A>) - Method in class fj.data.Stream
+
+
Returns a new stream of all the items in this stream that do not appear in the given stream.
+
+
mirrored(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mirrored(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a mirrored character.
+
+
mkTree(Measured<V, A>) - Static method in class fj.data.fingertrees.FingerTree
+
+
Returns a builder of trees and tree components that annotates them using the given Measured instance.
+
+
mod - Static variable in class fj.data.Natural
+
+
A function that yields the remainder of division of its second argument by its first.
+
+
mod(Natural) - Method in class fj.data.Natural
+
+
Take the remainder of a natural number division.
+
+
mode(Ord<A>) - Method in class fj.data.List
+
+
Returns the most common element in this list.
+
+
modify(F<A, A>) - Method in class fj.data.optic.Lens
+
 
+
modify(F<A, A>) - Method in class fj.data.optic.Optional
+
 
+
modify(F<A, B>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens using a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PSetter
+
+
modify polymorphically the target of a PSetter with a function
+
+
modify(F<A, B>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with a function
+
+
modify(F<A, A>) - Method in class fj.data.optic.Setter
+
 
+
modify(F<S, S>) - Static method in class fj.data.State
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyEitherF(F<A, Either<L, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyEitherF(F<A, Either<L, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyFunctionF(F<A, F<C, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyFunctionF(F<A, F<C, A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyIOF(F<A, IO<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyIOF(F<A, IO<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyLabel(F<A, A>) - Method in class fj.data.TreeZipper
+
+
Modifies the label at the current node with the given function.
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyListF(F<A, List<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyListF(F<A, List<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyOption(F<A, B>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with a function.
+
+
modifyOption(F<A, B>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with a function.
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyOptionF(F<A, Option<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyOptionF(F<A, Option<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyP1F(F<A, P1<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyP1F(F<A, P1<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyPromiseF(F<A, Promise<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyPromiseF(F<A, Promise<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyStreamF(F<A, Stream<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyStreamF(F<A, Stream<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyTrampolineF(F<A, Trampoline<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyTree(F<Tree<A>, Tree<A>>) - Method in class fj.data.TreeZipper
+
+
Modifies the current node with the given function.
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyV2F(F<A, V2<B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyV2F(F<A, V2<A>>) - Method in class fj.data.optic.Traversal
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Lens
+
 
+
modifyValidationF(F<A, Validation<E, A>>) - Method in class fj.data.optic.Optional
+
 
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PIso
+
+
modify polymorphically the target of a PIso with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PLens
+
+
modify polymorphically the target of a PLens with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.POptional
+
+
modify polymorphically the target of a POptional with an Applicative function
+
+
modifyValidationF(F<A, Validation<E, B>>) - Method in class fj.data.optic.PPrism
+
+
modify polymorphically the target of a PPrism with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.optic.PTraversal
+
+
modify polymorphically the target of a PTraversal with an Applicative function
+
+
modifyValidationF(Semigroup<E>, F<A, Validation<E, A>>) - Method in class fj.data.optic.Traversal
+
 
+
monoid() - Method in class fj.data.fingertrees.Measured
+
+
Returns the monoid used to sum measures.
+
+
monoid() - Method in class fj.data.Writer
+
 
+
Monoid<A> - Class in fj
+
+
A monoid abstraction to be defined across types of the given type argument.
+
+
monoid(F<A, F<A, A>>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(F2<A, A, A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given sum function and zero value, which must follow the monoidal + laws.
+
+
monoid(A) - Method in class fj.Semigroup
+
+
Constructs a monoid from this semigroup and a zero value, which must follow the monoidal laws.
+
+
Monoid.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Monoid: alternative minimal definition and overridable methods.
+
+
Monoid.Definition<A> - Interface in fj
+
+
Primitives functions of Monoid: minimal definition and overridable methods.
+
+
monoidDef(Monoid.Definition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Monoid.AltDefinition<A>) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given definition, which must follow the monoidal + laws.
+
+
monoidDef(Semigroup.Definition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
monoidDef(Semigroup.AltDefinition<A>, A) - Static method in class fj.Monoid
+
+
Constructs a monoid from the given semigroup definition and zero value, which must follow the monoidal laws.
+
+
move(int) - Method in class fj.data.Zipper
+
+
Move the focus to the specified index.
+
+
move() - Static method in class fj.data.Zipper
+
+
A first-class version of the move function.
+
+
moveLeft() - Method in class fj.data.Either3
+
 
+
moveRight() - Method in class fj.data.Either3
+
 
+
multiply - Static variable in class fj.data.Natural
+
+
A function that multiplies a natural number by another.
+
+
multiply(Natural) - Method in class fj.data.Natural
+
+
Multiply a natural number by another.
+
+
multiply - Static variable in class fj.function.BigIntegers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Doubles
+
+
Curried Double multiplication.
+
+
multiply - Static variable in class fj.function.Integers
+
+
Curried Integer multiplication.
+
+
multiply - Static variable in class fj.function.Longs
+
+
Curried Long multiplication.
+
+
multiply(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply(int, A) - Method in class fj.Monoid
+
+
Returns a value summed n times (a + a + ...
+
+
multiply1p(int, A) - Method in interface fj.Monoid.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Ord.Definition
+
 
+
multiply1p(int, A) - Method in interface fj.Semigroup.Definition
+
 
+
multiply1p(int, A) - Method in class fj.Semigroup
+
+
Returns a value summed n + 1 times ( + a + a + ...
+
+
+ + + +

N

+
+
Natural - Class in fj.data
+
+
Represents a natural number (zero, one, two, etc.)
+
+
natural(BigInteger) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given BigInteger
+
+
natural(long) - Static method in class fj.data.Natural
+
+
Returns the natural number equal to the given long
+
+
naturalAdditionMonoid - Static variable in class fj.Monoid
+
+
A monoid that adds natural numbers.
+
+
naturalAdditionSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that adds natural numbers.
+
+
naturalEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Natural
+
+
naturalEqual - Static variable in class fj.Equal
+
+
An equal instance for the Natural type.
+
+
naturalHash - Static variable in class fj.Hash
+
+
A hash instance for the Natural type.
+
+
naturalMaximumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the maximum of natural numbers.
+
+
naturalMinimumSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that yields the minimum of natural numbers.
+
+
naturalMultiplicationMonoid - Static variable in class fj.Monoid
+
+
A monoid that multiplies natural numbers.
+
+
naturalMultiplicationSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that multiplies natural numbers.
+
+
naturalOrd - Static variable in class fj.Ord
+
+
An order instance for the Natural type.
+
+
naturalShow - Static variable in class fj.Show
+
+
A show instance for natural numbers.
+
+
negate - Static variable in class fj.function.BigIntegers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Doubles
+
+
Negation.
+
+
negate - Static variable in class fj.function.Integers
+
+
Negation.
+
+
negate - Static variable in class fj.function.Longs
+
+
Negation.
+
+
nel(A, List<A>) - Static method in class fj.data.NonEmptyList
+
+
Return a non-empty list with the given head and tail.
+
+
nel(A, A...) - Static method in class fj.data.NonEmptyList
+
+
Constructs a non empty list from the given elements.
+
+
nel() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that puts an element into a non-empty list.
+
+
nel() - Method in class fj.data.Validation
+
+
Puts this validation's failing value in a non-empty list if there is one.
+
+
nelK() - Method in interface fj.F
+
+
Promotes this function to return its value in a NonEmptyList.
+
+
nelM() - Method in interface fj.F2
+
+
Promotes this function to a function on non-empty lists.
+
+
next() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the next element in the list.
+
+
next_() - Static method in class fj.data.Zipper
+
+
First-class version of the next() function.
+
+
nextInt() - Method in class fj.LcgRng
+
 
+
nextInt() - Method in class fj.Rng
+
 
+
nextLong() - Method in class fj.LcgRng
+
 
+
nextLong() - Method in class fj.Rng
+
 
+
nextNatural() - Method in class fj.Rng
+
 
+
nif - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not if" (reverse nonimplication).
+
+
nil() - Static method in class fj.data.DList
+
+
A empty DList.
+
+
nil() - Static method in class fj.data.hlist.HList
+
+
Returns the empty list.
+
+
nil() - Static method in class fj.data.List
+
+
Returns an empty list.
+
+
nil() - Static method in class fj.data.List.Optic
+
+
Nil prism
+
+
nil() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nil_() - Static method in class fj.data.Stream
+
+
Returns an empty stream.
+
+
nimp - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not implies" (nonimplication).
+
+
Node<V,A> - Class in fj.data.fingertrees
+
+
An inner node of the 2-3 tree.
+
+
Node<K,V> - Class in fj.data.hamt
+
+
A Hash Array Mapped Trie node that is either a key-value pair or a + Hash Array Mapped Trie.
+
+
Node(Either<P2<K, V>, HashArrayMappedTrie<K, V>>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(P2<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
Node(HashArrayMappedTrie<K, V>) - Constructor for class fj.data.hamt.Node
+
 
+
node(A, P1<Stream<Tree<A>>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, Stream<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new tree given a root and a (potentially infinite) subforest.
+
+
node(A, List<Tree<A>>) - Static method in class fj.data.Tree
+
+
Creates a new n-ary given a root and a subforest of length n.
+
+
node() - Static method in class fj.data.Tree
+
+
First-class constructor of trees.
+
+
node2(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node.
+
+
node2(V2<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A binary tree node
+
+
Node2<V,A> - Class in fj.data.fingertrees
+
+
A two-element inner tree node.
+
+
node3(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node.
+
+
node3(V3<A>) - Method in class fj.data.fingertrees.MakeTree
+
+
A trinary tree node
+
+
Node3<V,A> - Class in fj.data.fingertrees
+
+
A three-element inner tree node.
+
+
nodeMeasured() - Method in class fj.data.fingertrees.Measured
+
+
A measured instance for nodes.
+
+
nodeShow(Show<V>, Show<A>) - Static method in class fj.Show
+
 
+
none() - Static method in class fj.data.Option
+
+
Constructs an optional value that has no value.
+
+
none() - Static method in class fj.data.Option.Optic
+
+
None prism
+
+
none_() - Static method in class fj.data.Option
+
 
+
NonEmptyList<A> - Class in fj.data
+
+
Provides an in-memory, immutable, singly linked list with total head and tail.
+
+
nonEmptyListEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the NonEmptyList type.
+
+
nonEmptyListHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the NonEmptyList type.
+
+
nonEmptyListOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the NonEmptyList type.
+
+
nonEmptyListSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for non-empty lists.
+
+
nonEmptyListShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the NonEmptyList type.
+
+
nor - Static variable in class fj.function.Booleans
+
+
Curried form of logical "not or".
+
+
normalise(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Normalises the given Callable by calling it and wrapping the result in a new Callable.
+
+
normalise() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the normalise function.
+
+
not() - Method in class fj.data.hamt.BitSet
+
 
+
not() - Method in class fj.Equal
+
+
An equal instance, which reverts equality for self
+
+
not - Static variable in class fj.function.Booleans
+
+
Logical negation.
+
+
not(F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
Negates the given predicate.
+
+
not(F0<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
not(E) - Method in class fj.parser.Parser
+
+
Returns a parser that negates this parser.
+
+
notEq(A, A) - Method in class fj.Equal
+
+
Returns true if the two given arguments are not equal, false otherwise.
+
+
now(A) - Static method in class fj.data.Eval
+
+
Constructs an eager evaluation by wrapping the given value.
+
+
nub() - Method in class fj.data.List
+
+
Removes duplicates according to object equality.
+
+
nub(Equal<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given equality.
+
+
nub(Ord<A>) - Method in class fj.data.List
+
+
Removes duplicates according to the given ordering.
+
+
nullable(F<A, B>) - Static method in class fj.Function
+
+
Return a function that inspects the argument of the given function for a null value and if so, does + not apply the value, instead returning an empty optional value.
+
+
nullablefindFirst(List<X>, F0<X>) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value in the given list of optional values.
+
+
nullableVisitor(List<F<A, B>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first non-null value found in the list of visitors after application of the given value, + otherwise returns the given default.
+
+
+ + + +

O

+
+
o(F<C, A>) - Method in interface fj.F
+
+
Function composition
+
+
o() - Method in interface fj.F
+
+
First-class function composition
+
+
o(F<C, A>) - Method in interface fj.function.Effect1
+
 
+
obtain() - Static method in class fj.control.parallel.Strategy
+
+
Returns a function which returns a product-1 which waits for the given Future to obtain a value.
+
+
obtain(Future<A>) - Static method in class fj.control.parallel.Strategy
+
+
Provides a product-1 that waits for the given future to obtain a value.
+
+
on(F<B, A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<A, B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the result of the given function on the opposing projection's + value.
+
+
on(F<T, E>) - Method in class fj.data.Validation.FailProjection
+
+
The failing value or the application of the given function to the success value.
+
+
on(F<E, T>) - Method in class fj.data.Validation
+
+
The success value or the application of the given function to the failing value.
+
+
on(F<A, B>, Equal<B>) - Static method in class fj.Equal
+
+
Begin definition of an equal instance.
+
+
on(F<B, F<B, C>>) - Method in interface fj.F
+
+
Applies this function over the arguments of another function.
+
+
on() - Method in interface fj.F
+
+
Applies this function over the arguments of another function.
+
+
on(F<A, F<A, C>>, F<B, A>) - Static method in class fj.Function
+
+
Applies a given function over the arguments of another function of arity-2.
+
+
on(F<A, B>, Ord<B>) - Static method in class fj.Ord
+
+
Begin definition of an ord instance.
+
+
one(A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of one element.
+
+
One<V,A> - Class in fj.data.fingertrees
+
+
A single-element prefix or suffix of a finger tree.
+
+
ONE - Static variable in class fj.data.Natural
+
+
The natural number one
+
+
onFail() - Method in interface fj.F
+
+
Returns a function that returns the failure side of a given Validation, + or this function applied to the success side.
+
+
onLeft() - Method in interface fj.F
+
+
Returns a function that returns the left side of a given Either, or this function applied to the right side.
+
+
onRight() - Method in interface fj.F
+
+
Returns a function that returns the right side of a given Either, or this function applied to the left side.
+
+
onSuccess() - Method in interface fj.F
+
+
Returns a function that returns the success side of a given Validation, + or this function applied to the failure side.
+
+
option(Callable<A>) - Static method in class fj.control.parallel.Callables
+
+
Turns the given Callable into an optional value.
+
+
option() - Static method in class fj.control.parallel.Callables
+
+
Returns a transformation from a Callable to an optional value.
+
+
Option<A> - Class in fj.data
+
+
An optional value that may be none (no value) or some (a value).
+
+
option(B, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
option(F0<B>, F<A, B>) - Method in class fj.data.Option
+
+
Performs a reduction on this optional value using the given arguments.
+
+
Option.Optic - Class in fj.data
+
 
+
option_(B, F<A, B>) - Static method in class fj.data.Option
+
+
First-class catamorphism for Option: return a function that will performs + a reduction on an optional value using the given arguments.
+
+
Option_Array() - Static method in class fj.data.Conversions
+
+
A function that converts options to arrays.
+
+
Option_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to array blocking queues.
+
+
Option_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to array lists.
+
+
Option_BitSet - Static variable in class fj.data.Java
+
+
A function that converts options to bit sets.
+
+
Option_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts options to concurrent linked queues.
+
+
Option_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array lists.
+
+
Option_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts options to copy on write array sets.
+
+
Option_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts options to delay queues.
+
+
Option_Either() - Static method in class fj.data.Conversions
+
+
A function that converts options to eithers.
+
+
Option_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts options to enum sets.
+
+
Option_HashSet() - Static method in class fj.data.Java
+
+
A function that converts options to hash sets.
+
+
Option_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to linked blocking queues.
+
+
Option_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts options to linked hash sets.
+
+
Option_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts options to linked lists.
+
+
Option_List() - Static method in class fj.data.Conversions
+
+
A function that converts options to lists.
+
+
Option_Optional(Option<A>) - Static method in class fj.data.Java8
+
+
Convert an Option to Optional.
+
+
Option_Optional() - Static method in class fj.data.Java8
+
 
+
Option_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority blocking queues.
+
+
Option_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts options to priority queues.
+
+
Option_PriorityQueueA() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_PriorityQueueB() - Static method in class fj.data.Java
+
+
A function that converts eithers to priority queues.
+
+
Option_Stack() - Static method in class fj.data.Java
+
+
A function that converts options to stacks.
+
+
Option_Stream() - Static method in class fj.data.Conversions
+
+
A function that converts options to streams.
+
+
Option_String - Static variable in class fj.data.Conversions
+
+
A function that converts options to strings.
+
+
Option_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts options to string buffers.
+
+
Option_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts options to string builders.
+
+
Option_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts options to synchronous queues.
+
+
Option_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts options to tree sets.
+
+
Option_Vector() - Static method in class fj.data.Java
+
+
A function that converts options to vectors.
+
+
Optional<S,A> - Class in fj.data.optic
+
+
POptional restricted to monomorphic update
+
+
Optional(POptional<S, S, A, A>) - Constructor for class fj.data.optic.Optional
+
 
+
optional(F<S, Option<A>>, F<A, F<S, S>>) - Static method in class fj.data.optic.Optional
+
 
+
Optional_Option(Optional<A>) - Static method in class fj.data.Java8
+
 
+
Optional_Option() - Static method in class fj.data.Java8
+
 
+
optionEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Option type.
+
+
optionHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Option type.
+
+
optionK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result in an Option.
+
+
optionM() - Method in interface fj.F2
+
+
Promotes this function to a function on Options.
+
+
optionMonoid(Semigroup<A>) - Static method in class fj.Monoid
+
+
Lift a Semigroup<A> for A to a Monoid<Option<A>>, using Option.none() as zero.
+
+
optionOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Option type.
+
+
optionShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Option type.
+
+
or(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
or - Static variable in class fj.function.Booleans
+
+
Curried form of logical "inclusive or" (disjunction).
+
+
or(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
returns composed predicate using disjunction
+
+
or(List<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given list is true.
+
+
or(Stream<Boolean>) - Static method in class fj.function.Booleans
+
+
Returns true if any element of the given stream is true.
+
+
or(F0<Parser<I, A, E>>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(F0<Parser<I, A, E>>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
or(Parser<I, A, E>, Semigroup<E>) - Method in class fj.parser.Parser
+
+
Returns a parser that tries this parser and if it fails, then tries the given parser.
+
+
orAll(List<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given List of predicates
+
+
orAll(Stream<F<A, Boolean>>) - Static method in class fj.function.Booleans
+
+
Returns a composed predicate of given Stream of predicates
+
+
ord() - Method in class fj.data.Set
+
+
Returns the order of this Set.
+
+
ord(Ord<A>) - Static method in class fj.data.Zipper
+
+
An Ord instance for Zippers.
+
+
Ord<A> - Class in fj
+
+
Tests for ordering between two objects.
+
+
ord() - Method in interface fj.Ord.Definition
+
+
Build an ord instance from this definition.
+
+
ord(F<A, F<A, Ordering>>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
ord(F2<A, A, Ordering>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given equality test and ordering function.
+
+
Ord.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Ord: alternative minimal definition and overridable methods.
+
+
Ord.Definition<A> - Interface in fj
+
+
Primitives functions of Ord: minimal definition and overridable methods.
+
+
ordDef(Ord.Definition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
ordDef(Ord.AltDefinition<A>) - Static method in class fj.Ord
+
+
Returns an order instance that uses the given minimal equality test and ordering definition.
+
+
order() - Method in class fj.data.Enumerator
+
+
Returns the ordering for the enumerator.
+
+
Ordering - Enum in fj
+
+
The comparison of two instances of a type may have one of three orderings; less than, equal or + greater than.
+
+
orderingEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for Ordering.
+
+
orderingOrd - Static variable in class fj.Ord
+
+
An order instance for the Ordering type.
+
+
orElse(F0<Option<A>>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orElse(Option<A>) - Method in class fj.data.Option
+
+
Returns this optional value if there is one, otherwise, returns the argument optional value.
+
+
orFail(F0<E>) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orFail(E) - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value or the given value.
+
+
orHead(F0<A>) - Method in class fj.data.List
+
+
Returns the head of this list if there is one or the given argument if this list is empty.
+
+
orHead(F0<A>) - Method in class fj.data.Stream
+
+
Returns the head of this stream if there is one or the given argument if this stream is empty.
+
+
orSome(F0<A>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSome(A) - Method in class fj.data.Option
+
+
Returns the value of this optional value or the given argument.
+
+
orSuccess(F0<T>) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orSuccess(T) - Method in class fj.data.Validation
+
+
Returns the success value or the given value.
+
+
orTail(F0<List<A>>) - Method in class fj.data.List
+
+
Returns the tail of this list if there is one or the given argument if this list is empty.
+
+
orTail(F0<Stream<A>>) - Method in class fj.data.Stream
+
+
Returns the tail of this stream if there is one or the given argument if this stream is empty.
+
+
orValue(F0<A>) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(A) - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or the given argument.
+
+
orValue(B) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the given argument.
+
+
orValue(F0<B>) - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or the given argument.
+
+
orValue(A) - Method in class fj.data.Either3.LeftProjection
+
 
+
orValue(F0<A>) - Method in class fj.data.Either3.LeftProjection
+
 
+
orValue(B) - Method in class fj.data.Either3.MiddleProjection
+
 
+
orValue(F0<B>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
orValue(C) - Method in class fj.data.Either3.RightProjection
+
 
+
orValue(F0<C>) - Method in class fj.data.Either3.RightProjection
+
 
+
+ + + +

P

+
+
p(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
p() - Method in class fj.data.TreeZipper
+
+
Returns the product-4 representation of this zipper.
+
+
p(P2<A, A>) - Static method in class fj.data.vector.V2
+
+
Creates a vector-2 from a homogeneous product-2.
+
+
p() - Method in class fj.data.vector.V2
+
+
Returns a homogeneous product-2 equivalent to this vector.
+
+
p(P3<A, A, A>) - Static method in class fj.data.vector.V3
+
+
Creates a vector-3 from a homogeneous product-3.
+
+
p() - Method in class fj.data.vector.V3
+
+
Returns a homogeneous product-3 equivalent to this vector.
+
+
p(P4<A, A, A, A>) - Static method in class fj.data.vector.V4
+
+
Creates a vector-4 from a homogeneous product-4.
+
+
p() - Method in class fj.data.vector.V4
+
+
Returns a homogeneous product-4 equivalent to this vector.
+
+
p(P5<A, A, A, A, A>) - Static method in class fj.data.vector.V5
+
+
Creates a vector-5 from a homogeneous product-5.
+
+
p() - Method in class fj.data.vector.V5
+
+
Returns a homogeneous product-5 equivalent to this vector.
+
+
p(P6<A, A, A, A, A, A>) - Static method in class fj.data.vector.V6
+
+
Creates a vector-6 from a homogeneous product-6.
+
+
p() - Method in class fj.data.vector.V6
+
+
Returns a homogeneous product-6 equivalent to this vector.
+
+
p(P7<A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V7
+
+
Creates a vector-7 from a homogeneous product-7.
+
+
p() - Method in class fj.data.vector.V7
+
+
Returns a homogeneous product-7 equivalent to this vector.
+
+
p(P8<A, A, A, A, A, A, A, A>) - Static method in class fj.data.vector.V8
+
+
Creates a vector-8 from a homogeneous product-8.
+
+
p() - Method in class fj.data.vector.V8
+
+
Returns a homogeneous product-8 equivalent to this vector.
+
+
p() - Method in class fj.data.Zipper
+
+
Returns the product-3 representation of this Zipper.
+
+
P - Class in fj
+
+
Functions across products.
+
+
p(A) - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
p(A, B) - Static method in class fj.P
+
+
A function that puts elements in a product-2.
+
+
p(A, B, C) - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
p(A, B, C, D) - Static method in class fj.P
+
+
A function that puts elements in a product-4.
+
+
p(A, B, C, D, E) - Static method in class fj.P
+
+
A function that puts elements in a product-5.
+
+
p(A, B, C, D, E, F$) - Static method in class fj.P
+
+
A function that puts elements in a product-6.
+
+
p(A, B, C, D, E, F$, G) - Static method in class fj.P
+
+
A function that puts elements in a product-7.
+
+
p(A, B, C, D, E, F$, G, H) - Static method in class fj.P
+
+
A function that puts elements in a product-8.
+
+
p1() - Static method in class fj.P
+
+
A function that puts an element in a product-1.
+
+
P1<A> - Class in fj
+
 
+
P1() - Constructor for class fj.P1
+
 
+
P1_Callable() - Static method in class fj.data.Java
+
 
+
P1_Supplier(P1<A>) - Static method in class fj.data.Java8
+
 
+
P1_Supplier() - Static method in class fj.data.Java8
+
 
+
p1Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a product-1.
+
+
p1Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a product-1.
+
+
p1Ord(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for a product-1.
+
+
p1Semigroup(Semigroup<A>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for unary products.
+
+
p1Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for the tuple-1 type.
+
+
p1ShowEager(Show<A>) - Static method in class fj.Show
+
 
+
p1ShowLazy(Show<A>) - Static method in class fj.Show
+
 
+
p2() - Static method in class fj.P
+
+
A function that puts an element in a product-2.
+
+
P2<A,B> - Class in fj
+
+
A product-2.
+
+
P2() - Constructor for class fj.P2
+
 
+
P2.Optic - Class in fj
+
+
Optic factory methods for a P2
+
+
p2Equal(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for a product-2.
+
+
p2Hash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for a product-2.
+
+
p2MapShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type in the style of a mapping from A to B.
+
+
p2Node(P2<K, V>) - Static method in class fj.data.hamt.Node
+
 
+
p2Ord(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for a product-2, with the first factor considered most significant.
+
+
p2Ord1(Ord<A>) - Static method in class fj.Ord
+
 
+
p2Ord2(Ord<B>) - Static method in class fj.Ord
+
 
+
p2Semigroup(Semigroup<A>, Semigroup<B>) - Static method in class fj.Semigroup
+
+
A lazy semigroup for binary products.
+
+
p2Show(Show<A>, Show<B>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p2Show(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the tuple-2 type.
+
+
p3() - Static method in class fj.P
+
+
A function that puts elements in a product-3.
+
+
P3<A,B,C> - Class in fj
+
+
A product-3.
+
+
P3() - Constructor for class fj.P3
+
 
+
p3Equal(Equal<A>, Equal<B>, Equal<C>) - Static method in class fj.Equal
+
+
An equal instance for a product-3.
+
+
p3Hash(Hash<A>, Hash<B>, Hash<C>) - Static method in class fj.Hash
+
+
A hash instance for a product-3.
+
+
p3Ord(Ord<A>, Ord<B>, Ord<C>) - Static method in class fj.Ord
+
+
An order instance for a product-3, with the first factor considered most significant.
+
+
p3Show(Show<A>, Show<B>, Show<C>) - Static method in class fj.Show
+
+
A show instance for the tuple-3 type.
+
+
p4() - Static method in class fj.P
+
+
A function that puts an element in a product-4.
+
+
P4<A,B,C,D> - Class in fj
+
+
A product-4.
+
+
P4() - Constructor for class fj.P4
+
 
+
p4Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>) - Static method in class fj.Equal
+
+
An equal instance for a product-4.
+
+
p4Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>) - Static method in class fj.Hash
+
+
A hash instance for a product-4.
+
+
p4Show(Show<A>, Show<B>, Show<C>, Show<D>) - Static method in class fj.Show
+
+
A show instance for the tuple-4 type.
+
+
p5() - Static method in class fj.P
+
+
A function that puts an element in a product-5.
+
+
P5<A,B,C,D,E> - Class in fj
+
+
A product-5.
+
+
P5() - Constructor for class fj.P5
+
 
+
p5Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>) - Static method in class fj.Equal
+
+
An equal instance for a product-5.
+
+
p5Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>) - Static method in class fj.Hash
+
+
A hash instance for a product-5.
+
+
p5Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>) - Static method in class fj.Show
+
+
A show instance for the tuple-5 type.
+
+
p6() - Static method in class fj.P
+
+
A function that puts an element in a product-6.
+
+
P6<A,B,C,D,E,F> - Class in fj
+
+
A product-6.
+
+
P6() - Constructor for class fj.P6
+
 
+
p6Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>) - Static method in class fj.Equal
+
+
An equal instance for a product-6.
+
+
p6Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>) - Static method in class fj.Hash
+
+
A hash instance for a product-6.
+
+
p6Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>) - Static method in class fj.Show
+
+
A show instance for the tuple-6 type.
+
+
p7() - Static method in class fj.P
+
+
A function that puts an element in a product-7.
+
+
P7<A,B,C,D,E,F,G> - Class in fj
+
+
A product-7.
+
+
P7() - Constructor for class fj.P7
+
 
+
p7Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>) - Static method in class fj.Equal
+
+
An equal instance for a product-7.
+
+
p7Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>) - Static method in class fj.Hash
+
+
A hash instance for a product-7.
+
+
p7Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>) - Static method in class fj.Show
+
+
A show instance for the tuple-7 type.
+
+
p8() - Static method in class fj.P
+
+
A function that puts an element in a product-8.
+
+
P8<A,B,C,D,E,F,G,H> - Class in fj
+
+
A product-8.
+
+
P8() - Constructor for class fj.P8
+
 
+
p8Equal(Equal<A>, Equal<B>, Equal<C>, Equal<D>, Equal<E>, Equal<F$>, Equal<G>, Equal<H>) - Static method in class fj.Equal
+
+
An equal instance for a product-8.
+
+
p8Hash(Hash<A>, Hash<B>, Hash<C>, Hash<D>, Hash<E>, Hash<F$>, Hash<G>, Hash<H>) - Static method in class fj.Hash
+
+
A hash instance for a product-8.
+
+
p8Show(Show<A>, Show<B>, Show<C>, Show<D>, Show<E>, Show<F$>, Show<G>, Show<H>) - Static method in class fj.Show
+
+
A show instance for the tuple-8 type.
+
+
p_() - Static method in class fj.data.TreeZipper
+
+
A first-class function that returns the product-4 representation of a given zipper.
+
+
p_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to the equivalent product-2.
+
+
p_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to the equivalent product-3.
+
+
p_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to the equivalent product-4.
+
+
p_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to the equivalent product-5.
+
+
p_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to the equivalent product-6.
+
+
p_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to the equivalent product-7.
+
+
p_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to the equivalent product-8.
+
+
p_() - Static method in class fj.data.Zipper
+
+
A first-class function that yields the product-3 representation of a given Zipper.
+
+
par(P1<A>) - Method in class fj.control.parallel.Strategy
+
+
Apply the strategy to the given product-1.
+
+
parent() - Method in class fj.data.TreeZipper
+
+
Navigates to the parent of the current location.
+
+
parents() - Method in class fj.data.TreeZipper
+
+
Returns the parents of the currently focused node.
+
+
parExtend(Zipper<A>, F<Zipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given zipper in parallel.
+
+
parExtend(Tree<A>, F<Tree<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all subtrees of the given Tree in parallel.
+
+
parExtend(TreeZipper<A>, F<TreeZipper<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all positions of the given TreeZipper in parallel.
+
+
parExtend(NonEmptyList<A>, F<NonEmptyList<A>, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps the given function across all sublists of the given NonEmptyList in parallel.
+
+
parFlatMap(List<A>, F<A, List<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a list-valued function across a list in parallel, concatenating the results into a new list.
+
+
parFlatMap(Stream<A>, F<A, Stream<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds a Stream-valued function across a Stream in parallel, concatenating the results into a new Stream.
+
+
parFlatMap(Array<A>, F<A, Array<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Array-valued function across an Array in parallel, concatenating the results into a new Array.
+
+
parFlatMap(Iterable<A>, F<A, Iterable<B>>) - Method in class fj.control.parallel.ParModule
+
+
Binds an Iterable-valued function across an Iterable in parallel, concatenating the results into a new Iterable.
+
+
parFlatMap(Strategy<List<B>>, F<A, List<B>>, List<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given list, using the given strategy, with a final join.
+
+
parFlatMap(Strategy<Array<B>>, F<A, Array<B>>, Array<A>) - Static method in class fj.control.parallel.Strategy
+
+
Binds the given function in parallel across the given array, using the given strategy, with a final join.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Stream<A>, F<A, B>, Monoid<B>, F<Stream<A>, P2<Stream<A>, Stream<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given stream in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>, F<Iterable<A>, P2<Iterable<A>, Iterable<A>>>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across chunks of the given Iterable in parallel, while folding with + the given monoid.
+
+
parFoldMap(Iterable<A>, F<A, B>, Monoid<B>) - Method in class fj.control.parallel.ParModule
+
+
Maps with the given function across the given iterable in parallel, while folding with + the given monoid.
+
+
parList(List<P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Evaluates a list of product-1s in parallel.
+
+
parListChunk(Strategy<List<A>>, int, List<P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Sequentially evaluates chunks (sub-sequences) of a list in parallel.
+
+
parMap(List<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a list in parallel.
+
+
parMap(NonEmptyList<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a nonempty list in parallel.
+
+
parMap(Stream<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across a Stream in parallel.
+
+
parMap(Iterable<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Iterable in parallel.
+
+
parMap(Array<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps across an Array in parallel.
+
+
parMap(Zipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Zipper in parallel.
+
+
parMap(Tree<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a Tree in parallel.
+
+
parMap(TreeZipper<A>, F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Maps a function across a TreeZipper in parallel.
+
+
parMap(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given list in parallel using this strategy.
+
+
parMap(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given function over the given array in parallel using this strategy.
+
+
parMap1(F<B, A>, List<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over lists.
+
+
parMap1(F<B, A>, Array<B>) - Method in class fj.control.parallel.Strategy
+
+
A strict version of parMap over arrays.
+
+
parMapArray() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an array in parallel.
+
+
parMapArray(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on arrays using this strategy.
+
+
parMapArray() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on arrays.
+
+
parMapArray1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on arrays (parallel array functor).
+
+
parMapIterable() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across an iterable in parallel.
+
+
parMapList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a list in parallel.
+
+
parMapList(F<B, A>) - Method in class fj.control.parallel.Strategy
+
+
Promotes a function to a parallel function on lists using this strategy.
+
+
parMapList() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap on lists.
+
+
parMapList1() - Method in class fj.control.parallel.Strategy
+
+
First-class version of parMap1 on lists (parallel list functor).
+
+
parMapStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps another function across a stream in parallel.
+
+
parMapTree() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that maps across a Tree in parallel.
+
+
ParModule - Class in fj.control.parallel
+
+
A module of higher-order concurrency features.
+
+
parModule(Strategy<Unit>) - Static method in class fj.control.parallel.ParModule
+
+
Constructor method for ParModule
+
+
parse(I) - Method in class fj.parser.Parser
+
+
Parses the input to produce a result or error.
+
+
parseByte - Static variable in class fj.data.Option
+
+
A function that parses a string to a byte.
+
+
parseByte - Static variable in class fj.data.Validation
+
+
A function that parses a string into a byte.
+
+
parseByte(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a byte.
+
+
parseDouble - Static variable in class fj.data.Option
+
+
A function that parses a string to a double.
+
+
parseDouble - Static variable in class fj.data.Validation
+
+
A function that parses a string into a double.
+
+
parseDouble(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a double.
+
+
parseFloat - Static variable in class fj.data.Option
+
+
A function that parses a string to a float.
+
+
parseFloat - Static variable in class fj.data.Validation
+
+
A function that parses a string into a float.
+
+
parseFloat(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a float.
+
+
parseInt - Static variable in class fj.data.Option
+
+
A function that parses a string to an integer.
+
+
parseInt - Static variable in class fj.data.Validation
+
+
A function that parses a string into an integer.
+
+
parseInt(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a integer.
+
+
parseLong - Static variable in class fj.data.Option
+
+
A function that parses a string to a long.
+
+
parseLong - Static variable in class fj.data.Validation
+
+
A function that parses a string into a long.
+
+
parseLong(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a long.
+
+
Parser<I,A,E> - Class in fj.parser
+
+
A parser is a function that takes some input (I) and produces either an error (E) or a parse result (A) and the + remainder of the input.
+
+
parser(F<I, Validation<E, Result<I, A>>>) - Static method in class fj.parser.Parser
+
+
Returns a parser that computes using the given function.
+
+
Parser.CharsParser - Class in fj.parser
+
+
Parsers that accept Stream<Character> input.
+
+
Parser.StreamParser - Class in fj.parser
+
+
Parsers that accept Stream input.
+
+
parseShort - Static variable in class fj.data.Option
+
+
A function that parses a string to a short.
+
+
parseShort - Static variable in class fj.data.Validation
+
+
A function that parses a string into a short.
+
+
parseShort(String) - Static method in class fj.data.Validation
+
+
Parses the given string into a short.
+
+
partial(A) - Method in interface fj.F
+
+
Partial application.
+
+
partial(A) - Method in interface fj.function.Effect1
+
 
+
partialApply2(F<A, F<B, C>>, B) - Static method in class fj.Function
+
+
Partial application of the second argument to the supplied function to get a function of type + A -> C.
+
+
partialApply3(F<A, F<B, F<C, D>>>, C) - Static method in class fj.Function
+
+
Partial application of the third argument to the supplied function to get a function of type + A -> B -> D.
+
+
partialApply4(F<A, F<B, F<C, F<D, E>>>>, D) - Static method in class fj.Function
+
+
Partial application of the fourth argument to the supplied function to get a function of type + A -> B -> C -> E.
+
+
partialApply5(F<A, F<B, F<C, F<D, F<E, F$>>>>>, E) - Static method in class fj.Function
+
+
Partial application of the fifth argument to the supplied function to get a function of type + A -> B -> C -> D -> F$.
+
+
partialApply6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>, F$) - Static method in class fj.Function
+
+
Partial application of the sixth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> G.
+
+
partialApply7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>, G) - Static method in class fj.Function
+
+
Partial application of the seventh argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> H.
+
+
partialApply8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>, H) - Static method in class fj.Function
+
+
Partial application of the eigth argument to the supplied function to get a function of type + A -> B -> C -> D -> E -> F$ -> G -> I.
+
+
partition(int) - Method in class fj.data.List
+
+
Splits this list into lists of the given size.
+
+
partition(F<A, Boolean>) - Method in class fj.data.List
+
+
Partitions the list into a tuple where the first element contains the + items that satisfy the the predicate f and the second element contains the + items that does not.
+
+
partition(List<Validation<A, B>>) - Static method in class fj.data.Validation
+
+
Partitions the list into the list of fails and the list of successes
+
+
parZipArrayWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two arrays in parallel, + using this strategy, calling the function once for each corresponding pair in the arrays, position-wise.
+
+
parZipListWith(F2<B, C, A>) - Method in class fj.control.parallel.Strategy
+
+
Lifts a given function of arity-2 so that it zips together two lists in parallel, + using this strategy, calling the function once for each corresponding pair in the lists, position-wise.
+
+
parZipWith(List<A>, List<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two lists together with a given function, in parallel.
+
+
parZipWith(Stream<A>, Stream<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two streams together with a given function, in parallel.
+
+
parZipWith(Array<A>, Array<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two arrays together with a given function, in parallel.
+
+
parZipWith(Iterable<A>, Iterable<B>, F<A, F<B, C>>) - Method in class fj.control.parallel.ParModule
+
+
Zips two iterables together with a given function, in parallel.
+
+
parZipWith(F2<B, C, A>, List<B>, List<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two lists in parallel using a given function, with this strategy.
+
+
parZipWith(F2<B, C, A>, Array<B>, Array<C>) - Method in class fj.control.parallel.Strategy
+
+
Zips together two arrays in parallel using a given function, with this strategy.
+
+
pCodiagonal() - Static method in class fj.data.optic.PSetter
+
 
+
pCodiagonal() - Static method in class fj.data.optic.PTraversal
+
 
+
peek() - Static method in class fj.data.Iteratee.IterV
+
+
An iteratee that returns the first element of the input
+
+
pId() - Static method in class fj.data.optic.PIso
+
+
create a PIso between any type and itself.
+
+
pId() - Static method in class fj.data.optic.PLens
+
 
+
pId() - Static method in class fj.data.optic.POptional
+
 
+
pId() - Static method in class fj.data.optic.PPrism
+
 
+
pId() - Static method in class fj.data.optic.PSetter
+
 
+
pId() - Static method in class fj.data.optic.PTraversal
+
 
+
PIso<S,T,A,B> - Class in fj.data.optic
+
+
A PIso defines an isomorphism between types S, A and B, T:
+
+
pIso(F<S, A>, F<B, T>) - Static method in class fj.data.optic.PIso
+
+
create a PIso using a pair of functions: one to get the target and one to get the source.
+
+
PLens<S,T,A,B> - Class in fj.data.optic
+
+
A PLens can be seen as a pair of functions: + get: S => A i.e.
+
+
pLens(F<S, A>, F<B, F<S, T>>) - Static method in class fj.data.optic.PLens
+
+
create a PLens using a pair of functions: one to get the target, one to set the target.
+
+
plus() - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(long) - Method in class fj.data.Enumerator
+
+
Returns a function that moves a value along the enumerator a given number of times.
+
+
plus(A, long) - Method in class fj.data.Enumerator
+
+
Moves a value along the enumerator a given number of times.
+
+
POptional<S,T,A,B> - Class in fj.data.optic
+
+
A POptional can be seen as a pair of functions: + getOrModify: S => T \/ A + set : (B, S) => T +
+
+
pOptional(F<S, Either<T, A>>, F<B, F<S, T>>) - Static method in class fj.data.optic.POptional
+
+
create a POptional using the canonical functions: getOrModify and set
+
+
positions() - Method in class fj.data.TreeZipper
+
+
Returns a zipper over the tree of all possible permutations of this tree zipper (comonad pattern).
+
+
positions() - Method in class fj.data.Zipper
+
+
Creates a zipper of variations of this zipper, in which each element is focused, + with this zipper as the focus of the zipper of zippers (comonad pattern).
+
+
power - Static variable in class fj.function.BigIntegers
+
+
Power.
+
+
power - Static variable in class fj.function.Doubles
+
+
Power.
+
+
power - Static variable in class fj.function.Integers
+
+
Power.
+
+
PPrism<S,T,A,B> - Class in fj.data.optic
+
+
A PPrism can be seen as a pair of functions: + getOrModify: S => T \/ A + reverseGet : B => T +
+
+
pPrism(F<S, Either<T, A>>, F<B, T>) - Static method in class fj.data.optic.PPrism
+
+
create a PPrism using the canonical functions: getOrModify and reverseGet
+
+
pred() - Method in class fj.data.Natural
+
+
Return the predecessor of this natural number
+
+
pred_() - Static method in class fj.data.Natural
+
+
First-class predecessor function.
+
+
predecessor() - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator in curried form.
+
+
predecessor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential predecessor of a value for this enumerator.
+
+
prefix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the first few elements of this tree.
+
+
prepend(A) - Method in interface fj.Monoid.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Ord.Definition
+
 
+
prepend(A) - Method in interface fj.Semigroup.AltDefinition
+
 
+
prepend(A) - Method in interface fj.Semigroup.Definition
+
 
+
prependToList(List<A>) - Method in class fj.data.List.Buffer
+
+
Prepends the elements of this buffer to the given list.
+
+
previous() - Method in class fj.data.Zipper
+
+
Possibly moves the focus to the previous element in the list.
+
+
previous_() - Static method in class fj.data.Zipper
+
+
First-class version of the previous() function.
+
+
Primitive - Class in fj
+
+
Functions that convert between Java primitive types.
+
+
print(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream.
+
+
println(A) - Method in class fj.Show
+
+
Prints the given argument to the standard output stream with a new line.
+
+
printlnE(A) - Method in class fj.Show
+
+
Prints the given argument to the standard error stream with a new line.
+
+
PriorityBlockingQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority blocking queues to lists.
+
+
PriorityQueue<K,A> - Class in fj.data
+
+
A priority queue implementation backed by a + FingerTree.
+
+
priorityQueue(Equal<K>, FingerTree<K, P2<K, A>>) - Static method in class fj.data.PriorityQueue
+
+
Creates a priority queue from a finger tree.
+
+
PriorityQueue_List() - Static method in class fj.data.Java
+
+
A function that converts priority queues to lists.
+
+
priorityQueueShow(Show<K>, Show<V>) - Static method in class fj.Show
+
 
+
Prism<S,A> - Class in fj.data.optic
+
+
PPrism restricted to monomorphic update
+
+
Prism(PPrism<S, S, A, A>) - Constructor for class fj.data.optic.Prism
+
 
+
prism(F<S, Option<A>>, F<A, S>) - Static method in class fj.data.optic.Prism
+
 
+
product(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a stream of natural numbers.
+
+
product(List<Natural>) - Static method in class fj.data.Natural
+
+
Takes the product of a list of natural numbers.
+
+
product(Getter<S1, A1>) - Method in class fj.data.optic.Getter
+
+
pair two disjoint Getter
+
+
product(Iso<S1, A1>) - Method in class fj.data.optic.Iso
+
+
pair two disjoint Iso
+
+
product(PIso<S1, T1, A1, B1>) - Method in class fj.data.optic.PIso
+
+
pair two disjoint PIso
+
+
product(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Returns the product of a list of big integers.
+
+
product(List<Double>) - Static method in class fj.function.Doubles
+
+
Returns the product of a list of doubles.
+
+
product(List<Integer>) - Static method in class fj.function.Integers
+
+
Returns the product of a list of integers.
+
+
product(List<Long>) - Static method in class fj.function.Longs
+
+
Returns the product of a list of integers.
+
+
promise() - Method in class fj.control.parallel.Actor
+
+
Transforms this actor to an actor on promises.
+
+
promise(P1<A>) - Method in class fj.control.parallel.ParModule
+
+
Evaluates the given product concurrently and returns a Promise of the result.
+
+
promise() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that evaluates a given product concurrently and returns a Promise of the result.
+
+
promise(F<A, B>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
promise(F2<A, B, C>) - Method in class fj.control.parallel.ParModule
+
+
Promotes the given function to a concurrent function that returns a Promise.
+
+
Promise<A> - Class in fj.control.parallel
+
+
Represents a non-blocking future value.
+
+
promise(Strategy<Unit>, P1<A>) - Static method in class fj.control.parallel.Promise
+
+
Promises to provide the value of the given 1-product, in the future.
+
+
promise(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
Provides a first-class unit function for promises.
+
+
promise(Strategy<Unit>, Callable<A>) - Static method in class fj.control.parallel.Promise
+
+
Provides a promise to call the given Callable in the future.
+
+
promise(Strategy<Unit>, F<A, B>) - Static method in class fj.control.parallel.Promise
+
+
Transforms any function so that it returns a promise of a value instead of an actual value.
+
+
promiseK(Strategy<Unit>) - Method in interface fj.F
+
+
Promotes this function to a concurrent function that returns a Promise of a value.
+
+
promiseM() - Method in interface fj.F2
+
+
Promotes this function to a function on Promises.
+
+
promisePure() - Method in class fj.control.parallel.ParModule
+
+
Returns a function that promotes a given function to a concurrent function that returns a Promise.
+
+
PSetter<S,T,A,B> - Class in fj.data.optic
+
+
A PSetter is a generalisation of Functor map: + map: (A => B) => F[A] => F[B] + modify: (A => B) => S => T +
+
+
pSetter(F<F<A, B>, F<S, T>>) - Static method in class fj.data.optic.PSetter
+
 
+
pSome() - Static method in class fj.data.Option.Optic
+
+
Polymorphic Some prism
+
+
pTraversal() - Static method in class fj.data.List.Optic
+
+
Polymorphic traversal
+
+
PTraversal<S,T,A,B> - Class in fj.data.optic
+
+
A PTraversal can be seen as a POptional generalised to 0 to n targets where n can be infinite.
+
+
PTraversal() - Constructor for class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F3<B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F4<B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pTraversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<B, B, B, B, B, B, S, T>) - Static method in class fj.data.optic.PTraversal
+
 
+
pure() - Static method in class fj.control.Trampoline
+
 
+
pure(A) - Static method in class fj.control.Trampoline
+
+
Constructs a pure computation that results in the given value.
+
+
put(S) - Static method in class fj.data.State
+
 
+
+ + + +

Q

+
+
queueActor(Strategy<Unit>, Effect1<T>) - Static method in class fj.control.parallel.Actor
+
+
An Actor equipped with a queue and which is guaranteed to process one message at a time.
+
+
+ + + +

R

+
+
range(int, int) - Static method in class fj.data.Array
+
+
Returns an array of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, int) - Method in class fj.data.hamt.BitSet
+
+
Returns the bit set from indices in the range from low (inclusive) + to high(exclusive) from the least significant bit (on the right), + e.g.
+
+
range(int, int) - Static method in class fj.data.List
+
+
Returns a list of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(int, long) - Static method in class fj.data.Stream
+
+
Returns a stream of integers from the given from value (inclusive) to the given + to value (exclusive).
+
+
range(Enumerator<A>, A, A) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at increments of + 1.
+
+
range(Enumerator<A>, A, A, long) - Static method in class fj.data.Stream
+
+
Returns a stream using the given enumerator from the given value to the other given value stepping at the given + increment.
+
+
range(int) - Static method in class fj.data.Stream
+
+
Returns an infinite stream of integers from the given from value (inclusive).
+
+
range(int, int) - Method in class fj.Rng
+
 
+
re() - Method in class fj.data.optic.PPrism
+
+
create a Getter from the modified target to the modified source of a PPrism
+
+
reader(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state reader given a connection URL.
+
+
reader(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new reader that reads the database via the given Connector.
+
+
Reader<A,B> - Class in fj.data
+
+
The Reader monad (also called the function monad, so equivalent to the idea of F).
+
+
Reader(F<A, B>) - Constructor for class fj.data.Reader
+
 
+
readerState() - Static method in class fj.data.IOFunctions
+
 
+
reduce(Either<A, A>) - Static method in class fj.data.Either
+
+
Takes an Either to its contained value within left or right.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the left with the given function.
+
+
reduceLeft(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Deep
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Digit
+
+
Folds this digit to the right using the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Empty
+
 
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.FingerTree
+
+
Folds the tree to the right with the given function.
+
+
reduceRight(F<A, F<A, A>>) - Method in class fj.data.fingertrees.Single
+
 
+
remainder - Static variable in class fj.function.BigIntegers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Doubles
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Integers
+
+
Remainder.
+
+
remainder - Static variable in class fj.function.Longs
+
+
Remainder.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.List
+
+
Filters elements from this list by returning only elements which produce false when + the given function is applied to them.
+
+
removeAll(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Filters elements from this stream by returning only elements which produce false when + the given function is applied to them.
+
+
repeat(A) - Static method in class fj.data.Stream
+
+
Returns an infinite-length stream of the given element.
+
+
repeat() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser zero or many times.
+
+
repeat1() - Method in class fj.parser.Parser
+
+
Returns a parser that repeats application of this parser one or many times.
+
+
replace(F<A, Boolean>, A) - Method in class fj.data.Stream
+
+
Returns a new stream resulting from replacing all elements that match the given predicate with the given element.
+
+
replace(A) - Method in class fj.data.Zipper
+
+
Replaces the element in focus with the given element.
+
+
replicate(int, A) - Static method in class fj.data.List
+
+
Returns a list of the given value replicated the given number of times.
+
+
replicateM(IO<A>, int) - Static method in class fj.data.IOFunctions
+
 
+
rest() - Method in class fj.parser.Result
+
+
The remainder of the parse input.
+
+
Result<I,A> - Class in fj.parser
+
+
A parse result made up of a value (A) and the remainder of the parse input (I).
+
+
result(I, A) - Static method in class fj.parser.Result
+
+
Construct a result with the given remainder of the parse input and parse value.
+
+
result() - Static method in class fj.parser.Result
+
+
First-class construction of a result.
+
+
resultEqual(Equal<A>, Equal<I>) - Static method in class fj.Equal
+
 
+
resultHash(Hash<A>, Hash<I>) - Static method in class fj.Hash
+
+
A hash instance for the Result type.
+
+
resultShow(Show<A>, Show<I>) - Static method in class fj.Show
+
+
A show instance for the Result type.
+
+
resume() - Method in class fj.control.Trampoline
+
+
Runs a single step of this computation.
+
+
resume_() - Static method in class fj.control.Trampoline
+
 
+
reverse() - Method in class fj.data.Array.ImmutableProjection
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.Array
+
+
Reverse this array in constant stack space.
+
+
reverse() - Method in class fj.data.LazyString
+
+
Returns the reverse of this string.
+
+
reverse() - Method in class fj.data.List
+
+
Reverse this list in constant stack space.
+
+
reverse() - Method in class fj.data.NonEmptyList
+
+
Reverse this non empty list in constant stack space.
+
+
reverse() - Method in class fj.data.optic.Iso
+
 
+
reverse() - Method in class fj.data.optic.PIso
+
+
reverse a PIso: the source becomes the target and the target becomes the source
+
+
reverse() - Method in class fj.data.Stream
+
+
Reverse this stream in constant stack space.
+
+
reverse() - Static method in class fj.function.Strings
+
 
+
reverse() - Method in class fj.Ord
+
 
+
reverse() - Method in enum fj.Ordering
+
 
+
reverseBytes - Static variable in class fj.function.Characters
+
 
+
reverseGet(A) - Method in class fj.data.optic.Iso
+
 
+
reverseGet(B) - Method in class fj.data.optic.PIso
+
+
get the modified source of a PIso
+
+
reverseGet(B) - Method in class fj.data.optic.PPrism
+
+
get the modified source of a PPrism
+
+
reverseGet(A) - Method in class fj.data.optic.Prism
+
 
+
right() - Method in class fj.data.Either
+
+
Projects this either as a right.
+
+
right(B) - Static method in class fj.data.Either
+
+
Construct a right value of either.
+
+
right(C) - Static method in class fj.data.Either3
+
 
+
right() - Method in class fj.data.Either3
+
 
+
right() - Method in class fj.data.TreeZipper
+
+
Navigates to the right sibling of the current location.
+
+
right_() - Static method in class fj.data.Either
+
+
A function that constructs a right value of either.
+
+
right_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the right() function.
+
+
rightMap(F<B, X>) - Method in class fj.data.Either
+
+
Map the given function across this either's right.
+
+
rightMap(F<C, X>) - Method in class fj.data.Either3
+
 
+
rightMap_() - Static method in class fj.data.Either
+
+
Return a function that maps a given function across this either's right projection.
+
+
rightMap_() - Method in class fj.data.Either3
+
 
+
rightOption() - Method in class fj.data.Either3
+
 
+
rights(List<Either<A, B>>) - Static method in class fj.data.Either
+
+
Returns all the right values in the given list.
+
+
rights() - Method in class fj.data.TreeZipper
+
+
Returns the right siblings of the currently focused node.
+
+
rights() - Method in class fj.data.Zipper
+
+
Returns a Stream of the elements to the right of focus.
+
+
Rng - Class in fj
+
 
+
Rng() - Constructor for class fj.Rng
+
 
+
root() - Method in class fj.data.Tree
+
+
Returns the root element of the tree.
+
+
root() - Method in class fj.data.TreeZipper
+
+
Navigates to the top-most parent of the current location.
+
+
root_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its root.
+
+
root_() - Static method in class fj.data.TreeZipper
+
+
A first-class version of the root function.
+
+
run(Connection) - Method in class fj.control.db.DB
+
+
Executes the database action, given a database connection.
+
+
run(DB<A>) - Method in class fj.control.db.DbState
+
+
Runs the given database action as a single transaction.
+
+
run() - Method in class fj.control.Trampoline
+
+
Runs this computation all the way to the end, in constant stack.
+
+
run() - Method in class fj.data.DList
+
+
Concatenates all the internal Lists together that are held in + the DList's lambda's state to produce a List.
+
+
run() - Method in interface fj.data.IO
+
 
+
run() - Method in class fj.data.Iteratee.IterV
+
 
+
run() - Method in interface fj.data.SafeIO
+
 
+
run(S) - Method in class fj.data.State
+
 
+
run() - Method in class fj.data.Writer
+
 
+
runSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Run io, rethrowing any IOException wrapped in a RuntimeException
+
+
+ + + +

S

+
+
safe() - Method in interface fj.data.IO
+
 
+
SafeIO<A> - Interface in fj.data
+
 
+
satisfy(F0<E>, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
satisfy(E, F<I, E>, F<I, Boolean>) - Static method in class fj.parser.Parser.StreamParser
+
+
Returns a parser that produces an element from the stream that satisfies the given predicate, or fails.
+
+
scanLeft(F<B, F<A, B>>, B) - Method in class fj.data.Array
+
+
Performs a fold left accummulating and returns an array of the intermediate results.
+
+
scanLeft(F2<B, A, B>, B) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating and returns an array of the intermediate results.
+
+
scanLeft1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanLeft1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a left-fold accummulating using first array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight(F<A, F<B, B>>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight(F2<A, B, B>, B) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating and returns an array of the intermediate results.
+
+
scanRight1(F<A, F<A, A>>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
scanRight1(F2<A, A, A>) - Method in class fj.data.Array
+
+
Performs a right-fold accummulating using last array element as a starting value + and returns an array of the intermediate results.
+
+
second() - Method in class fj.data.optic.Getter
+
 
+
second() - Method in class fj.data.optic.Iso
+
 
+
second() - Method in class fj.data.optic.Optional
+
 
+
second() - Method in class fj.data.optic.PIso
+
 
+
second() - Method in class fj.data.optic.POptional
+
 
+
semigroup() - Method in class fj.Monoid
+
+
Returns a semigroup projection of this monoid.
+
+
Semigroup<A> - Class in fj
+
+
Implementations must satisfy the law of associativity: + + Associativity; forall x.
+
+
semigroup(F<A, F<A, A>>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
semigroup(F2<A, A, A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given function.
+
+
Semigroup.AltDefinition<A> - Interface in fj
+
+
Primitives functions of Semigroup: alternative minimal definition and overridable methods.
+
+
Semigroup.Definition<A> - Interface in fj
+
+
Primitives functions of Semigroup: minimal definition and overridable methods.
+
+
semigroupDef(Semigroup.Definition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
semigroupDef(Semigroup.AltDefinition<A>) - Static method in class fj.Semigroup
+
+
Constructs a semigroup from the given definition.
+
+
Seq<A> - Class in fj.data
+
+
Provides an immutable finite sequence, implemented as a finger tree.
+
+
seq(A...) - Static method in class fj.data.Seq
+
+
Constructs a sequence from the given elements.
+
+
seqEqual(Equal<A>) - Static method in class fj.Equal
+
 
+
seqHash(Hash<A>) - Static method in class fj.Hash
+
 
+
seqOrd(Ord<A>) - Static method in class fj.Ord
+
+
Return a seq ord using the given value ord.
+
+
seqShow(Show<A>) - Static method in class fj.Show
+
 
+
seqStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a strategy that performs sequential (non-concurrent) evaluation of its argument.
+
+
sequence(List<Callable<A>>) - Static method in class fj.control.parallel.Callables
+
+
Turns a List of Callables into a single Callable of a List.
+
+
sequence(List<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
List iteration inside a Promise.
+
+
sequence(Stream<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Stream iteration inside a Promise.
+
+
sequence(P1<Promise<A>>) - Method in class fj.control.parallel.ParModule
+
+
Traverses a product-1 inside a promise.
+
+
sequence(Strategy<Unit>, List<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a List of promises into a single promise of a List.
+
+
sequence(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a List.
+
+
sequence(Strategy<Unit>, Stream<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Turns a Stream of promises into a single promise of a Stream.
+
+
sequence(Strategy<Unit>, P1<Promise<A>>) - Static method in class fj.control.parallel.Promise
+
+
Transforms a product of a promise to a promise of a product.
+
+
sequence(Array<B>) - Method in class fj.data.Array.ImmutableProjection
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Array<B>) - Method in class fj.data.Array
+
+
Performs a bind across each array element, but ignores the element value each time.
+
+
sequence(Either<X, B>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
sequence(Either<A, X>) - Method in class fj.data.Either.RightProjection
+
+
Anonymous bind through this projection.
+
+
sequence(Either3<X, B, C>) - Method in class fj.data.Either3.LeftProjection
+
 
+
sequence(Either3<A, X, C>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
sequence(Either3<A, B, X>) - Method in class fj.data.Either3.RightProjection
+
 
+
sequence(List<IO<A>>) - Static method in class fj.data.IOFunctions
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<IO<A>>) - Static method in class fj.data.IOFunctions
+
 
+
sequence(Iterable<T>) - Static method in class fj.data.IterableW
+
+
Performs a bind across each element of all iterables of an iterable, collecting the values in an iterable.
+
+
sequence(List<B>) - Method in class fj.data.List
+
+
Performs a bind across each list element, but ignores the element value each time.
+
+
sequence(Option<B>) - Method in class fj.data.Option
+
+
Performs a bind across the optional value, but ignores the element value in the function.
+
+
sequence(List<Option<A>>) - Static method in class fj.data.Option
+
+
Sequence a list through the option monad.
+
+
sequence(Validation<E, Option<A>>) - Static method in class fj.data.Option
+
+
Sequence a validation through the option monad.
+
+
sequence(List<State<S, A>>) - Static method in class fj.data.State
+
+
Evaluate each action in the sequence from left to right, and collect the results.
+
+
sequence(Stream<B>) - Method in class fj.data.Stream
+
+
Performs a bind across each stream element, but ignores the element value each time.
+
+
sequence(IO<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(F0<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Option<Stream<A>>) - Static method in class fj.data.Stream
+
+
Sequence through the Stream monad.
+
+
sequence(Validation<A, T>) - Method in class fj.data.Validation.FailProjection
+
+
Performs a bind across the validation, but ignores the element value in the function.
+
+
sequence(Validation<E, A>) - Method in class fj.data.Validation
+
+
Anonymous bind through this validation.
+
+
sequence(Semigroup<E>, List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If list contains a failure, returns a failure of the reduction of + all the failures using the semigroup, otherwise returns the successful list.
+
+
sequence(List<P1<A>>) - Static method in class fj.P1
+
+
Turns a List of P1s into a single P1 of a List.
+
+
sequence(Stream<P1<A>>) - Static method in class fj.P1
+
+
Turns a stream of P1s into a single P1 of a stream.
+
+
sequence(Option<P1<A>>) - Static method in class fj.P1
+
+
Turns an optional P1 into a lazy option.
+
+
sequence(Array<P1<A>>) - Static method in class fj.P1
+
+
Turns an array of P1s into a single P1 of an array.
+
+
sequence(Parser<I, B, E>) - Method in class fj.parser.Parser
+
+
Binds anonymously, ignoring the result value.
+
+
sequence(List<Parser<I, A, E>>) - Static method in class fj.parser.Parser
+
+
Sequence the list of parsers through Parser.bind(fj.F<A, fj.parser.Parser<I, B, E>>).
+
+
sequence_() - Static method in class fj.control.parallel.Callables
+
+
A first-class version of the sequence method.
+
+
sequence_(List<F<B, A>>) - Static method in class fj.data.List
+
+
Turn a list of functions into a function returning a list.
+
+
sequence_(Stream<F<B, A>>) - Static method in class fj.data.Stream
+
+
Turn a stream of functions into a function returning a stream.
+
+
sequenceEither(List<Either<L, B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output on the right side of an either.
+
+
sequenceEither(Option<Either<L, B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output on the right side of an either.
+
+
sequenceEither(Seq<Either<L, B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output on the right side of an either.
+
+
sequenceEither(Stream<Either<L, B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output on the right side of an either.
+
+
sequenceEitherLeft(List<Either<B, R>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output on the left side of an either.
+
+
sequenceEitherLeft(Option<Either<B, R>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output on the left side of an either.
+
+
sequenceEitherLeft(Seq<Either<B, R>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output on the left side of an either.
+
+
sequenceEitherLeft(Stream<Either<B, R>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output on the left side of an either.
+
+
sequenceEitherLeft(Validation<E, Either<C, R>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output on the left side of an either.
+
+
sequenceEitherRight(List<Either<L, B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output on the right side of an either.
+
+
sequenceEitherRight(Option<Either<L, B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output on the right side of an either.
+
+
sequenceEitherRight(Seq<Either<L, B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output on the right side of an either.
+
+
sequenceEitherRight(Stream<Either<L, B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output on the right side of an either.
+
+
sequenceEitherRight(Validation<E, Either<L, C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output on the right side of an either.
+
+
sequenceF(List<F<C, B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a function.
+
+
sequenceF(Option<F<C, B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a function.
+
+
sequenceF(Seq<F<C, B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a function.
+
+
sequenceF(Stream<F<C, B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a function.
+
+
sequenceF(Validation<E, F<C, B>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a function.
+
+
sequenceIO(List<IO<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as an IO.
+
+
sequenceIO(Option<IO<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as an IO.
+
+
sequenceIO(Seq<IO<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as an IO.
+
+
sequenceIO(Stream<IO<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as an IO.
+
+
sequenceIO(Validation<E, IO<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as an IO.
+
+
sequenceLeft(List<Either<A, X>>) - Static method in class fj.data.Either
+
+
Sequences through the left side of the either monad with a list of values.
+
+
sequenceList() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a list inside a promise.
+
+
sequenceList(List<List<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as an list.
+
+
sequenceList(Option<List<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as an list.
+
+
sequenceList(Seq<List<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a list.
+
+
sequenceList(Stream<List<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a list.
+
+
sequenceList(Validation<E, List<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a list.
+
+
sequenceList() - Static method in class fj.P1
+
+
A first-class version of the sequence method for lists of P1s.
+
+
sequenceNonCumulative(List<Validation<E, A>>) - Static method in class fj.data.Validation
+
+
If the list contains a failure, returns a Validation of the list of + fails in the list, otherwise returns a successful Validation with + the list of successful values.
+
+
sequenceOption(List<Option<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as an list.
+
+
sequenceOption(Option<Option<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as an option.
+
+
sequenceOption(Seq<Option<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as an seq.
+
+
sequenceOption(Stream<Option<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as an stream.
+
+
sequenceOption(Validation<E, Option<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as an option.
+
+
sequenceP1(List<P1<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a P1.
+
+
sequenceP1(Option<P1<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a P1.
+
+
sequenceP1(Seq<P1<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a P1.
+
+
sequenceP1(Stream<P1<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a P1.
+
+
sequenceP1(Validation<E, P1<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a P1.
+
+
sequenceRight(List<Either<X, B>>) - Static method in class fj.data.Either
+
+
Sequences through the right side of the either monad with a list of values.
+
+
sequenceS(Strategy<Unit>) - Static method in class fj.control.parallel.Promise
+
+
First-class version of the sequence function through a Stream.
+
+
sequenceSeq(List<Seq<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a seq.
+
+
sequenceSeq(Option<Seq<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a seq.
+
+
sequenceSeq(Seq<Seq<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a seq.
+
+
sequenceSeq(Stream<Seq<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a seq.
+
+
sequenceSeq(Validation<E, Seq<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a seq.
+
+
sequenceSet(Ord<B>, List<Set<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a set; use the given ord to order the set.
+
+
sequenceSet(Ord<B>, Option<Set<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a set; use the given ord to order the set.
+
+
sequenceSet(Ord<B>, Seq<Set<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a set; use the given ord to order the set.
+
+
sequenceSet(Ord<B>, Stream<Set<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a set; use the given ord to order the set.
+
+
sequenceSet(Ord<E>, Ord<C>, Validation<E, Set<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a set.
+
+
sequenceStream() - Method in class fj.control.parallel.ParModule
+
+
A first-class function that traverses a stream inside a promise.
+
+
sequenceStream(List<Stream<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a stream.
+
+
sequenceStream(Option<Stream<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a stream.
+
+
sequenceStream(Seq<Stream<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a stream.
+
+
sequenceStream(Stream<Stream<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a stream.
+
+
sequenceStream(Validation<E, Stream<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a stream.
+
+
sequenceTrampoline(List<Trampoline<B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a trampoline.
+
+
sequenceTrampoline(Option<Trampoline<B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a trampoline.
+
+
sequenceTrampoline(Seq<Trampoline<B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a trampoline.
+
+
sequenceTrampoline(Stream<Trampoline<B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a trampoline.
+
+
sequenceTrampoline(Validation<E, Trampoline<C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a trampoline.
+
+
sequenceValidation(Semigroup<E>, List<Validation<E, B>>) - Static method in class fj.data.List
+
+
Sequence the given list and collect the output as a validation; use the given semigroup to reduce the errors.
+
+
sequenceValidation(Option<Validation<E, B>>) - Static method in class fj.data.Option
+
+
Sequence the given option and collect the output as a validation.
+
+
sequenceValidation(Seq<Validation<E, B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a validation.
+
+
sequenceValidation(Semigroup<E>, Seq<Validation<E, B>>) - Static method in class fj.data.Seq
+
+
Sequence the given seq and collect the output as a validation; use the given semigroup to reduce the errors.
+
+
sequenceValidation(Stream<Validation<E, B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a validation.
+
+
sequenceValidation(Semigroup<E>, Stream<Validation<E, B>>) - Static method in class fj.data.Stream
+
+
Sequence the given stream and collect the output as a validation; use the given semigroup to reduce the errors.
+
+
sequenceValidation(Validation<E, Validation<E1, C>>) - Static method in class fj.data.Validation
+
+
Sequence the given validation and collect the output as a validation.
+
+
sequenceW(Stream<F<Promise<A>, B>>) - Method in class fj.control.parallel.Promise
+
+
Applies a stream of comonadic functions to this promise, returning a stream of values.
+
+
sequenceW(Stream<F<Stream<A>, B>>) - Method in class fj.data.Stream
+
+
Applies a stream of comonadic functions to this stream, returning a stream of values.
+
+
sequenceW(List<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a list of comonadic functions to this product, returning a list of values.
+
+
sequenceW(Stream<F<P2<A, B>, C>>) - Method in class fj.P2
+
+
Applies a stream of comonadic functions to this product, returning a stream of values.
+
+
sequenceWhile(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
sequenceWhileEager(Stream<IO<A>>, F<A, Boolean>) - Static method in class fj.data.IOFunctions
+
 
+
set(int, A) - Method in class fj.data.Array
+
+
Sets the element at the given index to the given value.
+
+
set(int) - Method in class fj.data.hamt.BitSet
+
 
+
set(int, boolean) - Method in class fj.data.hamt.BitSet
+
 
+
set(K, V) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the key-value pair (k, v) to the trie.
+
+
set(List<P2<K, V>>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Adds the product of key-value (k, v) pairs to the trie.
+
+
set(K, V) - Method in class fj.data.HashMap
+
+
Inserts the given key and value association into the hash map.
+
+
set(A) - Method in class fj.data.HashSet
+
+
Insert the given element into this hash set.
+
+
set(A) - Method in class fj.data.optic.Lens
+
 
+
set(A) - Method in class fj.data.optic.Optional
+
 
+
set(B) - Method in class fj.data.optic.PIso
+
+
set polymorphically the target of a PIso with a value
+
+
set(B) - Method in class fj.data.optic.PLens
+
+
set polymorphically the target of a PLens using a function
+
+
set(B) - Method in class fj.data.optic.POptional
+
+
get the modified source of a POptional
+
+
set(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value
+
+
set(B) - Method in class fj.data.optic.PSetter
+
+
set polymorphically the target of a PSetter with a value
+
+
set(B) - Method in class fj.data.optic.PTraversal
+
+
set polymorphically the target of a PTraversal with a value
+
+
set(A) - Method in class fj.data.optic.Setter
+
 
+
Set<A> - Class in fj.data
+
+
Provides an in-memory, immutable set, implemented as a red/black tree.
+
+
set(Ord<A>, A...) - Static method in class fj.data.Set
+
+
Constructs a set from the given elements.
+
+
set(K, V) - Method in class fj.data.TreeMap
+
+
Inserts the given key and value association into the tree map.
+
+
setEqual(Equal<A>) - Static method in class fj.Equal
+
+
Equal instance for sets.
+
+
setHash(Hash<A>) - Static method in class fj.Hash
+
 
+
setIntersectionMonoid(Bounded<A>, Enumerator<A>) - Static method in class fj.Monoid
+
+
A intersection monoid for sets.
+
+
setIntersectionSemigroup() - Static method in class fj.Semigroup
+
+
A intersection semigroup for sets.
+
+
setK(Ord<B>) - Method in interface fj.F
+
+
Promotes this function to return its value in a Set.
+
+
setLabel(A) - Method in class fj.data.TreeZipper
+
+
Replaces the label of the current node with the given value.
+
+
setM(Ord<C>) - Method in interface fj.F2
+
+
Promotes this function to a function on Sets.
+
+
setMax(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given maximum value.
+
+
setMin(Option<A>) - Method in class fj.data.Enumerator
+
+
Create a new enumerator with the given minimum value.
+
+
setMonoid(Ord<A>) - Static method in class fj.Monoid
+
+
A union monoid for sets.
+
+
setOption(B) - Method in class fj.data.optic.POptional
+
+
set polymorphically the target of a POptional with a value.
+
+
setOption(B) - Method in class fj.data.optic.PPrism
+
+
set polymorphically the target of a PPrism with a value.
+
+
setOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Set type.
+
+
setSemigroup() - Static method in class fj.Semigroup
+
+
A union semigroup for sets.
+
+
setShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Set type.
+
+
Setter<S,A> - Class in fj.data.optic
+
+
PSetter with a monomorphic modify function
+
+
Setter(PSetter<S, S, A, A>) - Constructor for class fj.data.optic.Setter
+
 
+
setter(F<F<A, A>, F<S, S>>) - Static method in class fj.data.optic.Setter
+
+
alias for PSetter constructor with a monomorphic modify function
+
+
setTree(Tree<A>) - Method in class fj.data.TreeZipper
+
+
Replaces the current node with the given tree.
+
+
setTreeMap(Ord<K>, Set<P2<K, Option<V>>>) - Static method in class fj.data.TreeMap
+
+
Constructs a TreeMap from the given set.
+
+
shiftLeft(int) - Method in class fj.data.hamt.BitSet
+
 
+
shiftRight(int) - Method in class fj.data.hamt.BitSet
+
 
+
Short_Boolean - Static variable in class fj.Primitive
+
+
A function that converts shorts to booleans.
+
+
Short_Byte - Static variable in class fj.Primitive
+
+
A function that converts shorts to bytes.
+
+
Short_Character - Static variable in class fj.Primitive
+
+
A function that converts shorts to characters.
+
+
Short_Double - Static variable in class fj.Primitive
+
+
A function that converts shorts to doubles.
+
+
Short_Float - Static variable in class fj.Primitive
+
+
A function that converts shorts to floats.
+
+
Short_Integer - Static variable in class fj.Primitive
+
+
A function that converts shorts to integers.
+
+
Short_Long - Static variable in class fj.Primitive
+
+
A function that converts shorts to longs.
+
+
shortEnumerator - Static variable in class fj.data.Enumerator
+
+
An enumerator for short.
+
+
shortEqual - Static variable in class fj.Equal
+
+
An equal instance for the short type.
+
+
shortHash - Static variable in class fj.Hash
+
+
A hash instance for the short type.
+
+
shortOrd - Static variable in class fj.Ord
+
+
An order instance for the short type.
+
+
shortShow - Static variable in class fj.Show
+
+
A show instance for the short type.
+
+
show() - Method in class fj.data.hlist.HPre.HNat
+
 
+
show() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
show() - Method in class fj.data.hlist.HPre.HZero
+
 
+
show(Show<A>) - Static method in class fj.data.TreeZipper
+
+
A Show instance for tree zippers.
+
+
show(Show<A>) - Static method in class fj.data.Zipper
+
+
A Show instance for Zippers.
+
+
Show<A> - Class in fj
+
+
Renders an object for display.
+
+
show(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
show(F<A, Stream<Character>>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
show2D(Show<A>) - Static method in class fj.data.Tree
+
+
Provides a show instance that draws a 2-dimensional representation of a tree.
+
+
show_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
showl(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument.
+
+
showS(A) - Method in class fj.Show
+
+
Returns the display rendering of the given argument as a String.
+
+
showS(F<A, String>) - Static method in class fj.Show
+
+
Returns a show instance using the given function.
+
+
showS_() - Method in class fj.Show
+
+
Returns the transformation equivalent to this show.
+
+
simpleThreadStrategy() - Static method in class fj.control.parallel.Strategy
+
+
Provides a simple parallelization strategy that creates, and discards, a new thread for + every evaluation.
+
+
single(A) - Static method in class fj.data.Array
+
+
Constructs a singleton array.
+
+
single(A) - Static method in class fj.data.DList
+
+
Produces a DList with one element.
+
+
single(A) - Method in class fj.data.fingertrees.MakeTree
+
+
Constructs a singleton tree.
+
+
Single<V,A> - Class in fj.data.fingertrees
+
+
A tree with a single element.
+
+
single(E) - Static method in class fj.data.hlist.HList
+
+
Returns a heterogeneous list consisting of a single element.
+
+
single(A) - Static method in class fj.data.List
+
+
Returns a list of one element containing the given value.
+
+
single(A) - Static method in class fj.data.Seq
+
+
A singleton sequence.
+
+
single(Ord<A>, A) - Static method in class fj.data.Set
+
+
Returns a set with a single element.
+
+
single(A) - Static method in class fj.data.Stream
+
+
Returns a stream of one element containing the given value.
+
+
single() - Static method in class fj.data.Stream
+
+
Returns a function that yields a stream containing its argument.
+
+
single(A) - Static method in class fj.data.Zipper
+
+
Creates a new zipper with a single element.
+
+
SIZE - Static variable in class fj.data.hamt.HashArrayMappedTrie
+
 
+
size() - Method in class fj.data.HashMap
+
+
Returns the number of entries in this hash map.
+
+
size() - Method in class fj.data.HashSet
+
+
Returns the number of entries in this hash set.
+
+
size() - Method in class fj.data.Set
+
+
Returns the size of this set.
+
+
size() - Method in class fj.data.TreeMap
+
+
Returns the number of entries in this tree map.
+
+
snoc(A) - Method in class fj.data.DList
+
+
Appends a single element on the end of the DList to produce a new DList.
+
+
snoc(A) - Method in class fj.data.fingertrees.Deep
+
 
+
snoc(A) - Method in class fj.data.fingertrees.Empty
+
 
+
snoc(A) - Method in class fj.data.fingertrees.FingerTree
+
+
Adds the given element to this tree as the last element.
+
+
snoc(A) - Method in class fj.data.fingertrees.Single
+
 
+
snoc(A) - Method in class fj.data.List.Buffer
+
+
Appends (snoc) the given element to this buffer to produce a new buffer.
+
+
snoc(A) - Method in class fj.data.List
+
+
Appends (snoc) the given element to this list to produce a new list.
+
+
snoc(A) - Method in class fj.data.NonEmptyList
+
+
Appends (snoc) the given element to this non empty list to produce a new non empty list.
+
+
snoc(A) - Method in class fj.data.Seq
+
+
Inserts the given element at the end of this sequence.
+
+
snoc(A) - Method in class fj.data.Stream
+
+
Append the given element to this stream to product a new stream.
+
+
snoc(F0<A>) - Method in class fj.data.Stream
+
+
Append the given element to this stream to produce a new stream.
+
+
softMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using soft call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected + due of shortage of memory (ie.
+
+
softMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a SoftReference
+
+
some() - Static method in class fj.data.Option.Optic
+
+
Monomorphic Some prism
+
+
some() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or fails if there is no value.
+
+
some(T) - Static method in class fj.data.Option
+
+
Constructs an optional value that has a value of the given argument.
+
+
some_() - Static method in class fj.data.Option
+
 
+
somes(List<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given list.
+
+
somes(Stream<Option<A>>) - Static method in class fj.data.Option
+
+
Returns all the values in the given stream.
+
+
sort(Ord<A>) - Method in class fj.data.List
+
+
Sorts this list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.NonEmptyList
+
+
Sorts this non empty list using the given order over elements using a merge sort algorithm.
+
+
sort(Ord<A>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering.
+
+
sort(Ord<A>, Strategy<Unit>) - Method in class fj.data.Stream
+
+
Sort this stream according to the given ordering, using a parallel Quick Sort algorithm that uses the given + parallelisation strategy.
+
+
space(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
space(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a space character.
+
+
span(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns a tuple where the first element is the longest prefix of this list that satisfies + the given predicate and the second element is the remainder of the list.
+
+
span(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that satisfies + the given predicate and the second element is the remainder of the stream.
+
+
split(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Splits this tree into a pair of subtrees at the point where the given predicate, based on the measure, + changes from false to true.
+
+
split(F<Character, Boolean>) - Method in class fj.data.LazyString
+
+
Splits this lazy string by characters matching the given predicate.
+
+
split(char) - Method in class fj.data.LazyString
+
+
Splits this lazy string by the given delimiter character.
+
+
split(int) - Method in class fj.data.Seq
+
+
Splits this sequence into a pair of sequences at the given position.
+
+
split(A) - Method in class fj.data.Set
+
+
Splits this set at the given element.
+
+
split(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns a tuple where the first element is the longest prefix of this stream that does not satisfy + the given predicate and the second element is the remainder of the stream.
+
+
split(Ord<V>, K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
split(F<A, C>, F<B, D>) - Method in class fj.P2
+
+
Split this product between two argument functions and combine their output.
+
+
split1(F<V, Boolean>) - Method in class fj.data.fingertrees.FingerTree
+
+
Like split, but returns the element where pred first holds separately.
+
+
split_(F<A, C>, F<B, D>) - Static method in class fj.P2
+
+
A first-class version of the split function.
+
+
splitAt(int) - Method in class fj.data.List
+
+
Splits this list into two lists at the given index.
+
+
splitLookup(K) - Method in class fj.data.TreeMap
+
+
Splits this TreeMap at the given key.
+
+
Stack_List() - Static method in class fj.data.Java
+
+
A function that converts stacks to lists.
+
+
startsWith(LazyString) - Method in class fj.data.LazyString
+
+
Returns true if the given lazy string is a prefix of this lazy string.
+
+
startsWith() - Static method in class fj.data.LazyString
+
+
First-class prefix check.
+
+
State<S,A> - Class in fj.data
+
 
+
stdinBufferedReader - Static variable in class fj.data.IOFunctions
+
 
+
stdinReadLine() - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrint(String) - Static method in class fj.data.IOFunctions
+
 
+
stdoutPrintln(String) - Static method in class fj.data.IOFunctions
+
 
+
str(String) - Static method in class fj.data.LazyString
+
+
Constructs a lazy string from a String.
+
+
Strategy<A> - Class in fj.control.parallel
+
+
Functional-style parallel evaluation strategies.
+
+
strategy(F<P1<A>, P1<A>>) - Static method in class fj.control.parallel.Strategy
+
+
Constructs a strategy from the given evaluation function.
+
+
Stream<A> - Class in fj.data
+
+
A lazy (not yet evaluated), immutable, singly linked list.
+
+
stream(A...) - Static method in class fj.data.Stream
+
+
Constructs a stream with the given elements.
+
+
Stream_Array() - Static method in class fj.data.Conversions
+
+
A function that converts streams to arrays.
+
+
Stream_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to array blocking queues.
+
+
Stream_ArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to array lists.
+
+
Stream_BitSet - Static variable in class fj.data.Java
+
+
A function that converts streams to bit sets.
+
+
Stream_ConcurrentLinkedQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to concurrent linked queues.
+
+
Stream_CopyOnWriteArrayList() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array lists.
+
+
Stream_CopyOnWriteArraySet() - Static method in class fj.data.Java
+
+
A function that converts streams to copy on write array sets.
+
+
Stream_DelayQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to delay queues.
+
+
Stream_Either() - Static method in class fj.data.Conversions
+
+
A function that converts streams to eithers.
+
+
Stream_EnumSet() - Static method in class fj.data.Java
+
+
A function that converts streams to enum sets.
+
+
Stream_HashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to hash sets.
+
+
Stream_Iterable() - Static method in class fj.data.Java
+
+
A function that converts streams to iterable.
+
+
Stream_JavaStream(Stream<A>) - Static method in class fj.data.Java8
+
 
+
Stream_JavaStream() - Static method in class fj.data.Java8
+
 
+
Stream_LinkedBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to linked blocking queues.
+
+
Stream_LinkedHashSet() - Static method in class fj.data.Java
+
+
A function that converts streams to linked hash sets.
+
+
Stream_LinkedList() - Static method in class fj.data.Java
+
+
A function that converts streams to linked lists.
+
+
Stream_List() - Static method in class fj.data.Conversions
+
+
A function that converts streams to lists.
+
+
Stream_Option() - Static method in class fj.data.Conversions
+
+
A function that converts streams to options.
+
+
Stream_PriorityBlockingQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority blocking queues.
+
+
Stream_PriorityQueue() - Static method in class fj.data.Java
+
+
A function that converts streams to priority queues.
+
+
Stream_Stack() - Static method in class fj.data.Java
+
+
A function that converts streams to stacks.
+
+
Stream_String - Static variable in class fj.data.Conversions
+
+
A function that converts streams to strings.
+
+
Stream_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string buffers.
+
+
Stream_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts streams to string builders.
+
+
Stream_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts streams to synchronous queues.
+
+
Stream_TreeSet() - Static method in class fj.data.Java
+
+
A function that converts streams to tree sets.
+
+
Stream_Vector() - Static method in class fj.data.Java
+
+
A function that converts streams to vectors.
+
+
streamBitSet(Stream<Boolean>) - Static method in class fj.data.hamt.BitSet
+
 
+
streamEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Stream type.
+
+
streamHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Stream type.
+
+
streamK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result in a Stream.
+
+
streamM() - Method in interface fj.F2
+
+
Promotes this function to a function on Streams.
+
+
streamMonoid() - Static method in class fj.Monoid
+
+
A monoid for streams.
+
+
streamOrd(Ord<A>) - Static method in class fj.Ord
+
+
An order instance for the Stream type.
+
+
streamSemigroup() - Static method in class fj.Semigroup
+
+
A semigroup for streams.
+
+
streamShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow(Show<A>, String, String, String) - Static method in class fj.Show
+
+
A show instance for the Stream type.
+
+
streamShow_(Show<A>, String, String, String) - Static method in class fj.Show
+
+
Returns the transformation equivalent for the stream show.
+
+
string(F0<E>, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
string(E, F<Character, E>, String) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces the given string or fails otherwise.
+
+
String_Array - Static variable in class fj.data.Conversions
+
+
A function that converts strings to arrays.
+
+
String_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to array blocking queues.
+
+
String_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to array lists.
+
+
String_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to concurrent linked queues.
+
+
String_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array lists.
+
+
String_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts strings to copy on write array sets.
+
+
String_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string to eithers.
+
+
String_HashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to hash sets.
+
+
String_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to linked blocking queues.
+
+
String_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts strings to linked hash sets.
+
+
String_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts strings to linked lists.
+
+
String_List - Static variable in class fj.data.Conversions
+
+
A function that converts strings to lists.
+
+
String_Option - Static variable in class fj.data.Conversions
+
+
A function that converts strings to options.
+
+
String_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority blocking queues.
+
+
String_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts strings to priority queues.
+
+
String_Stack - Static variable in class fj.data.Java
+
+
A function that converts strings to stacks.
+
+
String_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts strings to streams.
+
+
String_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string buffers.
+
+
String_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts strings to string builders.
+
+
String_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts strings to synchronous queues.
+
+
String_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts strings to tree sets.
+
+
String_Vector - Static variable in class fj.data.Java
+
+
A function that converts strings to vectors.
+
+
stringBitSet(String) - Static method in class fj.data.hamt.BitSet
+
 
+
StringBuffer_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to arrays.
+
+
StringBuffer_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to array blocking queues.
+
+
StringBuffer_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to array lists.
+
+
StringBuffer_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to concurrent linked queues.
+
+
StringBuffer_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array lists.
+
+
StringBuffer_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to copy on write array sets.
+
+
StringBuffer_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string buffers to eithers.
+
+
StringBuffer_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to hash sets.
+
+
StringBuffer_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked blocking queues.
+
+
StringBuffer_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked hash sets.
+
+
StringBuffer_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string buffers to linked lists.
+
+
StringBuffer_List - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to lists.
+
+
StringBuffer_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to options.
+
+
StringBuffer_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority blocking queues.
+
+
StringBuffer_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string buffers to priority queues.
+
+
StringBuffer_Stack - Static variable in class fj.data.Java
+
+
A function that converts string buffers to stacks.
+
+
StringBuffer_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to streams.
+
+
StringBuffer_String - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to strings.
+
+
StringBuffer_StringBuilder - Static variable in class fj.data.Conversions
+
+
A function that converts string buffers to string builders.
+
+
StringBuffer_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string buffers to synchronous queues.
+
+
StringBuffer_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string buffers to tree sets.
+
+
StringBuffer_Vector - Static variable in class fj.data.Java
+
+
A function that converts string buffers to vectors.
+
+
stringBufferEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuffer type.
+
+
stringBufferHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuffer type.
+
+
stringBufferMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string buffers.
+
+
stringBufferOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBufferSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string buffers.
+
+
stringBufferShow - Static variable in class fj.Show
+
+
A show instance for the StringBuffer type.
+
+
StringBuilder_Array - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to arrays.
+
+
StringBuilder_ArrayBlockingQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to array blocking queues.
+
+
StringBuilder_ArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to array lists.
+
+
StringBuilder_ConcurrentLinkedQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to concurrent linked queues.
+
+
StringBuilder_CopyOnWriteArrayList - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array lists.
+
+
StringBuilder_CopyOnWriteArraySet - Static variable in class fj.data.Java
+
+
A function that converts string builders to copy on write array sets.
+
+
StringBuilder_Either() - Static method in class fj.data.Conversions
+
+
A function that converts string builders to eithers.
+
+
StringBuilder_HashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to hash sets.
+
+
StringBuilder_LinkedBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked blocking queues.
+
+
StringBuilder_LinkedHashSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked hash sets.
+
+
StringBuilder_LinkedList - Static variable in class fj.data.Java
+
+
A function that converts string builders to linked lists.
+
+
StringBuilder_List - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to lists.
+
+
StringBuilder_Option - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to options.
+
+
StringBuilder_PriorityBlockingQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority blocking queues.
+
+
StringBuilder_PriorityQueue - Static variable in class fj.data.Java
+
+
A function that converts string builders to priority queues.
+
+
StringBuilder_Stack - Static variable in class fj.data.Java
+
+
A function that converts string builders to stacks.
+
+
StringBuilder_Stream - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to streams.
+
+
StringBuilder_String - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to strings.
+
+
StringBuilder_StringBuffer - Static variable in class fj.data.Conversions
+
+
A function that converts string builders to string buffers.
+
+
StringBuilder_SynchronousQueue(boolean) - Static method in class fj.data.Java
+
+
A function that converts string builders to synchronous queues.
+
+
StringBuilder_TreeSet - Static variable in class fj.data.Java
+
+
A function that converts string builders to tree sets.
+
+
StringBuilder_Vector - Static variable in class fj.data.Java
+
+
A function that converts string builders to vectors.
+
+
stringBuilderEqual - Static variable in class fj.Equal
+
+
An equal instance for the StringBuilder type.
+
+
stringBuilderHash - Static variable in class fj.Hash
+
+
A hash instance for the StringBuilder type.
+
+
stringBuilderMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends string builders.
+
+
stringBuilderOrd - Static variable in class fj.Ord
+
+
An order instance for the StringBuffer type.
+
+
stringBuilderSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends string builders.
+
+
stringBuilderShow - Static variable in class fj.Show
+
+
A show instance for the StringBuilder type.
+
+
stringEqual - Static variable in class fj.Equal
+
+
An equal instance for the String type.
+
+
stringHash - Static variable in class fj.Hash
+
+
A hash instance for the String type.
+
+
stringLogger() - Static method in class fj.data.Writer
+
 
+
stringMonoid - Static variable in class fj.Monoid
+
+
A monoid that appends strings.
+
+
stringOrd - Static variable in class fj.Ord
+
+
An order instance for the String type.
+
+
Strings - Class in fj.function
+
+
Curried string functions.
+
+
stringSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup that appends strings.
+
+
stringShow - Static variable in class fj.Show
+
+
A show instance for the String type.
+
+
subForest() - Method in class fj.data.Tree
+
+
Returns a stream of the tree's subtrees.
+
+
subForest_() - Static method in class fj.data.Tree
+
+
Provides a transformation from a tree to its subforest.
+
+
sublists() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the sublists of this list.
+
+
subSequence(int, int) - Method in class fj.data.LazyString
+
+
Gets the specified subsequence of this lazy string.
+
+
subsetOf(Set<A>) - Method in class fj.data.Set
+
+
Returns true if this set is a subset of the given set.
+
+
substreams() - Method in class fj.data.Stream
+
+
Returns a stream of all infixes of this stream.
+
+
subtract - Static variable in class fj.data.Natural
+
+
A function that subtracts its first argument from its second.
+
+
subtract(Natural) - Method in class fj.data.Natural
+
+
Subtract a natural number from another.
+
+
subtract - Static variable in class fj.function.BigIntegers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Doubles
+
+
Curried Double subtraction.
+
+
subtract - Static variable in class fj.function.Integers
+
+
Curried Integer subtraction.
+
+
subtract - Static variable in class fj.function.Longs
+
+
Curried Long subtraction.
+
+
succ() - Method in class fj.data.Natural
+
+
Return the successor of this natural number
+
+
succ_() - Static method in class fj.data.Natural
+
+
First-class successor function.
+
+
success() - Method in class fj.data.Validation
+
+
Returns the success value, or throws an error if there is no success value.
+
+
success(T) - Static method in class fj.data.Validation
+
+
Returns a succeeding validation containing the given value.
+
+
successE(F0<String>) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successE(String) - Method in class fj.data.Validation
+
+
Returns the success value or fails with the given error message.
+
+
successes(List<Validation<E, A>>) - Static method in class fj.data.Validation
+
 
+
successK() - Method in interface fj.F
+
+
Promotes this function so that it returns its result on the success side of an Validation.
+
+
successor() - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator in curried form.
+
+
successor(A) - Method in class fj.data.Enumerator
+
+
Returns the potential successor of a value for this enumerator.
+
+
suffix() - Method in class fj.data.fingertrees.Deep
+
+
Returns the last few elements of this tree.
+
+
sum(V, V) - Method in class fj.data.fingertrees.Measured
+
+
Sums the given measurements with the monoid.
+
+
sum() - Method in class fj.data.hlist.HPre.HAdd
+
 
+
sum(Stream<Natural>) - Static method in class fj.data.Natural
+
+
Sums a stream of natural numbers.
+
+
sum(List<Natural>) - Static method in class fj.data.Natural
+
+
Sums a list of natural numbers.
+
+
sum(Fold<S1, A>) - Method in class fj.data.optic.Fold
+
+
join two Fold with the same target
+
+
sum(Getter<S1, A>) - Method in class fj.data.optic.Getter
+
+
join two Getter with the same target
+
+
sum(Lens<S1, A>) - Method in class fj.data.optic.Lens
+
+
join two Lens with the same target
+
+
sum(Optional<S1, A>) - Method in class fj.data.optic.Optional
+
+
join two Optional with the same target
+
+
sum(PLens<S1, T1, A, B>) - Method in class fj.data.optic.PLens
+
+
join two PLens with the same target
+
+
sum(POptional<S1, T1, A, B>) - Method in class fj.data.optic.POptional
+
+
join two POptional with the same target
+
+
sum(PSetter<S1, T1, A, B>) - Method in class fj.data.optic.PSetter
+
+
join two PSetter with the same target
+
+
sum(PTraversal<S1, T1, A, B>) - Method in class fj.data.optic.PTraversal
+
+
join two PTraversal with the same target
+
+
sum(Setter<S1, A>) - Method in class fj.data.optic.Setter
+
+
join two Setter with the same target
+
+
sum(Traversal<S1, A>) - Method in class fj.data.optic.Traversal
+
+
join two Traversal with the same target
+
+
sum(List<BigInteger>) - Static method in class fj.function.BigIntegers
+
+
Sums a list of big integers.
+
+
sum(List<Double>) - Static method in class fj.function.Doubles
+
+
Sums a list of doubles.
+
+
sum(List<Integer>) - Static method in class fj.function.Integers
+
+
Sums a list of integers.
+
+
sum(List<Long>) - Static method in class fj.function.Longs
+
+
Sums a list of longs.
+
+
sum(F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, F0<Stream<A>>) - Method in interface fj.Monoid.Definition
+
 
+
sum(A, A) - Method in class fj.Monoid
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Monoid
+
+
Returns a function that sums the given value according to this monoid.
+
+
sum() - Method in class fj.Monoid
+
+
Returns a function that sums according to this monoid.
+
+
sum(A, F0<Stream<A>>) - Method in interface fj.Semigroup.Definition
+
 
+
sum(A, A) - Method in class fj.Semigroup
+
+
Sums the two given arguments.
+
+
sum(A) - Method in class fj.Semigroup
+
+
Returns a function that sums the given value according to this semigroup.
+
+
sum() - Method in class fj.Semigroup
+
+
Returns a function that sums according to this semigroup.
+
+
sumLeft(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with left-fold.
+
+
sumLeft() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumLeftS() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with left-fold.
+
+
sumNel(NonEmptyList<A>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold.
+
+
sumRight(List<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight(Stream<A>) - Method in class fj.Monoid
+
+
Sums the given values with right-fold.
+
+
sumRight() - Method in class fj.Monoid
+
+
Returns a function that sums the given values with right-fold.
+
+
sumStream(A, F0<Stream<A>>) - Method in class fj.Semigroup
+
+
Sums the given values with left-fold, shortcutting the computation as early as possible.
+
+
superclassParameters() - Method in class fj.Class
+
+
Provides this class's superclass type parameter information as a Tree of the type expression.
+
+
Supplier_P1(Supplier<A>) - Static method in class fj.data.Java8
+
 
+
Supplier_P1() - Static method in class fj.data.Java8
+
 
+
suspend(F0<Trampoline<A>>) - Static method in class fj.control.Trampoline
+
+
Suspends the given computation in a thunk.
+
+
suspend(P1<Trampoline<A>>) - Static method in class fj.control.Trampoline
+
+
Suspends the given computation in a thunk.
+
+
suspend_() - Static method in class fj.control.Trampoline
+
 
+
swap() - Method in class fj.data.Either
+
+
If this is a left, then return the left value in right, or vice versa.
+
+
swap() - Method in class fj.data.Either3
+
 
+
swap() - Method in class fj.P2
+
+
Swaps the elements around in this product.
+
+
swap_() - Static method in class fj.P2
+
+
Returns a curried form of P2.swap().
+
+
swapLefts() - Method in class fj.data.Either3
+
 
+
swapRights() - Method in class fj.data.Either3
+
 
+
SynchronousQueue_List() - Static method in class fj.data.Java
+
+
A function that converts synchronous queues to lists.
+
+
+ + + +

T

+
+
tail() - Method in class fj.data.fingertrees.Deep
+
 
+
tail() - Method in class fj.data.fingertrees.Empty
+
 
+
tail() - Method in class fj.data.fingertrees.FingerTree
+
+
The tree without the first element.
+
+
tail() - Method in class fj.data.fingertrees.Single
+
 
+
tail() - Method in class fj.data.hlist.HList.HCons
+
 
+
tail() - Method in class fj.data.LazyString
+
+
Returns all but the first character of this string.
+
+
tail() - Static method in class fj.data.List.Optic
+
+
Optional targeted on Cons tail.
+
+
tail() - Method in class fj.data.List
+
+
The list without the first element or fails for the empty list.
+
+
tail() - Method in class fj.data.NonEmptyList
+
+
This list without the first element.
+
+
tail() - Method in class fj.data.Seq
+
+
The sequence without the first element.
+
+
tail() - Method in class fj.data.Stream
+
+
The stream without the first element or fails for the empty stream.
+
+
tail() - Method in class fj.data.vector.V3
+
+
Returns all but the first element of this vector, as a vector-2.
+
+
tail() - Method in class fj.data.vector.V4
+
+
Returns all but the first element of this vector, as a vector-3.
+
+
tail() - Method in class fj.data.vector.V5
+
+
Returns all but the first element of this vector, as a vector-4.
+
+
tail() - Method in class fj.data.vector.V6
+
+
Returns all but the first element of this vector, as a vector-5.
+
+
tail() - Method in class fj.data.vector.V7
+
+
Returns all but the first element of this vector, as a vector-6.
+
+
tail() - Method in class fj.data.vector.V8
+
+
Returns all but the first element of this vector, as a vector-7.
+
+
tail_() - Static method in class fj.data.List
+
+
First-class tail function.
+
+
tailOption() - Method in class fj.data.List
+
+
Reutrns the tail of the list, if any.
+
+
tails() - Method in class fj.data.List
+
+
Returns the list of final segments of this list, longest first.
+
+
tails() - Method in class fj.data.NonEmptyList
+
+
Returns a NonEmptyList of the tails of this list.
+
+
tails() - Method in class fj.data.Stream
+
+
Returns a stream of the suffixes of this stream.
+
+
take(int) - Method in class fj.data.List
+
+
Takes the given number of elements from the head of this list if they are available.
+
+
take() - Static method in class fj.data.List
+
+
Provides a first-class version of take.
+
+
take(int) - Method in class fj.data.Seq
+
+
Takes the given number of elements from the head of this sequence if they are available.
+
+
take(int) - Method in class fj.data.Stream
+
+
Returns the first n elements from the head of this stream.
+
+
takeLower(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeUpper(int) - Method in class fj.data.hamt.BitSet
+
 
+
takeWhile(F<A, Boolean>) - Method in class fj.data.List
+
+
Returns the first elements of the head of this list that match the given predicate function.
+
+
takeWhile(F<A, Boolean>) - Method in class fj.data.Stream
+
+
Returns the first elements of the head of this stream that match the given predicate function.
+
+
tell(W) - Method in class fj.data.Writer
+
 
+
then(F<A, B>, Equal<B>) - Method in interface fj.Equal.Definition
+
+
Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
+
+
then(F<A, B>, Ord<B>) - Method in interface fj.Ord.Definition
+
+
Refine this ord definition: compares using self and if objects are equal compares using given Ord.
+
+
three(A, A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of three elements.
+
+
Three<V,A> - Class in fj.data.fingertrees
+
+
A three-element prefix or suffix of a finger tree.
+
+
titleCase(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
titleCase(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a title-case character.
+
+
to(Actor<A>) - Method in class fj.control.parallel.Promise
+
+
Promises to send a value to the given actor in the future.
+
+
toArray() - Static method in class fj.data.Collectors
+
 
+
toArray() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element array if this projection has a value, otherwise an empty array.
+
+
toArray() - Method in class fj.data.Either3.LeftProjection
+
 
+
toArray() - Method in class fj.data.Either3.MiddleProjection
+
 
+
toArray() - Method in class fj.data.Either3.RightProjection
+
 
+
toArray() - Method in class fj.data.HashMap
+
 
+
toArray() - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray(Class<A[]>) - Method in class fj.data.List
+
+
Returns a array projection of this list.
+
+
toArray() - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray(Class<A[]>) - Method in class fj.data.Option
+
+
Returns an array projection of this optional value.
+
+
toArray() - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray(Class<A[]>) - Method in class fj.data.Stream
+
+
Returns a array projection of this stream.
+
+
toArray() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element array if this is a failing value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.Validation
+
+
Returns a single element array if this is a success value, otherwise an empty list.
+
+
toArray() - Method in class fj.data.vector.V2
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V3
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V4
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V5
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V6
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V7
+
+
Returns an array with the elements of this vector.
+
+
toArray() - Method in class fj.data.vector.V8
+
+
Returns an array with the elements of this vector.
+
+
toArrayObject() - Method in class fj.data.List
+
 
+
toBoolean(char) - Static method in class fj.data.hamt.BitSet
+
 
+
toBoolean(int) - Static method in class fj.data.hamt.BitSet
+
 
+
toChar - Static variable in enum fj.Digit
+
+
First-class conversion from a digit to a character.
+
+
toChar() - Method in enum fj.Digit
+
+
Converts this digit to a character.
+
+
toCollection() - Method in class fj.data.Array.ImmutableProjection
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Array
+
+
Projects an immutable collection of this array.
+
+
toCollection() - Method in class fj.data.Either.LeftProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.Either.RightProjection
+
+
Projects an immutable collection of this projection.
+
+
toCollection() - Method in class fj.data.Either3.LeftProjection
+
 
+
toCollection() - Method in class fj.data.Either3.MiddleProjection
+
 
+
toCollection() - Method in class fj.data.Either3.RightProjection
+
 
+
toCollection() - Method in class fj.data.HashMap
+
+
Projects an immutable collection of this hash map.
+
+
toCollection() - Method in class fj.data.HashSet
+
+
Projects an immutable collection of this hash set.
+
+
toCollection() - Method in class fj.data.List.Buffer
+
+
Projects an immutable collection of this buffer.
+
+
toCollection() - Method in class fj.data.List
+
+
Projects an immutable collection of this list.
+
+
toCollection() - Method in class fj.data.NonEmptyList
+
+
Projects an immutable collection of this non-empty list.
+
+
toCollection() - Method in class fj.data.Option
+
+
Projects an immutable collection of this optional value.
+
+
toCollection() - Method in class fj.data.Stream
+
+
Projects an immutable collection of this stream.
+
+
toCollection() - Method in class fj.data.Tree
+
+
Projects an immutable collection of this tree.
+
+
toComparator() - Method in class fj.Ord
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node2
+
 
+
toDigit() - Method in class fj.data.fingertrees.Node3
+
 
+
toEffect0() - Method in interface fj.F0
+
 
+
toEffect0() - Method in interface fj.function.Try0
+
 
+
toEffect0() - Method in interface fj.function.TryEffect0
+
 
+
toEither(F0<X>) - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Array
+
+
Returns an either projection of this array; the given argument in Left if empty, + or the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.List
+
+
Returns an either projection of this list; the given argument in Left if empty, or + the first element in Right.
+
+
toEither(F0<X>) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither(X) - Method in class fj.data.Option
+
+
Returns an either projection of this optional value; the given argument in Left if + no value, or the value in Right.
+
+
toEither() - Static method in class fj.data.Option
+
+
A first-class version of the toEither method.
+
+
toEither(F0<X>) - Method in class fj.data.Stream
+
+
Returns an either projection of this stream; the given argument in Left if empty, + or the first element in Right.
+
+
toEither() - Method in class fj.data.Validation
+
+
Returns an either projection of this validation.
+
+
toF() - Method in interface fj.function.Effect1
+
 
+
toF0() - Method in interface fj.function.Effect0
+
 
+
toF0() - Method in interface fj.function.Try0
+
 
+
toF0() - Method in interface fj.function.TryEffect0
+
 
+
toF2() - Method in interface fj.function.Effect2
+
 
+
toForest() - Method in class fj.data.TreeZipper
+
+
Returns the forest containing this location.
+
+
toFunction() - Method in class fj.data.Stream
+
+
Converts this stream to a function of natural numbers.
+
+
toInt(boolean) - Static method in class fj.data.hamt.BitSet
+
 
+
toInt() - Method in enum fj.Ordering
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HNat
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HSucc
+
 
+
toInteger() - Method in class fj.data.hlist.HPre.HZero
+
 
+
toJavaHashSet() - Method in class fj.data.Set
+
+
Returns a java.util.HashSet representation of this set.
+
+
toJavaList() - Method in class fj.data.Array
+
+
Returns a java.util.ArrayList projection of this array.
+
+
toJavaList() - Method in class fj.data.DList
+
+
Converts the DList to a standard java.util.List.
+
+
toJavaList() - Method in class fj.data.HashSet
+
 
+
toJavaList() - Method in class fj.data.List
+
 
+
toJavaList() - Method in class fj.data.Seq
+
+
Converts the sequence to a java.util.List
+
+
toJavaList() - Method in class fj.data.Set
+
+
Returns a java.util.List representation of this set.
+
+
toJavaList() - Method in class fj.data.Stream
+
+
Returns a java.util.List projection of this stream.
+
+
toJavaSet() - Method in class fj.data.HashSet
+
 
+
toJavaSet() - Method in class fj.data.Set
+
+
Returns a java.util.Set representation of this set.
+
+
toJavaTreeSet() - Method in class fj.data.Set
+
+
Returns a java.util.TreeSet representation of this set.
+
+
toList() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a list projection of this array.
+
+
toList() - Method in class fj.data.Array
+
+
Returns a list projection of this array.
+
+
toList() - Static method in class fj.data.Collectors
+
 
+
toList() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element list if this projection has a value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Either3.LeftProjection
+
 
+
toList() - Method in class fj.data.Either3.MiddleProjection
+
 
+
toList() - Method in class fj.data.Either3.RightProjection
+
 
+
toList() - Method in class fj.data.hamt.BitSet
+
 
+
toList(Ord<K>) - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns the list of key-value pairs, ordered by key.
+
+
toList() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a list of key-value pairs.
+
+
toList() - Method in class fj.data.HashMap
+
 
+
toList() - Method in class fj.data.HashSet
+
+
Returns a list projection of this hash set.
+
+
toList() - Method in class fj.data.List.Buffer
+
+
Returns an immutable list projection of this buffer.
+
+
toList() - Method in class fj.data.NonEmptyList
+
+
Returns a List projection of this list.
+
+
toList() - Method in class fj.data.Option
+
+
Returns a list projection of this optional value.
+
+
toList() - Method in class fj.data.PriorityQueue
+
+
Returns a list of products with priority k and value a.
+
+
toList() - Method in class fj.data.Seq
+
+
Converts this sequence to a List
+
+
toList() - Method in class fj.data.Set
+
+
Returns a list representation of this set.
+
+
toList() - Method in class fj.data.Stream
+
+
Returns a list projection of this stream.
+
+
toList() - Method in class fj.data.TreeMap
+
 
+
toList() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element list if this is a failing value, otherwise an empty list.
+
+
toList() - Method in class fj.data.Validation
+
+
Returns a single element list if this is a success value, otherwise an empty list.
+
+
toList_() - Static method in class fj.data.NonEmptyList
+
+
Returns a function that takes a non-empty list to a list.
+
+
toListReverse() - Method in class fj.data.Set
+
+
Returns a list representation of this set in reverse order.
+
+
toListReverse() - Method in class fj.data.TreeMap
+
 
+
toLong - Static variable in enum fj.Digit
+
+
First-class conversion from digit to a long.
+
+
toLong() - Method in enum fj.Digit
+
+
Converts this digit to a long.
+
+
toLowerCase - Static variable in class fj.function.Characters
+
 
+
toMap() - Method in class fj.data.HashMap
+
 
+
toMutableMap() - Method in class fj.data.TreeMap
+
+
A mutable map projection of this tree map.
+
+
toNonEmptyList() - Method in class fj.data.vector.V2
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V3
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V4
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V5
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V6
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V7
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNonEmptyList() - Method in class fj.data.vector.V8
+
+
Returns a nonempty list with the elements of this vector.
+
+
toNull() - Method in class fj.data.Option
+
+
Returns the value from this optional value, or if there is no value, returns null.
+
+
toOption() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns an option projection of this array; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Array
+
+
Returns an option projection of this array; None if empty, or the first element in + Some.
+
+
toOption() - Method in class fj.data.Either.LeftProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.Either.RightProjection
+
+
Returns this projection's value in Some if it exists, otherwise + None.
+
+
toOption() - Method in class fj.data.Either3.LeftProjection
+
 
+
toOption() - Method in class fj.data.Either3.MiddleProjection
+
 
+
toOption() - Method in class fj.data.Either3.RightProjection
+
 
+
toOption() - Method in class fj.data.HashMap
+
 
+
toOption() - Method in class fj.data.Stream
+
+
Returns an option projection of this stream; None if empty, or the first element + in Some.
+
+
toOption() - Method in class fj.data.Validation.FailProjection
+
+
Returns the failing value in Some if there is one, otherwise None.
+
+
toOption() - Method in class fj.data.Validation
+
+
Returns the success value in Some if there is one, otherwise None.
+
+
top() - Method in class fj.data.PriorityQueue
+
+
If the tree is not empty, returns the node with highest priority otherwise returns nothing.
+
+
toP1() - Method in interface fj.F0
+
 
+
toP1() - Method in interface fj.function.Effect0
+
 
+
toP1() - Method in interface fj.function.Try0
+
 
+
toP1() - Method in interface fj.function.TryEffect0
+
 
+
topDequeue() - Method in class fj.data.PriorityQueue
+
+
Returns a tuple of the node with the highest priority and the rest of the priority queue.
+
+
topN() - Method in class fj.data.PriorityQueue
+
+
Returns all the elements of the queue with the highest (same) priority.
+
+
toSafe(IO<A>) - Static method in class fj.data.IOFunctions
+
+
Convert io to a SafeIO, throwing any IOException wrapped inside a RuntimeException
+
+
toSafeValidation(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toStandardList() - Method in class fj.data.IterableW
+
+
Returns a java.util.List implementation for this iterable.
+
+
toStream() - Method in class fj.data.Array.ImmutableProjection
+
+
Returns a stream projection of this array.
+
+
toStream() - Method in class fj.data.Array
+
+
Returns a stream projection of this array.
+
+
toStream() - Static method in class fj.data.Collectors
+
 
+
toStream() - Method in class fj.data.Either.LeftProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream() - Method in class fj.data.Either.RightProjection
+
+
Returns a single element stream if this projection has a value, otherwise an empty stream.
+
+
toStream() - Method in class fj.data.Either3.LeftProjection
+
 
+
toStream() - Method in class fj.data.Either3.MiddleProjection
+
 
+
toStream() - Method in class fj.data.Either3.RightProjection
+
 
+
toStream(A) - Method in class fj.data.Enumerator
+
+
Returns a stream of the values from this enumerator, starting at the given value, counting up.
+
+
toStream(Bounded<A>) - Method in class fj.data.Enumerator
+
+
Returns a stream of the values from this enumerator, + starting at the min of given Bounded, ending at the max, counting up.
+
+
toStream() - Method in class fj.data.fingertrees.Deep
+
 
+
toStream() - Method in class fj.data.fingertrees.Digit
+
 
+
toStream() - Method in class fj.data.fingertrees.Empty
+
 
+
toStream() - Method in class fj.data.fingertrees.FingerTree
+
 
+
toStream() - Method in class fj.data.fingertrees.Four
+
 
+
toStream() - Method in class fj.data.fingertrees.Node
+
 
+
toStream() - Method in class fj.data.fingertrees.Node2
+
 
+
toStream() - Method in class fj.data.fingertrees.Node3
+
 
+
toStream() - Method in class fj.data.fingertrees.One
+
 
+
toStream() - Method in class fj.data.fingertrees.Single
+
 
+
toStream() - Method in class fj.data.fingertrees.Three
+
 
+
toStream() - Method in class fj.data.fingertrees.Two
+
 
+
toStream() - Method in class fj.data.hamt.BitSet
+
+
Returns a stream of boolean where the head is the most significant bit + (the bit with the largest value)
+
+
toStream() - Method in class fj.data.hamt.HashArrayMappedTrie
+
+
Returns a stream of key-value pairs.
+
+
toStream() - Method in class fj.data.hamt.Node
+
 
+
toStream() - Method in class fj.data.HashMap
+
 
+
toStream - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to streams.
+
+
toStream() - Method in class fj.data.LazyString
+
+
Gives a stream representation of this lazy string.
+
+
toStream() - Method in class fj.data.List
+
+
Returns a stream projection of this list.
+
+
toStream() - Method in class fj.data.Option
+
+
Returns a stream projection of this optional value.
+
+
toStream() - Method in class fj.data.PriorityQueue
+
+
Returns a stream of products with priority k and value a.
+
+
toStream() - Method in class fj.data.Seq
+
+
Converts this sequence to a Stream
+
+
toStream() - Method in class fj.data.Set
+
+
Returns a stream representation of this set.
+
+
toStream() - Method in class fj.data.TreeMap
+
 
+
toStream() - Method in class fj.data.Validation.FailProjection
+
+
Returns a single element stream if this is a failing value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.Validation
+
+
Returns a single element stream if this is a success value, otherwise an empty list.
+
+
toStream() - Method in class fj.data.vector.V2
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V3
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V4
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V5
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V6
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V7
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.vector.V8
+
+
Returns a stream of the elements of this vector.
+
+
toStream() - Method in class fj.data.Zipper
+
+
Returns the Stream representation of this zipper.
+
+
toStream_() - Static method in class fj.data.vector.V2
+
+
Returns a function that transforms a vector-2 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V3
+
+
Returns a function that transforms a vector-3 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V4
+
+
Returns a function that transforms a vector-4 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V5
+
+
Returns a function that transforms a vector-5 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V6
+
+
Returns a function that transforms a vector-6 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V7
+
+
Returns a function that transforms a vector-7 to a stream of its elements.
+
+
toStream_() - Static method in class fj.data.vector.V8
+
+
Returns a function that transforms a vector-8 to a stream of its elements.
+
+
toStreamReverse() - Method in class fj.data.Set
+
+
Returns a stream representation of this set in reverse order.
+
+
toStreamReverse() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Array
+
 
+
toString() - Method in class fj.data.Either
+
 
+
toString() - Method in class fj.data.fingertrees.Deep
+
 
+
toString() - Method in class fj.data.fingertrees.Digit
+
 
+
toString() - Method in class fj.data.fingertrees.Empty
+
 
+
toString() - Method in class fj.data.fingertrees.Four
+
 
+
toString() - Method in class fj.data.fingertrees.Node2
+
 
+
toString() - Method in class fj.data.fingertrees.Node3
+
 
+
toString() - Method in class fj.data.fingertrees.One
+
 
+
toString() - Method in class fj.data.fingertrees.Single
+
 
+
toString() - Method in class fj.data.fingertrees.Three
+
 
+
toString() - Method in class fj.data.fingertrees.Two
+
 
+
toString() - Method in class fj.data.hamt.BitSet
+
 
+
toString() - Method in class fj.data.hamt.HashArrayMappedTrie
+
 
+
toString() - Method in class fj.data.hamt.Node
+
 
+
toString - Static variable in class fj.data.LazyString
+
+
First-class conversion from lazy strings to String.
+
+
toString() - Method in class fj.data.LazyString
+
 
+
toString() - Method in class fj.data.List
+
+
Obtain a string representation of this list using the toString implementations of the members.
+
+
toString() - Method in class fj.data.Natural
+
 
+
toString() - Method in class fj.data.NonEmptyList
+
 
+
toString() - Method in class fj.data.Option
+
 
+
toString() - Method in class fj.data.PriorityQueue
+
 
+
toString() - Method in class fj.data.Seq
+
 
+
toString() - Method in class fj.data.Set
+
 
+
toString() - Method in class fj.data.Stream
+
 
+
toString() - Method in class fj.data.Tree
+
 
+
toString() - Method in class fj.data.TreeMap
+
 
+
toString() - Method in class fj.data.Validation
+
 
+
toString - Static variable in class fj.function.Characters
+
 
+
toString() - Method in class fj.P1
+
 
+
toString() - Method in class fj.P2
+
 
+
toString() - Method in class fj.P3
+
 
+
toString() - Method in class fj.P4
+
 
+
toString() - Method in class fj.P5
+
 
+
toString() - Method in class fj.P6
+
 
+
toString() - Method in class fj.P7
+
 
+
toString() - Method in class fj.P8
+
 
+
toString() - Method in class fj.parser.Result
+
 
+
toString() - Method in class fj.Unit
+
 
+
toStringEager() - Method in class fj.data.LazyString
+
+
Returns the String representation of this lazy string.
+
+
toStringEager() - Method in class fj.data.Stream
+
 
+
toStringLazy() - Method in class fj.data.LazyString
+
 
+
toStringLazy() - Method in class fj.data.Stream
+
 
+
toTitleCase - Static variable in class fj.function.Characters
+
 
+
toTree() - Method in class fj.data.fingertrees.Digit
+
+
Returns the tree representation of this digit.
+
+
toTree() - Method in class fj.data.TreeZipper
+
+
Returns the tree containing this location.
+
+
toTry(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
toTry0() - Method in interface fj.F0
+
 
+
toTry0() - Method in interface fj.function.Effect0
+
 
+
toTry0() - Method in interface fj.function.TryEffect0
+
 
+
toTry1() - Method in interface fj.function.Effect1
+
 
+
toTryEffect0() - Method in interface fj.F0
+
 
+
toTryEffect0() - Method in interface fj.function.Effect0
+
 
+
toTryEffect0() - Method in interface fj.function.Try0
+
 
+
toTryEffect1() - Method in interface fj.function.Effect1
+
 
+
toUpperCase - Static variable in class fj.function.Characters
+
 
+
toValidation(X) - Method in class fj.data.Option
+
 
+
toVector() - Method in class fj.data.fingertrees.Node2
+
 
+
toVector() - Method in class fj.data.fingertrees.Node3
+
 
+
toZipper() - Method in class fj.data.IterableW
+
 
+
Trampoline<A> - Class in fj.control
+
+
A Trampoline is a potentially branching computation that can be stepped through and executed in constant stack.
+
+
Trampoline() - Constructor for class fj.control.Trampoline
+
 
+
traversal() - Static method in class fj.data.List.Optic
+
+
Monomorphic traversal
+
+
Traversal<S,A> - Class in fj.data.optic
+
 
+
Traversal(PTraversal<S, S, A, A>) - Constructor for class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F3<A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F4<A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F5<A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F6<A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traversal(F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F<S, A>, F7<A, A, A, A, A, A, S, S>) - Static method in class fj.data.optic.Traversal
+
 
+
traverse(List<A>, F<A, State<S, B>>) - Static method in class fj.data.State
+
+
Map each element of a structure to an action, evaluate these actions from left to right + and collect the results.
+
+
traverseEither(F<A, Either<E, B>>) - Method in class fj.data.List
+
+
Traverse through the List with given function.
+
+
traverseEither(F<A, Either<L, B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output on the right side of an either.
+
+
traverseEither(F<A, Either<L, B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output on the right side of an either.
+
+
traverseEither(F<A, Either<L, B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output on the right side of an either.
+
+
traverseEither(F<A, Either<X, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Either
+
+
traverseEither(F<B, Either<X, C>>) - Method in class fj.P2
+
 
+
traverseEitherLeft(F<A, Either<B, R>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output on the left side of an either.
+
+
traverseEitherLeft(F<A, Either<B, R>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output on the left side of an either.
+
+
traverseEitherLeft(F<A, Either<B, R>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output on the left side of an either.
+
+
traverseEitherLeft(F<A, Either<B, R>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output on the left side of an either.
+
+
traverseEitherLeft(F<T, Either<C, R>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output on the left side of an either.
+
+
traverseEitherRight(F<A, Either<L, B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output on the right side of an either.
+
+
traverseEitherRight(F<A, Either<L, B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output on the right side of an either.
+
+
traverseEitherRight(F<A, Either<L, B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output on the right side of an either.
+
+
traverseEitherRight(F<A, Either<L, B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output on the right side of an either.
+
+
traverseEitherRight(F<T, Either<L, C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output on the right side of an either.
+
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a function.
+
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a function.
+
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a function.
+
+
traverseF(F<A, F<C, B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a function.
+
+
traverseF(F<T, F<C, B>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a function.
+
+
traverseIO(F<A, IO<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Anonymous bind through this projection.
+
+
traverseIO(F<B, IO<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with a function that has IO effect
+
+
traverseIO(F<A, IO<X>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
traverseIO(F<B, IO<X>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
traverseIO(F<C, IO<X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as an IO.
+
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as an IO.
+
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as an IO.
+
+
traverseIO(F<A, IO<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as an IO.
+
+
traverseIO(F<T, IO<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as an IO.
+
+
traverseIO(F<B, IO<C>>) - Method in class fj.P2
+
 
+
traverseIOLeft(F<A, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for IO.
+
+
traverseIORight(F<B, IO<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for IO.
+
+
traverseList(F<A, List<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<B, List<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse with function that produces List (non-determinism).
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a list.
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a list.
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a list.
+
+
traverseList(F<A, List<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a list.
+
+
traverseList(F<T, List<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a list.
+
+
traverseList(F<A, List<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for List
+
+
traverseList(F<B, List<C>>) - Method in class fj.P2
+
 
+
traverseList1(F<A, List<X>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
traverseList1(F<B, List<X>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
traverseList1(F<C, List<X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
traverseListLeft(F<A, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for List.
+
+
traverseListRight(F<B, List<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for List.
+
+
traverseOption(F<A, Option<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseOption(F<B, Option<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse this right with the given function and collect the output as an option.
+
+
traverseOption(F<A, Option<X>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
traverseOption(F<B, Option<X>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
traverseOption(F<C, Option<X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.List
+
+
Traverses through the List with the given function
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as an option.
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Seq
+
+
Traverses through the Seq with the given function
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.data.Stream
+
+
Traverses through the Seq with the given function
+
+
traverseOption(F<T, Option<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as an option.
+
+
traverseOption(F<A, Option<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Option
+
+
traverseOption(F<B, Option<C>>) - Method in class fj.P2
+
 
+
traverseOptionLeft(F<A, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Option.
+
+
traverseOptionRight(F<B, Option<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Option.
+
+
traverseP1(F<A, P1<C>>) - Method in class fj.data.Either.LeftProjection
+
+
Traverse this left with the given function and collect the output as a p1.
+
+
traverseP1(F<B, P1<C>>) - Method in class fj.data.Either.RightProjection
+
+
Traverse this right with the given function and collect the output as a p1.
+
+
traverseP1(F<A, P1<X>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
traverseP1(F<B, P1<X>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
traverseP1(F<C, P1<X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a p1.
+
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a P1.
+
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a p1.
+
+
traverseP1(F<A, P1<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a p1.
+
+
traverseP1(F<T, P1<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a P1.
+
+
traversePromise(F<A, Promise<B>>) - Method in class fj.data.List
+
 
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a seq.
+
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output a seq.
+
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a seq.
+
+
traverseSeq(F<A, Seq<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a seq.
+
+
traverseSeq(F<T, Seq<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a seq.
+
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a set; use the given ord to order the set.
+
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a set; use the given ord to order the set.
+
+
traverseSet() - Method in class fj.data.Option
+
 
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a set; use the given ord to order the set.
+
+
traverseSet(Ord<B>, F<A, Set<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a set; use the given ord to order the set.
+
+
traverseSet(Ord<E>, Ord<C>, F<T, Set<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a set; use the given success and failure value ords to order the set.
+
+
traverseStream(F<A, Stream<C>>) - Method in class fj.data.Either.LeftProjection
+
 
+
traverseStream(F<B, Stream<C>>) - Method in class fj.data.Either.RightProjection
+
 
+
traverseStream(F<A, Stream<X>>) - Method in class fj.data.Either3.LeftProjection
+
 
+
traverseStream(F<B, Stream<X>>) - Method in class fj.data.Either3.MiddleProjection
+
 
+
traverseStream(F<C, Stream<X>>) - Method in class fj.data.Either3.RightProjection
+
 
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a stream.
+
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a stream.
+
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a stream.
+
+
traverseStream(F<A, Stream<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a stream.
+
+
traverseStream(F<T, Stream<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a stream.
+
+
traverseStream(F<A, Stream<B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Stream
+
+
traverseStream(F<B, Stream<C>>) - Method in class fj.P2
+
 
+
traverseStreamLeft(F<A, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of LeftProjection of Either for Stream.
+
+
traverseStreamRight(F<B, Stream<C>>) - Method in class fj.data.Either
+
+
Traversable instance of RightProjection of Either for Stream.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a trampoline.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a trampoline.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a trampoline.
+
+
traverseTrampoline(F<A, Trampoline<B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a trampoline.
+
+
traverseTrampoline(F<T, Trampoline<C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a trampoline.
+
+
traverseV2(F<A, V2<B>>) - Method in class fj.data.List
+
 
+
traverseValidation(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.List
+
+
Traverse this list with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
+
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.data.Option
+
+
Traverse this option with the given function and collect the output as a validation.
+
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a validation.
+
+
traverseValidation(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.Seq
+
+
Traverse this seq with the given function and collect the output as a validation; use the given semigroup to reduce the errors.
+
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a validation.
+
+
traverseValidation(Semigroup<E>, F<A, Validation<E, B>>) - Method in class fj.data.Stream
+
+
Traverse this stream with the given function and collect the output as a validation; use the given semigroup to + reduce the errors.
+
+
traverseValidation(F<T, Validation<E1, C>>) - Method in class fj.data.Validation
+
+
Traverse this validation with the given function and collect the output as a validation.
+
+
traverseValidation(F<A, Validation<E, B>>) - Method in class fj.P1
+
+
Traversable instance of P1 for Validation
+
+
Tree<A> - Class in fj.data
+
+
Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).
+
+
treeEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Tree type.
+
+
treeHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Tree type.
+
+
treeK() - Method in interface fj.F
+
+
Promotes this function to return its value in a Tree.
+
+
treeM() - Method in interface fj.F2
+
+
Promotes this function to a function on Trees.
+
+
TreeMap<K,V> - Class in fj.data
+
+
An immutable, in-memory map, backed by a red-black tree.
+
+
treeMap(Ord<K>, P2<K, V>...) - Static method in class fj.data.TreeMap
+
+
Constructs a tree map from the given elements.
+
+
treeMapEqual(Equal<K>, Equal<V>) - Static method in class fj.Equal
+
 
+
treeMapHash(Hash<K>, Hash<V>) - Static method in class fj.Hash
+
 
+
treeMapShow(Show<K>, Show<V>) - Static method in class fj.Show
+
+
A show instance for the TreeMap type.
+
+
TreeSet_List() - Static method in class fj.data.Java
+
+
A function that converts tree sets to lists.
+
+
treeShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for the Tree type.
+
+
TreeZipper<A> - Class in fj.data
+
+
Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.
+
+
treeZipper(Tree<A>, Stream<Tree<A>>, Stream<Tree<A>>, Stream<P3<Stream<Tree<A>>, A, Stream<Tree<A>>>>) - Static method in class fj.data.TreeZipper
+
+
Creates a new tree zipper given a currently selected tree, a forest on the left, a forest on the right, + and a stream of parent contexts.
+
+
treeZipper() - Static method in class fj.data.TreeZipper
+
+
First-class constructor for tree zippers.
+
+
treeZipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the TreeZipper type.
+
+
treeZipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the TreeZipper type.
+
+
treeZipperK() - Method in interface fj.F
+
+
Promotes this function to return its value in a TreeZipper.
+
+
TRUE_BIT - Static variable in class fj.data.hamt.BitSet
+
 
+
Try - Class in fj
+
 
+
Try0<A,Z extends java.lang.Exception> - Interface in fj.function
+
+
A product of A which may throw an Exception.
+
+
Try1<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function from A to B that may throw an Exception.
+
+
Try2<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-2 from A and B to C that may throw an Exception.
+
+
Try3<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-3 from A, B and C to D that may throw an Exception.
+
+
Try4<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-4 from A, B, C and D to E that may throw an Exception.
+
+
Try5<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-5 from A, B, C, D and E to F that may throw an Exception.
+
+
Try6<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-6 from A, B, C, D, E and F to G that may throw an Exception.
+
+
Try7<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-7 from A, B, C, D, E, F and G to H that may throw an Exception.
+
+
Try8<A,B,C,D,E,F,G,H,I,Z extends java.lang.Exception> - Interface in fj.function
+
+
A transformation function of arity-8 from A, B, C, D, E, F, G and H to I that may throw an Exception.
+
+
Try_F(Try1<A, B, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_F() - Static method in class fj.data.Conversions
+
 
+
Try_IO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_IO() - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO(Try0<A, Z>) - Static method in class fj.data.Conversions
+
 
+
Try_SafeIO() - Static method in class fj.data.Conversions
+
 
+
TryCatch0_Supplier(Try0<A, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch0_Supplier() - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function(Try1<A, B, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch1_Function() - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction(Try2<A, B, C, E>) - Static method in class fj.data.Java8
+
 
+
TryCatch2_BiFunction() - Static method in class fj.data.Java8
+
 
+
TryEffect - Class in fj
+
 
+
TryEffect0<Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect1<A,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect2<A,B,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect3<A,B,C,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect4<A,B,C,D,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect5<A,B,C,D,E,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect6<A,B,C,D,E,F,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect7<A,B,C,D,E,F,G,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect8<A,B,C,D,E,F,G,H,Z extends java.lang.Exception> - Interface in fj.function
+
 
+
TryEffect_P(TryEffect0<E>) - Static method in class fj.data.Conversions
+
 
+
tryNext() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the next element, or throws an error if there are no more elements.
+
+
tryPrevious() - Method in class fj.data.Zipper
+
+
Attempts to move the focus to the previous element, or throws an error if there are no more elements.
+
+
tuple() - Method in interface fj.F2
+
+
Uncurries this function to a function on tuples.
+
+
tuple(F<A, F<B, C>>) - Static method in class fj.P2
+
+
Transforms a curried function of arity-2 to a function of a product-2
+
+
tuple(F2<A, B, C>) - Static method in class fj.P2
+
+
Transforms an uncurried function of arity-2 to a function of a product-2
+
+
two(A, A) - Method in class fj.data.fingertrees.MakeTree
+
+
A digit of two elements.
+
+
Two<V,A> - Class in fj.data.fingertrees
+
+
A two-element prefix or suffix of a finger tree.
+
+
typeParameterTree(Type) - Static method in class fj.Class
+
+
Provides type parameter information as a Tree of the type expression.
+
+
+ + + +

U

+
+
uncons(B, F2<A, FingerTree<V, A>, B>) - Method in class fj.data.fingertrees.FingerTree
+
+
Performs a reduction on this finger tree using the given arguments.
+
+
uncons(F2<A, List<A>, B>, B) - Method in class fj.data.List
+
 
+
uncons(B, F<A, F<P1<Stream<A>>, B>>) - Method in class fj.data.Stream
+
+
Performs a reduction on this stream using the given arguments.
+
+
uncurryF2() - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF2(F<A, F<B, C>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-2.
+
+
uncurryF3() - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF3(F<A, F<B, F<C, D>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-3.
+
+
uncurryF4() - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF4(F<A, F<B, F<C, F<D, E>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-4.
+
+
uncurryF5() - Static method in class fj.Function
+
+
Uncurry a function of arity-5.
+
+
uncurryF5(F<A, F<B, F<C, F<D, F<E, F$>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6() - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF6(F<A, F<B, F<C, F<D, F<E, F<F$, G>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-6.
+
+
uncurryF7() - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF7(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, H>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-7.
+
+
uncurryF8() - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
uncurryF8(F<A, F<B, F<C, F<D, F<E, F<F$, F<G, F<H, I>>>>>>>>) - Static method in class fj.Function
+
+
Uncurry a function of arity-8.
+
+
undefined() - Static method in class fj.Bottom
+
+
Returns an error to represent undefinedness in a computation.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.List
+
+
Unfolds across the given function starting at the given value to produce a list.
+
+
unfold(F<B, Option<P2<A, B>>>, B) - Static method in class fj.data.Stream
+
+
Unfolds across the given function starting at the given value to produce a stream.
+
+
unfoldTree(F<B, P2<A, P1<Stream<B>>>>) - Static method in class fj.data.Tree
+
+
Builds a tree from a seed value.
+
+
unicodeIdentiferPart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferPart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier part character.
+
+
unicodeIdentiferStart(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
unicodeIdentiferStart(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a unicode identifier start character.
+
+
union(Set<A>) - Method in class fj.data.Set
+
+
Add all the elements of the given set to this set.
+
+
union() - Static method in class fj.data.Set
+
+
A first class function for Set.union(Set).
+
+
union(TreeMap<K, V>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
union(Iterable<P2<K, V>>) - Method in class fj.data.TreeMap
+
+
The expression t1.union(t2) takes the left-biased union of t1 + and t2.
+
+
unit(A) - Static method in class fj.control.db.DB
+
+
Constructs a database action that returns the given value completely intact.
+
+
unit(A) - Static method in class fj.data.IOFunctions
+
 
+
unit(F<A, B>) - Static method in class fj.data.Reader
+
 
+
unit(F<S, P2<S, A>>) - Static method in class fj.data.State
+
 
+
unit(A, W, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(A, Monoid<W>) - Static method in class fj.data.Writer
+
 
+
unit(B) - Static method in class fj.data.Writer
+
 
+
Unit - Class in fj
+
+
The unit type which has only one value.
+
+
unit() - Static method in class fj.Unit
+
+
The only value of the unit type.
+
+
unitMonoid - Static variable in class fj.Monoid
+
+
A monoid for the Unit value.
+
+
unitOrd - Static variable in class fj.Ord
+
+
An order instance for the Unit type.
+
+
units(F<S, S>) - Static method in class fj.data.State
+
 
+
unitSemigroup - Static variable in class fj.Semigroup
+
+
A semigroup for the Unit value.
+
+
unless(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
unlines(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by newlines.
+
+
unlines(List<String>) - Static method in class fj.function.Strings
+
 
+
unlines() - Static method in class fj.function.Strings
+
 
+
unlines_() - Static method in class fj.data.LazyString
+
 
+
unlineShow(Show<A>) - Static method in class fj.Show
+
+
A show instance for streams that splits into lines.
+
+
unqueue(B, F2<P2<K, A>, PriorityQueue<K, A>, B>) - Method in class fj.data.PriorityQueue
+
+
Performs a reduction on this priority queue using the given arguments.
+
+
Unsafe() - Constructor for class fj.data.List.Unsafe
+
 
+
untuple(F<P2<A, B>, C>) - Static method in class fj.P2
+
+
Transforms a function of a product-2 to an uncurried function or arity-2.
+
+
unwords(Stream<LazyString>) - Static method in class fj.data.LazyString
+
+
Joins the given stream of lazy strings into one, separated by spaces.
+
+
unzip(Array<P2<A, B>>) - Static method in class fj.data.Array
+
+
Transforms an array of pairs into an array of first components and an array of second components.
+
+
unzip(List<P2<A, B>>) - Static method in class fj.data.List
+
+
Transforms a list of pairs into a list of first components and a list of second components.
+
+
unzip(NonEmptyList<P2<A, B>>) - Static method in class fj.data.NonEmptyList
+
+
Transforms a non empty list of pairs into a non empty list of first components and + a non empty list of second components.
+
+
unzip(Stream<P2<A, B>>) - Static method in class fj.data.Stream
+
+
Transforms a stream of pairs into a stream of first components and a stream of second components.
+
+
update(int, A) - Method in class fj.data.Seq
+
+
Replace the element at the given index with the supplied value.
+
+
update(A, F<A, A>) - Method in class fj.data.Set
+
+
Updates, with the given function, the first element in the set that is equal to the given element, + according to the order.
+
+
update(K, F<V, V>) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it.
+
+
update(K, F<V, V>, V) - Method in class fj.data.TreeMap
+
+
Modifies the value for the given key, if present, by applying the given function to it, or + inserts the given value if the key is not present.
+
+
upper(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
upper(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a upper-case character.
+
+
+ + + +

V

+
+
v() - Method in class fj.data.hlist.HPre.HAnd
+
 
+
v() - Method in class fj.data.hlist.HPre.HCond
+
 
+
v() - Method in class fj.data.hlist.HPre.HEq
+
 
+
v() - Method in class fj.data.hlist.HPre.HOr
+
 
+
V - Class in fj.data.vector
+
+
Functions across vectors.
+
+
v(A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-2.
+
+
v(A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-3.
+
+
v(A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-4.
+
+
v(A, A, A, A, A) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v(P1<A>, P1<A>, P1<A>, F0<A>, F0<A>) - Static method in class fj.data.vector.V
+
+
Puts elements in a vector-5.
+
+
v2() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-2.
+
+
V2<A> - Class in fj.data.vector
+
+
A vector-2.
+
+
v2Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-2.
+
+
v2Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-2.
+
+
v2Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-2.
+
+
v3() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-3.
+
+
V3<A> - Class in fj.data.vector
+
+
A vector-3.
+
+
v3Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-3.
+
+
v3Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-3.
+
+
v3Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-3.
+
+
v4() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-4.
+
+
V4<A> - Class in fj.data.vector
+
+
A vector-4.
+
+
v4Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-4.
+
+
v4Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-4.
+
+
v4Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-4.
+
+
v5() - Static method in class fj.data.vector.V
+
+
Returns a function that puts elements in a vector-5.
+
+
V5<A> - Class in fj.data.vector
+
+
A vector-5.
+
+
v5Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-5.
+
+
v5Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-5.
+
+
v5Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-5.
+
+
V6<A> - Class in fj.data.vector
+
+
A vector-6.
+
+
v6Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-6.
+
+
v6Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-6.
+
+
v6Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-6.
+
+
V7<A> - Class in fj.data.vector
+
+
A vector-7.
+
+
v7Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-7.
+
+
v7Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-7.
+
+
v7Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-7.
+
+
V8<A> - Class in fj.data.vector
+
+
A vector-8.
+
+
v8Equal(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for a vector-8.
+
+
v8Hash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for a vector-8.
+
+
v8Show(Show<A>) - Static method in class fj.Show
+
+
A show instance for a vector-8.
+
+
Validation<E,T> - Class in fj.data
+
+
Isomorphic to Either but has renamed functions and represents failure on the left and success on the right.
+
+
Validation(Either<E, T>) - Constructor for class fj.data.Validation
+
 
+
validation() - Method in class fj.data.Validation.FailProjection
+
+
Returns the underlying validation.
+
+
validation(F<E, X>, F<T, X>) - Method in class fj.data.Validation
+
+
The catamorphism for validation.
+
+
validation(Either<E, T>) - Static method in class fj.data.Validation
+
+
Construct a validation using the given either value.
+
+
validation() - Static method in class fj.data.Validation
+
+
Returns a function that constructs a validation with an either.
+
+
Validation.FailProjection<E,T> - Class in fj.data
+
+
A failing projection of a validation.
+
+
validationEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
+
An equal instance for the Validation type.
+
+
validationHash(Hash<A>, Hash<B>) - Static method in class fj.Hash
+
+
A hash instance for the Validation type.
+
+
validationOrd(Ord<A>, Ord<B>) - Static method in class fj.Ord
+
+
An order instance for the Validation type.
+
+
validationShow(Show<A>, Show<B>) - Static method in class fj.Show
+
+
A show instance for the Validation type.
+
+
value() - Method in class fj.data.Either.LeftProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Either.RightProjection
+
+
The value of this projection or fails with a specialised error message.
+
+
value() - Method in class fj.data.Eval
+
+
Evaluates the computation and return its result.
+
+
value() - Method in class fj.data.fingertrees.One
+
+
Returns the single element in this digit.
+
+
value() - Method in class fj.data.fingertrees.Single
+
+
Returns the single element of this tree.
+
+
value() - Method in class fj.data.Writer
+
 
+
value(A) - Static method in class fj.parser.Parser
+
+
Constructs a parser that always returns the given value.
+
+
value() - Method in class fj.parser.Result
+
+
The parsed value.
+
+
valueE(F0<String>) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(String) - Method in class fj.data.Either.LeftProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(String) - Method in class fj.data.Either.RightProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Either.RightProjection
+
+
Returns the value of this projection or fails with the given error message.
+
+
valueE(F0<String>) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueE(String) - Method in class fj.data.Option
+
+
Returns the value of this optional value or fails with the given message.
+
+
valueOf(String) - Static method in enum fj.Digit
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum fj.Ordering
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Method in class fj.data.fingertrees.Four
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Three
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.fingertrees.Two
+
+
Returns the elements of this digit as a vector.
+
+
values() - Method in class fj.data.HashMap
+
+
Returns all values in this hash map.
+
+
values() - Method in class fj.data.TreeMap
+
+
Returns all values in this tree map.
+
+
values() - Static method in enum fj.Digit
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum fj.Ordering
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
vary(F<? super A, ? extends B>) - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
vary() - Static method in class fj.Function
+
+
Simultaneously covaries and contravaries a function.
+
+
Vector_List() - Static method in class fj.data.Java
+
+
A function that converts vectors to lists.
+
+
Visitor - Class in fj.function
+
+
The essence of the visitor design pattern expressed polymorphically.
+
+
visitor(List<F<A, Option<B>>>, F0<B>, A) - Static method in class fj.function.Visitor
+
+
Returns the first value found in the list of visitors after application of the given value, otherwise returns the + given default.
+
+
Void - Class in fj
+
+
A logically uninhabited data type.
+
+
voided(IO<A>) - Static method in class fj.data.IOFunctions
+
 
+
vzip(V2<A>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V3<A>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V4<A>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V5<A>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V6<A>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V7<A>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
vzip(V8<A>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of vectors.
+
+
+ + + +

W

+
+
weakMemo(F0<A>) - Static method in class fj.P
+
+
Convert a F0 into a P1, using weak call-by-need semantic: + function f is evaluated at first call to P1._1() + and at each subsequent call if and only if the reference have been garbage collected.
+
+
weakMemo() - Method in class fj.P1
+
+
Like memo, but the memoized value is wrapped into a WeakReference
+
+
when(Boolean, IO<Unit>) - Static method in class fj.data.IOFunctions
+
 
+
whitespace(F0<E>, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
whitespace(E, F<Character, E>) - Static method in class fj.parser.Parser.CharsParser
+
+
Returns a parser that produces a white-space character.
+
+
withs(F<S, S>) - Method in class fj.data.State
+
 
+
words() - Method in class fj.data.LazyString
+
+
Splits this lazy string into words by spaces.
+
+
wrap() - Static method in class fj.data.Array
+
+
First-class wrapper function for arrays.
+
+
wrap(Iterable<A>) - Static method in class fj.data.IterableW
+
+
Wraps the given iterable.
+
+
wrap() - Static method in class fj.data.IterableW
+
+
Provides a function that wraps the given iterable.
+
+
writer(String) - Static method in class fj.control.db.DbState
+
+
Creates a database state writer given a connection URL.
+
+
writer(Connector) - Static method in class fj.control.db.DbState
+
+
Returns a new writer that writes the database via the given Connector.
+
+
Writer<W,A> - Class in fj.data
+
 
+
writerEqual(Equal<A>, Equal<B>) - Static method in class fj.Equal
+
 
+
+ + + +

X

+
+
xmap(F<P1<A>, P1<B>>, F<P1<B>, P1<A>>) - Method in class fj.control.parallel.Strategy
+
+
Maps the given bijective transformation across this strategy (Exponential Functor pattern).
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.data.Enumerator
+
+
Invariant functor map over this enumerator.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Monoid
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xmap(F<I, Z>, F<Z, I>) - Method in class fj.parser.Parser
+
+
Maps the parse input type through an invariant functor.
+
+
xmap(F<A, B>, F<B, A>) - Method in class fj.Semigroup
+
+
Maps the given functions across this monoid as an invariant functor.
+
+
xor(BitSet) - Method in class fj.data.hamt.BitSet
+
 
+
xor - Static variable in class fj.function.Booleans
+
+
Curried form of logical xor (nonequivalence).
+
+
xor(F<A, Boolean>, F<A, Boolean>) - Static method in class fj.function.Booleans
+
+
composes the given predicate using exclusive disjunction
+
+
+ + + +

Z

+
+
zapp(Iterable<F<A, B>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable of functions, applying each function in turn to the + corresponding element in this iterable to produce a new iterable.
+
+
zapp(Stream<F<A, B>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream of functions, applying each function in turn to the + corresponding element in this stream to produce a new stream.
+
+
zero() - Method in class fj.data.fingertrees.Measured
+
+
Returns the identity measurement for the monoid.
+
+
ZERO - Static variable in class fj.data.Natural
+
+
The natural number zero
+
+
zero() - Method in class fj.Monoid
+
+
The zero value for this monoid.
+
+
zip(Array<B>) - Method in class fj.data.Array
+
+
Zips this array with the given array to produce an array of pairs.
+
+
zip(Iterable<B>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable to produce a iterable of pairs.
+
+
zip(List<B>) - Method in class fj.data.List
+
+
Zips this list with the given list to produce a list of pairs.
+
+
zip() - Static method in class fj.data.List
+
+
The first-class version of the zip function.
+
+
zip(NonEmptyList<B>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list to produce a list of pairs.
+
+
zip(Stream<B>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream to produce a stream of pairs.
+
+
zip(V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zip(V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector to produce a vector of pairs.
+
+
zipArrayM() - Method in interface fj.F2
+
+
Promotes this function to zip two arrays, applying the function lock-step over both Arrays.
+
+
zipIndex() - Method in class fj.data.Array
+
+
Zips this array with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.IterableW
+
+
Zips this iterable with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.List
+
+
Zips this list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the index of its element as a pair.
+
+
zipIndex() - Method in class fj.data.Stream
+
+
Zips this stream with the index of its element as a pair.
+
+
zipIterableM() - Method in interface fj.F2
+
+
Promotes this function to zip two iterables, applying the function lock-step over both iterables.
+
+
zipListM() - Method in interface fj.F2
+
+
Promotes this function to zip two lists, applying the function lock-step over both lists.
+
+
zipNelM() - Method in interface fj.F2
+
+
Promotes this function to zip two non-empty lists, applying the function lock-step over both lists.
+
+
Zipper<A> - Class in fj.data
+
+
Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus) + position in a stream.
+
+
zipper(Stream<A>, A, Stream<A>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper with the given streams before and after the focus, and the given focused item.
+
+
zipper(P3<Stream<A>, A, Stream<A>>) - Static method in class fj.data.Zipper
+
+
Creates a new Zipper from the given triple.
+
+
zipper() - Static method in class fj.data.Zipper
+
+
First-class constructor of zippers.
+
+
zipperEqual(Equal<A>) - Static method in class fj.Equal
+
+
An equal instance for the Zipper type.
+
+
zipperHash(Hash<A>) - Static method in class fj.Hash
+
+
A hash instance for the Zipper type.
+
+
zipperK() - Method in interface fj.F
+
+
Promotes this function to return its value in a Zipper.
+
+
zipSetM(Ord<C>) - Method in interface fj.F2
+
+
Promotes this function to zip two sets, applying the function lock-step over both sets.
+
+
zipStreamM() - Method in interface fj.F2
+
+
Promotes this function to zip two streams, applying the function lock-step over both streams.
+
+
zipTreeM() - Method in interface fj.F2
+
+
Promotes this function to zip two trees, applying the function lock-step over both trees.
+
+
zipTreeZipperM() - Method in interface fj.F2
+
+
Promotes this function to zip two TreeZippers, applying the function lock-step over both zippers in all directions.
+
+
zipWith(Trampoline<B>, F2<A, B, C>) - Method in class fj.control.Trampoline
+
+
Combines two trampolines so they run cooperatively.
+
+
zipWith(Array<B>, F<A, F<B, C>>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Array<B>, F2<A, B, C>) - Method in class fj.data.Array
+
+
Zips this array with the given array using the given function to produce a new array.
+
+
zipWith(Iterable<B>, F<A, F<B, C>>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(Iterable<B>, F2<A, B, C>) - Method in class fj.data.IterableW
+
+
Zips this iterable with the given iterable using the given function to produce a new iterable.
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.List
+
+
Zips this list with the given list using the given function to produce a new list.
+
+
zipWith() - Static method in class fj.data.List
+
+
Provides a first-class version of zipWith
+
+
zipWith(List<B>, F<A, F<B, C>>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(List<B>, F2<A, B, C>) - Method in class fj.data.NonEmptyList
+
+
Zips this non empty list with the given non empty list using the given function to produce a new list.
+
+
zipWith(Stream<B>, F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(Stream<B>, F2<A, B, C>) - Method in class fj.data.Stream
+
+
Zips this stream with the given stream using the given function to produce a new stream.
+
+
zipWith(F<A, F<B, C>>) - Method in class fj.data.Stream
+
+
Partially-applied version of zipWith.
+
+
zipWith() - Static method in class fj.data.Stream
+
+
A first-class version of the zipWith function.
+
+
zipWith(Tree<B>, F2<A, B, C>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(Tree<B>, F<A, F<B, C>>) - Method in class fj.data.Tree
+
+
Zips this tree with another, using the given function.
+
+
zipWith(TreeZipper<B>, F2<A, B, C>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(TreeZipper<B>, F<A, F<B, C>>) - Method in class fj.data.TreeZipper
+
+
Zips this TreeZipper with another, applying the given function lock-step over both zippers in all directions.
+
+
zipWith(F<A, F<B, C>>, V2<B>) - Method in class fj.data.vector.V2
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V3<B>) - Method in class fj.data.vector.V3
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V4<B>) - Method in class fj.data.vector.V4
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V5<B>) - Method in class fj.data.vector.V5
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V6<B>) - Method in class fj.data.vector.V6
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V7<B>) - Method in class fj.data.vector.V7
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(F<A, F<B, C>>, V8<B>) - Method in class fj.data.vector.V8
+
+
Zips this vector with the given vector using the given function to produce a new vector.
+
+
zipWith(Zipper<B>, F2<A, B, C>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWith(Zipper<B>, F<A, F<B, C>>) - Method in class fj.data.Zipper
+
+
Zips this Zipper with another, applying the given function lock-step over both zippers in both directions.
+
+
zipWithFocus() - Method in class fj.data.TreeZipper
+
+
Zips the nodes in this zipper with a boolean that indicates whether that node has focus.
+
+
zipWithFocus() - Method in class fj.data.Zipper
+
+
Zips the elements of this zipper with a boolean that indicates whether that element has focus.
+
+
zipZipperM() - Method in interface fj.F2
+
+
Promotes this function to zip two zippers, applying the function lock-step over both zippers in both directions.
+
+
+ + + +

_

+
+
_1() - Method in class fj.data.$
+
 
+
_1() - Method in class fj.data.vector.V2
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V3
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V4
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V5
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V6
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V7
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.data.vector.V8
+
+
Returns the first element of this vector.
+
+
_1() - Method in class fj.P1
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P2
+
+
Access the first element of the product.
+
+
_1() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_1() - Method in class fj.P3
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P4
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P5
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P6
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P7
+
+
Access the first element of the product.
+
+
_1() - Method in class fj.P8
+
+
Access the first element of the product.
+
+
_1_() - Method in class fj.P2
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P3
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P4
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P5
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P6
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P7
+
+
Returns the 1-product projection over the first element.
+
+
_1_() - Method in class fj.P8
+
+
Returns the 1-product projection over the first element.
+
+
_1p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _1.
+
+
_2() - Method in class fj.data.vector.V2
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V3
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V4
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V5
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V6
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V7
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.data.vector.V8
+
+
Returns the second element of this vector.
+
+
_2() - Method in class fj.P2
+
+
Access the second element of the product.
+
+
_2() - Static method in class fj.P2.Optic
+
+
Monomorphic lens targeted on _1.
+
+
_2() - Method in class fj.P3
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P4
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P5
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P6
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P7
+
+
Access the second element of the product.
+
+
_2() - Method in class fj.P8
+
+
Access the second element of the product.
+
+
_2_() - Method in class fj.P2
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P3
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P4
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P5
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P6
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P7
+
+
Returns the 1-product projection over the second element.
+
+
_2_() - Method in class fj.P8
+
+
Returns the 1-product projection over the second element.
+
+
_2p() - Static method in class fj.P2.Optic
+
+
Polyomorphic lens targeted on _2.
+
+
_3() - Method in class fj.data.vector.V3
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V4
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V5
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V6
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V7
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.data.vector.V8
+
+
Returns the third element of this vector.
+
+
_3() - Method in class fj.P3
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P4
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P5
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P6
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P7
+
+
Access the third element of the product.
+
+
_3() - Method in class fj.P8
+
+
Access the third element of the product.
+
+
_3_() - Method in class fj.P3
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P4
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P5
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P6
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P7
+
+
Returns the 1-product projection over the third element.
+
+
_3_() - Method in class fj.P8
+
+
Returns the 1-product projection over the third element.
+
+
_4() - Method in class fj.data.vector.V4
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V5
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V6
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V7
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.data.vector.V8
+
+
Returns the fourth element of this vector.
+
+
_4() - Method in class fj.P4
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P5
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P6
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P7
+
+
Access the fourth element of the product.
+
+
_4() - Method in class fj.P8
+
+
Access the fourth element of the product.
+
+
_4_() - Method in class fj.P4
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fourth element.
+
+
_4_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fourth element.
+
+
_5() - Method in class fj.data.vector.V5
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V6
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V7
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.data.vector.V8
+
+
Returns the fifth element of this vector.
+
+
_5() - Method in class fj.P5
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P6
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P7
+
+
Access the fifth element of the product.
+
+
_5() - Method in class fj.P8
+
+
Access the fifth element of the product.
+
+
_5_() - Method in class fj.P5
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P6
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P7
+
+
Returns the 1-product projection over the fifth element.
+
+
_5_() - Method in class fj.P8
+
+
Returns the 1-product projection over the fifth element.
+
+
_6() - Method in class fj.data.vector.V6
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V7
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.data.vector.V8
+
+
Returns the sixth element of this vector.
+
+
_6() - Method in class fj.P6
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P7
+
+
Access the sixth element of the product.
+
+
_6() - Method in class fj.P8
+
+
Access the sixth element of the product.
+
+
_6_() - Method in class fj.P6
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P7
+
+
Returns the 1-product projection over the sixth element.
+
+
_6_() - Method in class fj.P8
+
+
Returns the 1-product projection over the sixth element.
+
+
_7() - Method in class fj.data.vector.V7
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.data.vector.V8
+
+
Returns the seventh element of this vector.
+
+
_7() - Method in class fj.P7
+
+
Access the seventh element of the product.
+
+
_7() - Method in class fj.P8
+
+
Access the seventh element of the product.
+
+
_7_() - Method in class fj.P7
+
+
Returns the 1-product projection over the seventh element.
+
+
_7_() - Method in class fj.P8
+
+
Returns the 1-product projection over the seventh element.
+
+
_8() - Method in class fj.data.vector.V8
+
+
Returns the eighth element of this vector.
+
+
_8() - Method in class fj.P8
+
+
Access the eighth element of the product.
+
+
_8_() - Method in class fj.P8
+
+
Returns the 1-product projection over the eighth element.
+
+
__(B) - Static method in class fj.data.$
+
+
Returns a function that given an argument, returns a function that ignores its argument.
+
+
__1() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the first element of a vector.
+
+
__1() - Static method in class fj.P1
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P2
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P3
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P4
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P5
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P6
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P7
+
+
Returns a function that returns the first element of a product.
+
+
__1() - Static method in class fj.P8
+
+
Returns a function that returns the first element of a product.
+
+
__2() - Static method in class fj.data.vector.V2
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the second element of a vector.
+
+
__2() - Static method in class fj.P2
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P3
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P4
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P5
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P6
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P7
+
+
Returns a function that returns the second element of a product.
+
+
__2() - Static method in class fj.P8
+
+
Returns a function that returns the second element of a product.
+
+
__3() - Static method in class fj.data.vector.V3
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the third element of a vector.
+
+
__3() - Static method in class fj.P3
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P4
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P5
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P6
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P7
+
+
Returns a function that returns the third element of a product.
+
+
__3() - Static method in class fj.P8
+
+
Returns a function that returns the third element of a product.
+
+
__4() - Static method in class fj.data.vector.V4
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fourth element of a vector.
+
+
__4() - Static method in class fj.P4
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P5
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P6
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P7
+
+
Returns a function that returns the fourth element of a product.
+
+
__4() - Static method in class fj.P8
+
+
Returns a function that returns the fourth element of a product.
+
+
__5() - Static method in class fj.data.vector.V5
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the fifth element of a vector.
+
+
__5() - Static method in class fj.P5
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P6
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P7
+
+
Returns a function that returns the fifth element of a product.
+
+
__5() - Static method in class fj.P8
+
+
Returns a function that returns the fifth element of a product.
+
+
__6() - Static method in class fj.data.vector.V6
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the sixth element of a vector.
+
+
__6() - Static method in class fj.P6
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P7
+
+
Returns a function that returns the sixth element of a product.
+
+
__6() - Static method in class fj.P8
+
+
Returns a function that returns the sixth element of a product.
+
+
__7() - Static method in class fj.data.vector.V7
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the seventh element of a vector.
+
+
__7() - Static method in class fj.P7
+
+
Returns a function that returns the seventh element of a product.
+
+
__7() - Static method in class fj.P8
+
+
Returns a function that returns the seventh element of a product.
+
+
__8() - Static method in class fj.data.vector.V8
+
+
A first-class function to get the eighth element of a vector.
+
+
__8() - Static method in class fj.P8
+
+
Returns a function that returns the eighth element of a product.
+
+
+$ A B C D E F G H I J K L M N O P Q R S T U V W X Z _ 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/index.html b/javadoc/5.0/functionaljava/index.html new file mode 100644 index 0000000..4a07084 --- /dev/null +++ b/javadoc/5.0/functionaljava/index.html @@ -0,0 +1,75 @@ + + + + + +core 5.0 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/javadoc/5.0/functionaljava/overview-frame.html b/javadoc/5.0/functionaljava/overview-frame.html new file mode 100644 index 0000000..aa59c91 --- /dev/null +++ b/javadoc/5.0/functionaljava/overview-frame.html @@ -0,0 +1,31 @@ + + + + + +Overview List (core 5.0 API) + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/javadoc/5.0/functionaljava/overview-summary.html b/javadoc/5.0/functionaljava/overview-summary.html new file mode 100644 index 0000000..64d614f --- /dev/null +++ b/javadoc/5.0/functionaljava/overview-summary.html @@ -0,0 +1,204 @@ + + + + + +Overview (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

core 5.0 API

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
fj +
Types that set the premise for the existence of Functional Java.
+
fj.control +
Functional control abstractions.
+
fj.control.db +
Abstractions for JDBC connections.
+
fj.control.parallel +
Parallelization strategies.
+
fj.data +
Common algebraic data types.
+
fj.data.fingertrees +
Provides 2-3 finger trees, a functional representation of persistent sequences supporting access to the ends in + amortized O(1) time.
+
fj.data.hamt 
fj.data.hlist +
Type-safe, extensible, heterogeneous lists
+
fj.data.optic +
Optic data types adapted from the Scala Monocle library + and inspired by the + Haskell Lens library.
+
fj.data.vector +
Fixed-length vectors
+
fj.function +
A prelude of commonly used first-class functions
+
fj.parser +
Parser combinators.
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/overview-tree.html b/javadoc/5.0/functionaljava/overview-tree.html new file mode 100644 index 0000000..302a76d --- /dev/null +++ b/javadoc/5.0/functionaljava/overview-tree.html @@ -0,0 +1,452 @@ + + + + + +Class Hierarchy (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/package-list b/javadoc/5.0/functionaljava/package-list new file mode 100644 index 0000000..1ef325a --- /dev/null +++ b/javadoc/5.0/functionaljava/package-list @@ -0,0 +1,12 @@ +fj +fj.control +fj.control.db +fj.control.parallel +fj.data +fj.data.fingertrees +fj.data.hamt +fj.data.hlist +fj.data.optic +fj.data.vector +fj.function +fj.parser diff --git a/javadoc/5.0/functionaljava/script.js b/javadoc/5.0/functionaljava/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/javadoc/5.0/functionaljava/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/javadoc/5.0/functionaljava/serialized-form.html b/javadoc/5.0/functionaljava/serialized-form.html new file mode 100644 index 0000000..9e83dc0 --- /dev/null +++ b/javadoc/5.0/functionaljava/serialized-form.html @@ -0,0 +1,149 @@ + + + + + +Serialized Form (core 5.0 API) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+
    +
  • +

    Package fj.data

    +
      +
    • + + +

      Class fj.data.Natural extends java.lang.Number implements Serializable

      +
      +
      serialVersionUID:
      +
      -588673650944359682L
      +
      +
        +
      • +

        Serialized Fields

        +
          +
        • +

          value

          +
          java.math.BigInteger value
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/javadoc/5.0/functionaljava/stylesheet.css b/javadoc/5.0/functionaljava/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/javadoc/5.0/functionaljava/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} From 0b930092c776c0cc41ebbe1af99710b07e5b8b09 Mon Sep 17 00:00:00 2001 From: Mark Perry Date: Sat, 26 Feb 2022 13:49:29 +1000 Subject: [PATCH 08/10] Updated manually to add FJ 5 doc --- docs.html | 21 ++++++++++++++++++++- download.html | 7 +++++-- feed.xml | 4 ++-- index.html | 2 +- quickstart.html | 21 +++++++-------------- 5 files changed, 35 insertions(+), 20 deletions(-) diff --git a/docs.html b/docs.html index 385a9bd..9481766 100644 --- a/docs.html +++ b/docs.html @@ -101,6 +101,22 @@

Release Notes

Javadoc

+
+

5.0

+
+ +
+
+
+

4.9

+
+

TODO

+
+

4.8.1

@@ -192,7 +208,10 @@

Others

Building

-

FunctionalJava uses the Retro Lambda project to backport Java 8 lambdas to Java 6 bytecode. This requires access to both JDK 6 and 8. The build system requires the environment variables JAVA6_HOME and JAVA8_HOME to refer to the appropriate directories.

+

FunctionalJava 5.x uses Java 8. Future releases will follow the Java long term support model, the future series 6.x uses Java 11 and 7.x uses Java 17.

+
+
+

The FunctionalJava 4.x series uses the Retro Lambda project to backport Java 8 lambdas to Java 6 bytecode. This requires access to both JDK 6 and 8. The build system requires the environment variables JAVA6_HOME and JAVA8_HOME to refer to the appropriate directories.

Building is done using Gradle. In the root directory run:

diff --git a/download.html b/download.html index 0d78f6d..821af61 100644 --- a/download.html +++ b/download.html @@ -87,11 +87,14 @@

Build System

Release Notes

-

The current stable release of Functional Java is 4.8.1. Release notes for each release are available below:

+

The current stable release of Functional Java is 5.0. Release notes for each release are available below:

    -

  • 4.8 and later

    • +

  • 5.0

    • +

  • 4.9

    • +

  • 4.8.1

    • +

  • 4.8

  • 4.7

  • 4.6

  • 4.5

    • diff --git a/feed.xml b/feed.xml index f127e9e..e526b18 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - 08-Oct-2018 18:24:18 - 08-Oct-2018 18:24:18 + Feb 26, 2022 1:46:08 PM + Feb 26, 2022 1:46:08 PM diff --git a/index.html b/index.html index 42fe10c..0266d88 100644 --- a/index.html +++ b/index.html @@ -74,7 +74,7 @@

    Overview

    Functional Java is an open source library facilitating functional programming in Java. The library implements numerous basic and advanced programming abstractions that assist composition oriented development. Functional Java also serves as a platform for learning functional programming concepts by introducing these concepts using a familiar language.

-

The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck and Functional Java’s Quickcheck module. Functional Java is compiled with Java 8 targeting Java 6 bytecode. The use of lambdas within the project are backported with the Retro Lambda library, supporting Java versions 5 to 8 and beyond.

+

The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck and Functional Java’s Quickcheck module. The latest version, 5.0, is compiled with Java 8 targeting Java 8 bytecode. The 4.x series targets Java 6 bytecode. The future 6.x series and 7.x series target Java 11 and 17 respectively. The use of lambdas within the project for the 4.x releases are backported with the Retro Lambda library.

diff --git a/quickstart.html b/quickstart.html index 530ae88..8b327f0 100644 --- a/quickstart.html +++ b/quickstart.html @@ -67,7 +67,7 @@

Quickstart

-

The latest stable version as at July 2015 is 4.8.1. Here is how to quickly add the library to your project and get started.

+

The latest stable version as at July 2015 is 5.0. Here is how to quickly add the library to your project and get started.

The Functional Java artifact is published to Maven Central using the group org.functionaljava with three published artifacts:

@@ -75,7 +75,6 @@

Quickstart

  • the core library (functionaljava)

    • -

  • Java 8 specific support (functionaljava-java8)

  • Quickcheck property based testing module (functionaljava-quickcheck)

  • Java core helper, a simple functional helper for java.util standard types (functionaljava-java-core)

@@ -90,10 +89,9 @@

Gradle

- 
compile "org.functionaljava:functionaljava:4.8.1"
-compile "org.functionaljava:functionaljava-java8:4.8.1"
-compile "org.functionaljava:functionaljava-quickcheck:4.8.1"
-compile "org.functionaljava:functionaljava-java-core:4.8.1"
+ 
compile "org.functionaljava:functionaljava:5.0"
+compile "org.functionaljava:functionaljava-quickcheck:5.0"
+compile "org.functionaljava:functionaljava-java-core:5.0"
@@ -109,22 +107,17 @@

Maven

<dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava</artifactId>
-    <version>4.8.1</version>
-</dependency>
-<dependency>
-    <groupId>org.functionaljava</groupId>
-    <artifactId>functionaljava-java8</artifactId>
-    <version>4.8.1</version>
+    <version>5.0</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-quickcheck</artifactId>
-    <version>4.8.1</version>
+    <version>5.0</version>
 </dependency>
 <dependency>
     <groupId>org.functionaljava</groupId>
     <artifactId>functionaljava-java-core</artifactId>
-    <version>4.8.1</version>
+    <version>5.0</version>
 </dependency>
From 2a2604dc89be9a8f3d111433e64073b395e5c301 Mon Sep 17 00:00:00 2001 From: Mark Perry Date: Sat, 26 Feb 2022 14:17:56 +1000 Subject: [PATCH 09/10] Reviewed readme --- README.adoc | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index 201297b..349deaa 100644 --- a/README.adoc +++ b/README.adoc @@ -12,14 +12,15 @@ The Functional Java code repository is at https://github.com/functionaljava/func The process for changing or enhancing the site is: * edit the source code in the `gradle` branch -* generate the website -* view the changes on a local server -* publish the generated pages to Github +* clean the build directory, run `gradlew clean` +* generate the website, run `gradlew bake`, the generated files are in `build/jbake` +* view the changes on a local server, run `gradlew appRun`. In a browser, go to `http://localhost:8820/`. ATM, the logo at the top of the index.html page doesn't display. +* publish the generated pages to Github. Copy the files from the `gradle` branch's directory `build/jbake` to the `master` branch's root directory. Commit the files and push. You should see the changes within a few minutes at `http://www.functionaljava.org/`. -The website uses Gradle 2.2.1 to build, generate and publish the site and depends on JBake 2.3.1 The project uses the Gradle wrapper, so it can be run if Gradle is not installed using the `./gradlew` command. Useful gradle targets are: +The website uses Gradle 4.10.2, JBake 2.3.0 and the Gradle plugin `org.jbake.site` version 1.2.0. The project uses the Gradle wrapper, so it can be run if Gradle is not installed using the `./gradlew` command. Useful gradle targets are: -* jbakeClean - Removes all generated files -* jbake - create the website locally -* jbakeServer - run the server to preview the website (accessible from http://localhost:8820) -* publish - commit the website to the master branch to make available publicly accessible on the website +* clean - Removes all generated files +* bake - create the website locally +* appRun - run the server to preview the website (accessible from http://localhost:8820) +* publish - commit the website to the master branch to make available publicly accessible on the website. As of Feb 2022, publishing to Github didn't work. From b54620bc5cd53c31ebb6361c845485919382f82f Mon Sep 17 00:00:00 2001 From: Mark Perry Date: Sat, 26 Feb 2022 14:19:11 +1000 Subject: [PATCH 10/10] Manually generated site --- feed.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/feed.xml b/feed.xml index e526b18..5f10db2 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ Functional programming in Java en - Feb 26, 2022 1:46:08 PM - Feb 26, 2022 1:46:08 PM + Feb 26, 2022 2:18:28 PM + Feb 26, 2022 2:18:28 PM